Initial commit of schema definition for invalid updates. #1083
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
michaelkedar
reviewed
Mar 7, 2023
docs/invalid_update.schema.json
Outdated
Comment on lines
32
to
39
| "reason": { | ||
| "type": "string", | ||
| "title": "The reason Schema", | ||
| "examples": [ | ||
| "INVALID_JSON", | ||
| "DELETED" | ||
| ] | ||
| } |
There was a problem hiding this comment.
Should this have an enum field for the valid reasons?
If so, we could probably remove the examples.
There was a problem hiding this comment.
Oooh good call, I didn't realise you could do that.
docs/invalid_update.schema.json
Outdated
Comment on lines
14
to
15
| "default": [], | ||
| "title": "The invalid_records Schema", |
There was a problem hiding this comment.
nit: most of these titles don't really seem useful, and I don't think they're a required field.
There was a problem hiding this comment.
I've improved on them.
docs/invalid_update.schema.json
Outdated
| "title": "The invalid_records Schema", | ||
| "items": { | ||
| "type": "object", | ||
| "title": "A Schema", |
There was a problem hiding this comment.
This title is particularly unhelpful :)
There was a problem hiding this comment.
Ah yes, yes it is. Improved.
Defer to the consolidated examples putting everything together.
* Use better titles * Specify the supported reasons as an enum
oliverchang
approved these changes
Mar 14, 2023
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 is my first foray into writing a JSON schema, and I've basically done it using https://www.jsonschema.net/app/schemas/231529 so let me know if you see any issues with it (including things like
$id)Contributes to #771