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

Plans on official support for OpenApi 3.1.0 #2349

Open
Danielku15 opened this issue Feb 21, 2022 · 13 comments
Open

Plans on official support for OpenApi 3.1.0 #2349

Danielku15 opened this issue Feb 21, 2022 · 13 comments
Labels
help-wanted A change up for grabs for contributions from the community version-major A change suitable for release in a major version
Milestone

Comments

@Danielku15
Copy link

Unfortunately it is a bit hard to search for "3.1" or "3.1.0" in GitHub so I hope I'm not raising a duplicate here.

I was wondering what the plans on officially adding support for OpenApi 3.1.0 are?
https://github.com/OAI/OpenAPI-Specification/releases/tag/3.1.0

I'm not aware of all the exact changes but as of today Swashbuckle always generates version "3.0.1" schema and there seems no way to change this (value is hard-coded in SerializeAsV3). In our case it leads to some validation errors in the schema as we are using request bodies in DELETE operations, this was not allowed in "3.0.1" but the restriction was lifted in "3.1.0" because the HTTP RFC allows it.

@Eneuman
Copy link
Contributor

Eneuman commented Mar 5, 2022

Since swagger is dependant on MS openAPI.Net project, I think we need to wait for it to first support the 3.1.0 spec, but I can be wrong here.

@darrelmiller
Copy link

It is on our roadmap microsoft/OpenAPI.NET#795

@szymczakk
Copy link

Hi! Any news on this? As microsoft/OpenAPI.NET#795 is closed.

@jnv
Copy link

jnv commented Mar 19, 2024

@szymczakk Wait for preview release? microsoft/OpenAPI.NET#795 (comment)

@szymczakk
Copy link

@szymczakk Wait for preview release? microsoft/OpenAPI.NET#795 (comment)

Sorry, just saw the status that is closed, haven’t read the comments.

thanks :)

Copy link
Contributor

This issue is stale because it has been open for 60 days with no activity. It will be automatically closed in 14 days if no further updates are made.

@github-actions github-actions bot added the stale Stale issues or pull requests label May 19, 2024
@martincostello martincostello removed the stale Stale issues or pull requests label May 19, 2024
Copy link
Contributor

This issue is stale because it has been open for 60 days with no activity. It will be automatically closed in 14 days if no further updates are made.

@github-actions github-actions bot added the stale Stale issues or pull requests label Jul 20, 2024
@martincostello martincostello removed the stale Stale issues or pull requests label Jul 20, 2024
@vindberg
Copy link

vindberg commented Aug 1, 2024

When will this be supported? Any workarounds until this is solved?

@martincostello
Copy link
Collaborator

We can only look into supporting it when Microsoft.OpenApi supports it.

@John-Paul-R
Copy link

For anyone as confused as I:

Despite microsoft/OpenAPI.NET#795 ("Add OpenAPI 3.1 Support") being closed, the release it is slated to go out in, OpenAPI.NET:2.0 is currently still in progress (delayed from its original slated release date).

@martincostello martincostello added help-wanted A change up for grabs for contributions from the community version-major A change suitable for release in a major version labels Sep 30, 2024
@martincostello martincostello added this to the Future milestone Sep 30, 2024
@elrolito
Copy link

Looks like the preview release with 3.1.0 support is out now...

@maulik13
Copy link

I am really looking forward to this. It only took 2.5+ years for MS to support 3.1 specs.

@martincostello
Copy link
Collaborator

I'm having an initial early look at what changes would be needed to use Microsoft.OpenApi 2.x to support OpenAPI 3.1, and it's likely to be quite a big breaking change for Swashbuckle to adopt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help-wanted A change up for grabs for contributions from the community version-major A change suitable for release in a major version
Projects
None yet
Development

No branches or pull requests

10 participants