open-api icon indicating copy to clipboard operation
open-api copied to clipboard

[express-openapi] OpenAPI 3.0 - JSONSchema has been released

Open intelliot opened this issue 6 years ago • 9 comments

The README currently states:

OpenAPI 3.0 (beta until the official JSONSchema is released https://github.com/OAI/OpenAPI-Specification/issues/1301)

The schema is now available: https://github.com/OAI/OpenAPI-Specification/tree/master/schemas/v3.0

Linked from: https://github.com/OAI/OpenAPI-Specification/issues/1032#issuecomment-492410088

intelliot avatar May 15 '19 21:05 intelliot

good catch! open to anyone opening a pr to update the schema and the documentation

jsdevel avatar May 16 '19 00:05 jsdevel

@jsdevel What's the status on this update? Thanks

MikeyUchiha avatar Jul 20 '19 19:07 MikeyUchiha

@jsdevel What's the status on this update? Thanks

Same as it was in May @MikeyUchiha. We're open to anyone who'd like to submit a PR to update the schema and the documentation.

jsdevel avatar Jul 22 '19 16:07 jsdevel

@jsdevel can you give me some more details on how to "update the schema"? What schema are you referring to? The link above takes you to schema.json but there's nothing like that in this repo.

jameskhedley avatar Jul 23 '19 13:07 jameskhedley

https://github.com/kogosoftwarellc/open-api/tree/master/packages/openapi-schema-validator

jsdevel avatar Jul 23 '19 16:07 jsdevel

it's likely not as simple as just replacing the json schema file though... we've been basing everything on the schema in that schema validator project i linked to.

jsdevel avatar Jul 23 '19 16:07 jsdevel

openapi-framework uses that schema validator package: https://github.com/kogosoftwarellc/open-api/blob/master/packages/openapi-framework/index.ts

and then every other package assumes the incoming config etc. is all based on the existing v3 schema.

i'm fine proceeding though with the official schema, but it'll likely be a major version bump, and will halt development on the existing schema. not the biggest deal but worth mentioning... we should use the official schema.

jsdevel avatar Jul 23 '19 16:07 jsdevel

You should be able to bump the schema without a major, we did it for https://github.com/stoplightio/spectral and nothing exploded.

philsturgeon avatar Sep 03 '19 13:09 philsturgeon

Any news on this?

Also, to clarify, what does "beta" mean? If I were to use a 3.0 schema today using express-openapi, what would happen?

NathanHazout avatar May 05 '20 12:05 NathanHazout