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

proposal: upgrade openapi definitions to 3.1 #213

Open
toumorokoshi opened this issue Aug 23, 2024 · 1 comment
Open

proposal: upgrade openapi definitions to 3.1 #213

toumorokoshi opened this issue Aug 23, 2024 · 1 comment

Comments

@toumorokoshi
Copy link
Member

Today, all of aep.dev uses openapi 3.0 definitions.

Given the nascence of the project and our decision to control our own toolchains, we have some freedom to update the OAS version and not pay a painful migration in the future.

OpenAPI 3.1 has advantages, like allowing the usage of JsonSchema as a standard for resource descriptions. If we can upgrade to OAS 3.1 - we should.

The OpenAPI generator is also adding support for 3.1 as well: https://github.com/OpenAPITools/openapi-generator

@earth2marsh
Copy link
Contributor

Even though 3.1 does not have strong uptake yet, I think there is a case to be made for picking 3.1, especially because it seems to me that AEPs are more about building new services in an API design-first approach (rather than upgrading legacy services).

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