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

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

Open
intelliot opened this issue May 15, 2019 · 9 comments
Open

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

intelliot opened this issue May 15, 2019 · 9 comments

Comments

@intelliot
Copy link

The README currently states:

OpenAPI 3.0 (beta until the official JSONSchema is released OAI/OpenAPI-Specification#1301)

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

Linked from:
OAI/OpenAPI-Specification#1032 (comment)

@intelliot intelliot changed the title OpenAPI 3.0 JSONSchema has been released [express-openapi] OpenAPI 3.0 - JSONSchema has been released May 15, 2019
@jsdevel
Copy link
Contributor

jsdevel commented May 16, 2019

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

@MikeyUchiha
Copy link

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

@jsdevel
Copy link
Contributor

jsdevel commented Jul 22, 2019

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

@jameskhedley
Copy link

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

@jsdevel
Copy link
Contributor

jsdevel commented Jul 23, 2019

@jsdevel
Copy link
Contributor

jsdevel commented Jul 23, 2019

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
Copy link
Contributor

jsdevel commented Jul 23, 2019

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.

@philsturgeon
Copy link

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

@NathanHazout
Copy link

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?

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

6 participants