feat: add support for draft-04 (06, 2019 and 2020 included) json schemas while supporting draft-07 #1006
Conversation
This file contains 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
Davidonium
commented
Dec 26, 2024
Davidonium
commented
Dec 26, 2024
Davidonium
commented
Dec 26, 2024
| @@ -67,6 +67,50 @@ describe('YAML Schema Service', () => { | |||
| expect(schema.schema.type).eqls('array'); | |||
| }); | |||
|
|
|||
| it('should handle schemas that use draft-04', async () => { | |||
| const content = `openapi: "3.0.0" | |||
There was a problem hiding this comment.
I specifically wanted to test an openapi v3.0.0 schema because that's what is not working in my IDE.
Davidonium
commented
Dec 26, 2024
Comment on lines
+103
to
+107
| service.registerCustomSchemaProvider(() => { | ||
| return new Promise<string | string[]>((resolve) => { | ||
| resolve('http://fakeschema.faketld'); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
I came up with this to enforce the retrieval of the schema. Not sure if this is the best, feel free to suggest better ways.
Davidonium
commented
Dec 26, 2024
| @@ -0,0 +1,1662 @@ | |||
| { | |||
There was a problem hiding this comment.
Maybe having the entire openapi v3.0.0 spec is a bit too much. Let me know if you want me to just use a simple one that uses draft-04.
I used this because it's the use case I wanted to cover (and I think supporting openapi v3.0.0 is very important as there are tools that are unable to upgrade to 3.1).
Davidonium
changed the title
…s a string instead of parsed json
4 tasks
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.
What does this PR do?
Adds support for draft-04, draft-06, draft-2019-09 and draft-2020-12 json schemas. I first started adding support for draft-04 but some of the changes actually make the code validate the schemas more strictly so I felt the need to add the rest of the drafts. I am not entirely sure of the implications of adding the other drafts which are more complex so I would need some help there testing.
The use of avj-draft-04 is documented here: https://ajv.js.org/json-schema.html#draft-04 so it should not be deprecated or out of support.
According to https://ajv.js.org/api.html#ajv-validateschema-schema-object-boolean using that method should be preferred but I am not sure of the consequences of it.
Citing to avoid having to click there:
What issues does this PR fix or reference?
Is it tested? How?
I added a unit test but I would like to test it in my IDE. I have no idea how to do that so help is more than welcome.