search

domaindrivendev / Swashbuckle.AspNetCore

Swagger tools for documenting API's built on ASP.NET Core
MIT License
5.26k stars 1.32k forks source link

Plans on official support for OpenApi 3.1.0 #2349

Open Danielku15 opened 2 years ago

Danielku15 commented 2 years ago

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

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

It is on our roadmap https://github.com/microsoft/OpenAPI.NET/issues/795

szymczakk commented 8 months ago

Hi! Any news on this? As https://github.com/microsoft/OpenAPI.NET/issues/795 is closed.

jnv commented 8 months ago

@szymczakk Wait for preview release? https://github.com/microsoft/OpenAPI.NET/issues/795#issuecomment-1994528711

szymczakk commented 8 months ago

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

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

thanks :)

github-actions[bot] commented 6 months ago

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[bot] commented 4 months ago

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.

vindberg commented 3 months ago

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

martincostello commented 3 months ago

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

John-Paul-R commented 2 months ago

For anyone as confused as I:

Despite https://github.com/microsoft/OpenAPI.NET/issues/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).

elrolito commented 1 week ago

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

maulik13 commented 1 week ago

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