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

OpenAPI 3.1 #5891

Closed
silverwind opened this issue Mar 4, 2020 · 51 comments
Closed

OpenAPI 3.1 #5891

silverwind opened this issue Mar 4, 2020 · 51 comments

Comments

@silverwind
Copy link
Contributor

silverwind commented Mar 4, 2020

While the spec is not final yet, i'd be nice to have some support eventually. It eliminates some inconsistencies between OpenAPI and JSON Schema.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md
https://apisyouwonthate.com/blog/openapi-v3-1-and-json-schema

@n2ygk
Copy link

n2ygk commented Apr 6, 2020

This appears to be the list of what will be in 3.1.0: OAI/OpenAPI-Specification#2025

@lephuongbg
Copy link

lephuongbg commented Jul 17, 2020

3.1 RC has been released. It would be nice if Swagger UI could support it when the final version is out.

@daleione
Copy link

OAS 3.1.0 Released!

@millii19
Copy link

Is this being worked on actively? If so, is there an estimated release date?

@UkonnRa
Copy link

UkonnRa commented Apr 6, 2021

Any update?

@jziggas
Copy link

jziggas commented Jun 17, 2021

Just encountered a blocker with this trying to add request bodies to an HTTP DELETE method while upgrading docs. I had thought this was supported but didn't realize there is a sort of mismatch between OpenAPI versions and what SwaggerUI actually supports!

@gwerbin
Copy link

gwerbin commented Jun 29, 2021

Does this depend on adding 3.1 support to Swagger Parser? swagger-api/swagger-parser#1535

It looks like a lot of downstream projects are depending on 3.1 support from one or both of Swagger Parser and Swagger UI. Maybe it'd be a good idea to engage with some of them?

@saibotsivad
Copy link

I'm willing to put in some effort over the next several weeks to help get the Swagger UI working with 3.1, but I'm not sure how to assist with that.

I don't see any other open issues or pull requests about 3.1, and it looks like there's a major effort with the 4.x release so maybe that work needs to settle first?

@char0n
Copy link
Member

char0n commented Aug 16, 2021

Hi guys,

As mentioned in https://swagger.io/blog/api-design/what%E2%80%99s-ahead-for-swaggerui-v4-and-swaggereditor-v4/, 4.x release is the first step of OAS 3.1 adoption.

@johanneswuerbach
Copy link

Now that v4 has been released, is there any other tracking issue or any support needed?

@matter-it-does
Copy link

eagerly waiting!

@frankkilcommins
Copy link

Topic update: Released a blog post with information and updates regarding our work towards OpenAPI 3.1 across various Swagger projects.

https://swagger.io/blog/swagger-support-for-openapi-3-0-and-openapi-3-1/

@gileswells
Copy link
Contributor

@frankkilcommins could you let us know when there's a branch that's started / has some progress on it so that the community can start throwing our 3.1 specs at it to provide as much testing as possible?

@arukiidou
Copy link

relates

@Ongy
Copy link

Ongy commented Feb 15, 2023

Hey,

thanks for the work so far.
We have/had a disconnect of swagger with a generator for our object's json.schema.
The new 4.16 alpha allows to import those schema files now!

Missing feature: Right now the object description renderer cannot handle patternProperties yet. same for the example generator.
If it's easier, I'd appreciate one that just maps the ".*" pattern to the previous additionalProperties since that's what we do currently to make the generated files work in swagger.

@opqdonut
Copy link

Looks like the support won't be out until version 5. I just tried v5.0.0-alpha.0 and it worked with OpenAPI 3.1.0!

@frankkilcommins
Copy link

@frankkilcommins could you let us know when there's a branch that's started / has some progress on it so that the community can start throwing our 3.1 specs at it to provide as much testing as possible?

SwaggerUI@5.0.0-alpha.0 has just been released and incorporated into the new release of Swagger Editor swagger-editor@5.0.0-alpha.51.
https://editor-next.swagger.io/ - It's still experimental but feel free to play and send feedback

@jeremyfiel
Copy link

@Ongy patternProperties is not a supported keyword in OAS 3.0.x.

@PatchRanger
Copy link

PatchRanger commented Mar 28, 2023

Thanks for the excellent work on implementing Open Api 3.1 support.
I tried to switch my schemas to 3.1 - and I see a problem with resolving $ref: paths in $ref are being resolved using smartbear.com as the host.
It's rather weird because I don't see smartbear.com in the swagger-ui code - I can't figure out where it then gets such a value as a host?
I tried to override this behavior by all means (including setting servers at the root of swagger.yaml, as well as by packing all $ref into components/schemas) - it didn't help.
Please fix determination of host when resolving $ref.

@char0n
Copy link
Member

char0n commented Mar 28, 2023

@PatchRanger thanks for the report. I've created #8525 to track it, let's discuss it futher there.

@char0n
Copy link
Member

char0n commented Jun 11, 2023

SwaggerUI@5.0.0-beta.0 has just been released!

@char0n
Copy link
Member

char0n commented Jun 12, 2023

Closed by https://github.com/swagger-api/swagger-ui/releases/tag/v5.0.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.