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

per the spec, the only allowed ranges are [12345]XX #2690

Merged
merged 1 commit into from
Sep 23, 2021

Conversation

karenetheridge
Copy link
Member

@webron webron merged commit 085be94 into OAI:main Sep 23, 2021
@undera
Copy link

undera commented Sep 24, 2021

The schema is broken after this change. The problem is removed closing curly brace. I guess it was not intentional...

@undera
Copy link

undera commented Sep 24, 2021

Specifically, the JSON file of schema is broken. Unfortunately, automated tests don't even check that file to be a valid JSON.

@webron
Copy link
Member

webron commented Sep 24, 2021

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

@karenetheridge karenetheridge deleted the ether/5xx-response-codes branch September 26, 2021 21:12
@jdesrosiers
Copy link
Contributor

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.

@undera
Copy link

undera commented Sep 29, 2021

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 2021-05-20 missing .json suffix also causes some issues to view the spec and use it with other tools...

@jdesrosiers
Copy link
Contributor

where would I find it mentioned?

The spec includes the schema's URI at https://spec.openapis.org/oas/v3.1.0#schema-object.

The OpenAPI Schema Object dialect for this version of the specification is identified by the URI https://spec.openapis.org/oas/3.1/dialect/base (the “OAS dialect schema id”).

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.

The file name of 2021-05-20 missing .json suffix also causes some issues to view the spec and use it with other tools...

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 Content-Type: application/schema+json header, but unfortunately GitHub Pages doesn't support that. You could always save the file you download with the .json suffix if that's important, but maybe I've missed your point.

@undera
Copy link

undera commented Sep 29, 2021

Thanks for the clarification @jdesrosiers

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

Successfully merging this pull request may close these issues.

5 participants