Skip to content

Invalid Json in OpenAPI-Specification/schemas/v3.1/schema.json #2723

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

Closed
seriousme opened this issue Sep 24, 2021 · 9 comments
Closed

Invalid Json in OpenAPI-Specification/schemas/v3.1/schema.json #2723

seriousme opened this issue Sep 24, 2021 · 9 comments

Comments

@seriousme
Copy link
Contributor

Hi,

my Github action to check for new OAS versions detected invalid JSON at:

"patternProperties": {
"^[1-5](?:[0-9]{2}|XX)$":
"$ref": "#/$defs/response-or-reference"
}
},

Kind regards,
Hans

@tmartin-git
Copy link

Maybe missing a '{'
=> Should be:
"^[1-5](?:[0-9]{2}|XX)$": {

@seriousme
Copy link
Contributor Author

seriousme commented Sep 24, 2021

Looks like it.

Issue seems to be introduced by #2706 which seems to have been merged despite a failing test:
https://github.com/OAI/OpenAPI-Specification/runs/3690229683

Kind regards,
Hans

@seriousme
Copy link
Contributor Author

Fixed, thx!

@jdesrosiers
Copy link
Contributor

@seriousme You caught us in the middle of a multi-step process of releasing a new version of the schema. I suggest changing your Github Action so it looks for new versions (from the website)[https://github.com/OAI/OpenAPI-Specification/tree/gh-pages/oas/3.1/schema] instead. When we release a new version of the schema, this is where they get published. What's in the repo can sometimes be incomplete because we don't release a new version for every PR that we get.

@seriousme
Copy link
Contributor Author

Clear !

Few questions though:
a) does this mean that the pre-3.1 schemes never change again ? (They don't seem to be present on the gh-pages branch.)
b) what happens if post-3.1 schemes emerge ? (e.g. will the oas/3.1 folder disappear ?)

Kind regards,
Hans

@jdesrosiers
Copy link
Contributor

This is a new process that I introduced for v3.1, so that's why you don't see any 3.0 schemas published there yet. This next release will have a v3.0 update and I will be publishing that to the website. I don't plan to add older releases to website, but I can if people ask for it. The bottom line is that going forward, all schema updates will be published to the website. Once a version is published, it will not be removed. Hope that was clear.

@seriousme
Copy link
Contributor Author

Thanks for the explanation!
Having the old versions available on the website would be nice as tools (like mine ;-)) still support the 2.0 and 3.0 version.
One "official" place to look for these versions (e.g. referred to in the FAQ) would be nice, I picked them up from master but I just learned that is your WIP branch ;-)

@seriousme
Copy link
Contributor Author

Btw: ideally there would be an API(;-)) to check for new versions.

@jdesrosiers
Copy link
Contributor

The process could certainly use some improvements, but with all volunteer work, you often end up with a minimal viable solution rather than an ideal solution 😞.

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

3 participants