Open line-o opened 2 years ago
Any progress on this issue?
@cwittern this is the number one item on our backlog (see https://github.com/orgs/eeditiones/projects/2). When time allows this is the first thing to work on.
There is however a possibility to preprocess an API definition with refs see https://faq.teipublisher.com/api/designingopenapi/
The steps in short are
npm install -g swagger-cli
swagger-cli bundle --dereference -o api-with-inlined-references.json api-with-references.json
Thanks, yes, that's an easy way out.
Given an API definition that includes the following user schema in components
The above user schema must be referencable by
"$ref": "#/components/schemas/user"
like in the response definition below:Components spec: https://oai.github.io/Documentation/specification-components.html
At least, following objects must be supported, as they tend to greatly reduce the size of the definition JSON
Due to their nature of being used very frequently, these should also be included:
The full list of objects that can be referenced can be found here https://spec.openapis.org/oas/v3.1.0#components-object
Do we want to allow refs from other or even external documents?