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

Please add OpenAPI 3.1 supports #1181

Closed
andrejs-sinkevics opened this issue Jun 7, 2021 · 5 comments
Closed

Please add OpenAPI 3.1 supports #1181

andrejs-sinkevics opened this issue Jun 7, 2021 · 5 comments
Labels
enhancement New feature or request

Comments

@andrejs-sinkevics
Copy link

Please add OpenAPI 3.1 supports
OpenAPI Specification

@bnasslahsen
Copy link
Contributor

@andrejs-sinkevics,

springdoc-openapi is buit on top of the swagger-core library.
There is an ongoing request about the support of OpenaAPI 3.1.

Once this is done, the support will be updated in the springdoc-openapi.

@linarkou
Copy link

Hey, v2.2.0 of swagger-core with OAS 3.1.0 support was released! Looking forward to updates 🙂

@bnasslahsen bnasslahsen reopened this Apr 23, 2022
@bnasslahsen bnasslahsen added the enhancement New feature or request label Apr 23, 2022
@bnasslahsen
Copy link
Contributor

bnasslahsen commented Apr 23, 2022

@linarkou,

The initial support for OAS 3.1.0 is now added.
To use this support, you need to declare the following property:

springdoc.api-docs.version=openapi_3_1

Note that the swagger-ui support is not yet available.
We will wait for this ticket to be completed.

@okohub
Copy link

okohub commented Aug 24, 2022

@bnasslahsen Do we need to wait extra things to have "requestBody" in GET-HEAD-DELETE?

@bnasslahsen
Copy link
Contributor

bnasslahsen commented Aug 24, 2022

@okohub,

Please stop writing same messages in many tickets...
As answered in #1003, You need a version of OpenAPI that supports that which is not the case.

The recommendation is the avoid this kind of representation and we will stick on that:
In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible.

The extra thing, is that you can use OpenApiCustomiser that can help you achieve this goal.

@springdoc springdoc locked as resolved and limited conversation to collaborators Aug 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants