We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Given an API definition that includes the following user schema in components
"components": { "schemas": { "user": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } }
The above user schema must be referencable by "$ref": "#/components/schemas/user" like in the response definition below:
"$ref": "#/components/schemas/user"
"responses": { "200": { "description": "The response", "schema": { "$ref": "#/components/schemas/user" } } }
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?
The text was updated successfully, but these errors were encountered:
Any progress on this issue?
Sorry, something went wrong.
@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.
There is a new module out that can not only validate your API definition but also resolve references. It's called oad
resolve
line-o
No branches or pull requests
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?
The text was updated successfully, but these errors were encountered: