-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
per the spec, the only allowed ranges are [12345]XX #2690
Conversation
The schema is broken after this change. The problem is removed closing curly brace. I guess it was not intentional... |
Specifically, the JSON file of schema is broken. Unfortunately, automated tests don't even check that file to be a valid JSON. |
@undera - thanks for pointing that out. Ideally the process is to update the YAML version and automatically convert it to JSON, which just not quite there yet. @karenetheridge, @jdesrosiers - would you mind taking a look? |
Unfortunately, you caught us in the middle of a multi-step process of merging several PRs and updating the version for a new release #2718. This would have been caught in the next steps that include generating the JSON from the YAML and running tests to ensure everything still works. A better process would help, but people shouldn't be using this as the source of truth. They should be using what is published on the website instead: (repo: https://github.com/OAI/OpenAPI-Specification/tree/gh-pages/oas/3.1/schema, URI: https://spec.openapis.org/oas/3.1/schema/2021-05-20). These are the officially released versions of the schema. |
For the URLs @jdesrosiers have mentioned, especially URI variant, where would I find it mentioned? I looked through https://spec.openapis.org/oas/v3.1.0 and there's no mention of official JSONSchema of OAS. The file name of |
The spec includes the schema's URI at https://spec.openapis.org/oas/v3.1.0#schema-object.
It's not made clear where to find that schema, but I think it's reasonable to assume that you can download the schema from that URI. The latest schema should be downloadable from that URI. We should definitely add that, but we also want people to be able to pin to a specific version if they need to using the URI that includes the release date. Thanks for bringing this up.
This isn't really provided for viewing. It's provided to be plugged into a JSON Schema validation library. If you want to view or modify the schema, you'd probably prefer the yaml version on the main branch. This is just the place where the finished product is deployed. It doesn't have a file extension because then the URI would have a file extension and that's bad form for URIs. It should respond with a |
Thanks for the clarification @jdesrosiers |
https://spec.openapis.org/oas/v3.1.0#patterned-fields-0