feat: add schema describedby links and $schema property #31
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
Codecov Report
@@ Coverage Diff @@
## main #31 +/- ##
==========================================
+ Coverage 85.71% 85.87% +0.16%
==========================================
Files 24 24
Lines 1799 1869 +70
==========================================
+ Hits 1542 1605 +63
- Misses 181 186 +5
- Partials 76 78 +2
Continue to review full report at Codecov.
|
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 a
describedbyHTTP link relation to each response that links to JSON Schema file that lives outside the OpenAPI. Also adds a$schemaproperty which is supported by many editors to do completion and validation as you type (VSCode, Sublime via Schema Validator, vim via coc-json, etc). See the README updates for more details.This change accomplishes two things: