-
Notifications
You must be signed in to change notification settings - Fork 43
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
JSON Schema 2020-12 definition for Arazzo descriptions #224
JSON Schema 2020-12 definition for Arazzo descriptions #224
Conversation
1411f86
to
e27f1d4
Compare
@jeremyfiel thanks for the initiative here. There is already a draft PR #198 from @LasneF for #176. Can I encourage you both to work together and consolidate under a single PR for review? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feedback that apply globaly :
- should we endforce Id syntax knowing that it is just a recommendation
- shoud we enforce array to have at least one element vs the syntax [] that is good as well as explicit
03dec65
to
73fe72f
Compare
73fe72f
to
59bf19f
Compare
59bf19f
to
beef671
Compare
0073bca
to
1649b39
Compare
1649b39
to
637ebdc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - Thanks @jeremyfiel
@jeremyfiel could you add a |
In the OAS repo, I believe they use yaml as the base schema and there is a JSON version generated during the build. Is that something Arazzo repo will replicate? If not, I can a JSON version too. |
I think it's manually maintained - see example: https://github.com/OAI/OpenAPI-Specification/commits/main/schemas/v3.0/schema.json There's a job that generates JSON examples for YAML examples, but I don't see similar for schemas. |
637ebdc
to
cd889b6
Compare
applied feedback 2024/08/02 applied feedback 2024/08/04 constrain `inputs` to JSON Schema 2020-12 metaschema closes OAI#176 Co-authored-by: handrews <[email protected]> Co-authored-by: Jason Desrosiers <[email protected]>
cd889b6
to
aeccc98
Compare
@frankkilcommins we definitely only take PRs on the YAML schemas. The schema publishing process is completely broken, though. See OAI/OpenAPI-Specification#3715. It's been broken for years but there's never been anyone with both the time and ability to fix it. In theory we'll fix it after the patch releases ship but idk who's going to do the work on it. |
@handrews in the interest of simplicity we'll mandate changes on both the JSON and YAML schemas for now.....and time permitting we'll just require one and generate the other. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the work!
closes #176
There are four pending issues related to finalizing this draft
#223
#222
#221
#220