Skip to content
New issue

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

OpenAPI 3.1.0 support: add support for rendering OpenAPI.jsonSchemaDialect field #8491

Closed
char0n opened this issue Mar 20, 2023 · 3 comments
Closed

Comments

@char0n
Copy link
Member

char0n commented Mar 20, 2023

We can render OpenAPI.jsonSchemaDialect value as part of Info component. We can also display a warning if OpenAPI.jsonSchemaDialect is defined and it's value is different from https://spec.openapis.org/oas/3.1/dialect/base. When this is the case, ApiDOM will not handle the structures as JSON Schema Objects.

@char0n
Copy link
Member Author

char0n commented Mar 20, 2023

We will render the field if author defined it and we want to display warning if the field has value different than the default one. We want to mention that author should either remove the field or provide the field with the value that equals to default.

@char0n
Copy link
Member Author

char0n commented Mar 21, 2023

OpenAPI.jsonSchemaDialect renders in the following way in Info section when the field is explicitly defined and contains the default value of https://spec.openapis.org/oas/3.1/dialect/base:

image

@char0n
Copy link
Member Author

char0n commented Mar 21, 2023

If the OpenAPI.jsonSchemaDialect field is explicitly defined and contains value that is different from https://spec.openapis.org/oas/3.1/dialect/base, SwaggerUI will render the following:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant