Add $schema to JSON for better VSCode support#49
Merged
MattIPv4 merged 3 commits intobotblock:masterfrom Aug 21, 2022
A5rocks:reference_schemas
Merged
Add $schema to JSON for better VSCode support#49MattIPv4 merged 3 commits intobotblock:masterfrom A5rocks:reference_schemas
MattIPv4 merged 3 commits intobotblock:masterfrom
A5rocks:reference_schemas
Conversation
Member
|
👀 Does this require a small API change first to drop the |
Contributor
Author
|
It could do that (and I would be fine adding that) but really clients shouldn't care about the extra key. |
Member
|
Clients probably wouldn't care about the extra key, but it would mean that the API schemas would be incorrect as the extra key would be present in the responses. I also don't think it makes much sense to be returning this key in the API responses as it's a relative path that wouldn't point to anywhere useful relative to the API. |
Contributor
Author
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
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.
I'm not completely sure adding
$schemais fine, as this changes two (or more, because I may be missing spots) external things:$schemawhen you get a list's info$schemaID to the invalid list ID../schema/legacy.jsonfor stats posting due to how legacy mapping works -- but this is probably fine since the user could have just provided that URL anyways and$schemais an invalid list ID.