is there a path definition for metadata and service document? about odata-openapi HOT 5 CLOSED

Hi Sam,

No, it doesn’t. We assumed that only OData-aware clients would use the service document and metadata document, and these clients wouldn’t be interested in the OpenAPI document as it contains less information than $metadata.

Do you have situations where OpenAPI clients would be interested in the service or metadata document?

Thanks in advance
Ralf

from odata-openapi.

Hi @ralfhandl, in our use case, we publish the API's on Azure API Management, which will refuse any operation that is not currently defined on the interface. If we try to utilize any of the api's on a SAPUI5/UI5 frontend, those could require the $metadata operation, as the frontend could utilize it on startup.

from odata-openapi.

refuse any operation that is not currently defined on the interface

Well, then you've got a problem: the OpenAPI files are intentionally incomplete and only show the most prominent paths, they don't attempt to show all possible paths - given that OData's path syntax is recursive and based on the service's resource model, showing all possible paths is unreasonable.

The containment example shows a potentially endless recursion, and you can reach the contained folders only via their - potentially unlimited - chain of parent folders:

The generated OpenAPI file stops after five levels:

Would Azure API Management allow to go deeper because paths for level 15 start with a documented prefix, or would it prevent accessing anything below level 5?

from odata-openapi.

Yep, it's a current a limitation from Azure API Management in general, but so far we haven't had to go deeper than a few levels.

from odata-openapi.

Recursion - API Management doesn't support definitions defined recursively (for example, schemas referring to themselves).

So this will be problematic:

Seems like you will have to design your services carefully to match the limitations of your API Management solution, and you'll have to tweak the OpenAPI files or fork this generator to suit its specific needs.

from odata-openapi.