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

JSON Schema 2020-12 definition for Arazzo descriptions #224

Merged

Conversation

jeremyfiel
Copy link

@jeremyfiel jeremyfiel commented Jul 30, 2024

closes #176

There are four pending issues related to finalizing this draft
#223
#222
#221
#220

@jeremyfiel jeremyfiel force-pushed the feat/add-json-schema-definition branch from 1411f86 to e27f1d4 Compare July 31, 2024 04:31
@frankkilcommins
Copy link
Collaborator

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

schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
Copy link
Member

@LasneF LasneF left a 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

@jeremyfiel jeremyfiel force-pushed the feat/add-json-schema-definition branch 4 times, most recently from 03dec65 to 73fe72f Compare August 1, 2024 03:47
@jeremyfiel jeremyfiel force-pushed the feat/add-json-schema-definition branch from 73fe72f to 59bf19f Compare August 1, 2024 14:01
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
@jeremyfiel jeremyfiel force-pushed the feat/add-json-schema-definition branch from 59bf19f to beef671 Compare August 2, 2024 22:44
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
schemas/v1.0/schema.yaml Outdated Show resolved Hide resolved
@jeremyfiel jeremyfiel requested review from frankkilcommins, LasneF, notEthan and DmitryAnansky and removed request for LasneF August 9, 2024 14:22
@jeremyfiel jeremyfiel changed the base branch from main to v1.0.0-dev August 14, 2024 16:48
Copy link
Collaborator

@frankkilcommins frankkilcommins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Thanks @jeremyfiel

@frankkilcommins
Copy link
Collaborator

@jeremyfiel could you add a schema.json as part of this too?

@jeremyfiel
Copy link
Author

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.

@frankkilcommins
Copy link
Collaborator

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.

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]>
@jeremyfiel jeremyfiel force-pushed the feat/add-json-schema-definition branch from cd889b6 to aeccc98 Compare August 26, 2024 16:02
@handrews
Copy link
Member

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

@frankkilcommins
Copy link
Collaborator

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

Copy link
Collaborator

@ndenny ndenny left a 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!

@frankkilcommins frankkilcommins merged commit 2d6d9e1 into OAI:v1.0.0-dev Aug 28, 2024
1 check passed
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.

JSON Schema for the specification
7 participants