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

Automate creating the OAS 3.0.x compliance schema #2

Closed
handrews opened this issue Apr 25, 2023 · 1 comment
Closed

Automate creating the OAS 3.0.x compliance schema #2

handrews opened this issue Apr 25, 2023 · 1 comment
Assignees

Comments

@handrews
Copy link
Member

  • use alterschema to convert the OAS 3.0 schema to draft 2020-12
  • possibly use a JSON Patch to fix oddities (e.g. we don't need "^\$ref$" as a patternProperty, we can just make "$ref" a property)
  • use a JSON Patch document to add all custom keywords (and update the $id)
  • if necessary, have a meta-schema with the custom vocabularies and patch $schema accordingly

Also: need to take into account that OAS 3.1's schema is across multiple files, but does not need alterschema migration. It may make sense to factor out a common JSON Patch file, so document the possibility in case adding 3.1 support does not fit into the timeframe.

@handrews handrews self-assigned this Apr 25, 2023
@handrews
Copy link
Member Author

Completed as of commit d8c268a4798c9cf3ec77968fc088ec2c4521a934.

OAS 3.1 and multi-file schema support deferred to #6. See also #5.

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

1 participant