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

Support OAS3.1 ? #37

Closed
deBarrosS opened this issue Jun 7, 2022 · 5 comments · Fixed by #76
Closed

Support OAS3.1 ? #37

deBarrosS opened this issue Jun 7, 2022 · 5 comments · Fixed by #76

Comments

@deBarrosS
Copy link

deBarrosS commented Jun 7, 2022

As described in this article by the OpenAPI Initiative , there are a few changes from OAS3.0 to OAS3.1.
I might be wrong but it seems that the majority of them should not be that hard to implement.

  • Example -> Examples
  • Nullable -> type list containing null as element
  • GET and HEAD requests payloads allowed. (Still need to implement the ForceRequestBody() function)
  • File Upload Payload descriptions

Is there any intention of handling these changes soon (or at all)?

@vearutop
Copy link
Member

vearutop commented Jun 7, 2022

Main challenge of 3.1 upgrade is to support latest JSON schema as definition language. OpenAPI entities in this library are automatically generated and generator tool also needs an upgrade to latest JSON schema.

This whole epic is definitely on my list, but I'm not sure when I will have capacity to work through it.

@deBarrosS
Copy link
Author

I'm not 100% sure whether I'll be able to work through it now either, but would any contribution be appreciated?

@vearutop
Copy link
Member

vearutop commented Jun 7, 2022

Contributions are welcome of course, but I think on-boarding might be quite complicated (due to dependency on code generation from original schema).

@daveshanley
Copy link

If anyone is interested, https://github.com/pb33f/libopenapi has support for OAS3.1

@vearutop
Copy link
Member

vearutop commented Dec 2, 2022

If anyone is interested, https://github.com/pb33f/libopenapi has support for OAS3.1

Cool project, the support here is also on the way: https://github.com/swaggest/openapi-go/tree/openapi31.

Just one thing to note is that using OpenAPI 3.1 now might be a little inconvenient due to lack of support even in "standard" tooling (to my knowledge, Swagger UI does not support OpenAPI 3.1 yet), not to mention 3rd party tools.

But we need to get there anyways.

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

Successfully merging a pull request may close this issue.

3 participants