Add ReSpec auto-generator from OAS files. #233
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
msporny
requested review from
mkhraisha,
OR13 and
peacekeeper
as code owners
OR13
approved these changes
Sep 20, 2021
There was a problem hiding this comment.
very cool, and very useful.
We've been doing something very similar in https://github.com/w3c-ccg/traceability-vocab, and recently resolved to update to using OAS instead of JSON Schema, because we wanted to avoid potential issues.... this is another good reason for that switch.
msporny
force-pushed
the
msporny-oas-respec
branch
from
df1fb62 to
597657d
Compare
|
open for 9 days without objection, merging. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds an ability to ReSpec to generate sections of the specification directly from the OAS files. This ensures that the root of truth continues to be the OAS files, but that those are also translated into human-readable normative ReSpec descriptions.
This is the first iteration of this experimental feature. There is still a lot of formatting that needs to be done with the JSON Schema sections to ReSpec text, but that is fairly straight-forward to do and will just take a bit of time to get formatted into the shape that we want.
You can preview what all of this looks like here: https://pr-preview.s3.amazonaws.com/w3c-ccg/vc-http-api/pull/233.html#the-vc-http-api
Preview | Diff