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.0 petstore fixture #98

Open
char0n opened this issue Nov 9, 2022 · 8 comments
Open

OpenAPI 3.1.0 petstore fixture #98

char0n opened this issue Nov 9, 2022 · 8 comments

Comments

@char0n
Copy link

char0n commented Nov 9, 2022

Hi,

I've noticed that OpenAPI 3.1.0 spec has various examples of usage: https://github.com/OAI/OpenAPI-Specification/tree/main/examples/v3.1

I was wondering if we can introduce OpenAPI 3.1.0 Petstore example that will be derived from OpenAPI 3.0.0 Petstore example and will demonstrate the main differences between 3.x.y and 3.1.0.

The motivation is to have some OpenAPI 3.1.0 complex example that people can look into or use it as default fixture in various tooling.

@darrelmiller
Copy link
Member

That sounds like a great idea.

@char0n
Copy link
Author

char0n commented Dec 1, 2022

I'll issue a first draft PR to push this forward

@dret
Copy link
Contributor

dret commented May 11, 2023

I was just hunting for an up-to-date petstore and was very surprised to find no such thing. It may not be the best example to highlight the differences, but it's just the classic example!

@MikeRalphson
Copy link
Member

@dret @char0n my only slight concern here is, does the Petstore API itself expose anything which would make a v3.1 definition different to a v3.0 one? I can think of maybe exclusiveMinimum and exclusiveMaximum changes if they are present, but there are likely no webhooks or other features of JSON Schema 2020-12 needed...

@petkostas
Copy link

Do you happen to have any updates on this one, by chance? 3.1.x was rolled out some time ago and did introduce changes. It would be of value to have an updated example. Let us know if we can contribute here.

@lornajane
Copy link
Collaborator

We could alternatively adopt a different example for 3.1 since those exist. Unless we specifically want to stick with the petstore.

@lornajane
Copy link
Collaborator

Related: #89

@handrews
Copy link
Member

We are moving these examples to the learn.openapis.org site, so I am going to transfer this issue so it's easier to see what issues are for the separate examples like these and what are for the examples embedded in the spec. See this issue for the decision:

@handrews handrews transferred this issue from OAI/OpenAPI-Specification May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants