learn.openapis.org icon indicating copy to clipboard operation
learn.openapis.org copied to clipboard

OpenAPI 3.1.0 petstore fixture

Open char0n opened this issue 3 years ago • 8 comments

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.

char0n avatar Nov 09 '22 13:11 char0n

That sounds like a great idea.

darrelmiller avatar Nov 24 '22 00:11 darrelmiller

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

char0n avatar Dec 01 '22 13:12 char0n

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!

dret avatar May 11 '23 12:05 dret

@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...

MikeRalphson avatar May 12 '23 11:05 MikeRalphson

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.

petkostas avatar Nov 16 '23 20:11 petkostas

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

lornajane avatar Nov 22 '23 08:11 lornajane

Related: https://github.com/OAI/learn.openapis.org/issues/89

lornajane avatar Apr 09 '24 10:04 lornajane

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:

  • OAI/OpenAPI-Specification#3854

handrews avatar May 30 '24 22:05 handrews