Post by adamyoung600 on Jan 4, 2022 16:06:20 GMT
Hi,
I'm currently working on a Redfish compliant API for our Network Manager product. We are using standard redfish resources and extending them through the OEM property. We've used the provided DMTF tools on github to generated the json and openapi docs from our CSDL. My questions are around the openapi docs.
1) How are we supposed to advertise our custom oem extensions objects from the base openapi.yaml file? It will have responses that reference the core types (NetworkAdapter in our case) but the NetworkAdapter schema file will not reference our custom oem extension even though it will be part of the response. What's the intended workflow for a client to go from the openapi.yaml file to get to the oem extension?
2) If we would like to host the openapi schema files on the server itself and not statically from a website, is there a standard convention as to which URL we should host them under? I know that the main openapi doc should be under /redfish/v1/openapi.yaml but what about all the supporting docs for the objects referenced in that file?
Thanks.
I'm currently working on a Redfish compliant API for our Network Manager product. We are using standard redfish resources and extending them through the OEM property. We've used the provided DMTF tools on github to generated the json and openapi docs from our CSDL. My questions are around the openapi docs.
1) How are we supposed to advertise our custom oem extensions objects from the base openapi.yaml file? It will have responses that reference the core types (NetworkAdapter in our case) but the NetworkAdapter schema file will not reference our custom oem extension even though it will be part of the response. What's the intended workflow for a client to go from the openapi.yaml file to get to the oem extension?
2) If we would like to host the openapi schema files on the server itself and not statically from a website, is there a standard convention as to which URL we should host them under? I know that the main openapi doc should be under /redfish/v1/openapi.yaml but what about all the supporting docs for the objects referenced in that file?
Thanks.
