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

schema updates for 3.1.1 #4122

Closed
karenetheridge opened this issue Oct 3, 2024 · 5 comments
Closed

schema updates for 3.1.1 #4122

karenetheridge opened this issue Oct 3, 2024 · 5 comments
Assignees
Labels
Milestone

Comments

@karenetheridge
Copy link
Member

The 3.1.1 schemas need a review pass for accuracy.

At a minimum, all the $comment keywords need to be updated as currently they point to v3.1.0 URIs.

@karenetheridge karenetheridge added this to the v3.1.1 milestone Oct 3, 2024
@karenetheridge karenetheridge self-assigned this Oct 3, 2024
@karenetheridge
Copy link
Member Author

karenetheridge commented Oct 3, 2024

  • update $comment, description and $id URIs for v3.1.0->v3.1.1 (where can an html preview of the specification be viewed?)
  • ensure links in specification (referencing schema files) are correct
  • compare specification and schema diffs from 3.1.0 and 3.1.1, thinking about any spec changes that haven't yet been reflected in the schemas, and what changes have been made to the schemas already and confirm they are accurate (this SHOULD be a no-op, but mistakes have occasionally happened before ;) )
  • ensure the .json and .yaml files are consistent
  • verify validity against the draft2020-12 json metaschema
    (apt-get libjson-schema-modern-perl; json-schema-eval --strict --validate-schema schemas/v3.1/schema.json; json-schema-eval --strict --validate-schema schemas/v3.1/schema-base.json)

@handrews handrews added the Schema label Oct 4, 2024
@handrews
Copy link
Member

handrews commented Oct 4, 2024

There are definitely improvements to be made to the 3.1 schemas, but there aren't any schema-impacting differences between 3.1.0 and 3.1.1. The only version-ish thing that should change is the date in the $id of the schemas. Even if it seems like there might be 3.1.0 vs 3.1.1 differences, anything that applies to 3.1.1 also applies to 3.1.0. All comments or other text in the schema should only mention 3.1 (no patch release number) regardless of the date in the $id.

Schemas can be viewed on the spec site.

@handrews
Copy link
Member

handrews commented Oct 9, 2024

Also, the 3.1 schemas that don't have dates in their $ids need to be given dates when updated.

@karenetheridge
Copy link
Member Author

Note that the PR coming from this issue will be a blocker for 3.1.1. I have some of the more trivial fixes completed already, so please poke me if I should PR those now.

@handrews
Copy link
Member

@karenetheridge same question about why it will be a blocker here as for 3.0.4.

@karenetheridge karenetheridge closed this as not planned Won't fix, can't repro, duplicate, stale Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants