Support OAS3.1 ? - Githubissues

swaggest / openapi-go

OpenAPI structures for Go

https://pkg.go.dev/github.com/swaggest/openapi-go/openapi3

MIT License

259 stars 23 forks source link

Support OAS3.1 ? #37

Closed deBarrosS closed 1 year ago

deBarrosS commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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

vearutop commented 2 years ago

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

daveshanley commented 1 year ago

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

vearutop commented 1 year ago

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.