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

feat: upgrade to OpenAPI 3.1.0 #2

Open
adriangb opened this issue Jan 18, 2022 · 2 comments
Open

feat: upgrade to OpenAPI 3.1.0 #2

adriangb opened this issue Jan 18, 2022 · 2 comments

Comments

@adriangb
Copy link
Owner

adriangb commented Jan 18, 2022

This will have to wait for swagger-api/swagger-ui#5891

@sm-Fifteen
Copy link

Changing the default docs UI to something like Stoplight Elements, which has supported OpenAPI 3.1 for some time now, could also be an option.

@adriangb
Copy link
Owner Author

adriangb commented Feb 3, 2022

Hmm yeah interesting idea, I had never heard of them, I'll take a look. We could also support ReDoc (for unrelated reasons).

My hope is that in the next ~6 months the whole ecosystem (not just Swagger UI, also Pydantic and such) will move to OpenAPI 3.1 & JSON Schema 2020-12. According to this article, these versions will be sort of "long term support" versions. Since it is kinda hard to support multiple versions of these things, I think it makes sense to wait until those versions are stable and then lock into those in Xpresso.

Once we have that, we should be able to easily support multiple UIs, or rather have one out of the box and make it easy to plug in more.

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

No branches or pull requests

2 participants