Initial commit of schema definition for invalid updates. #1083
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| { | ||
| "$schema": "https://json-schema.org/draft/2019-09/schema", | ||
| "$id": "http://osv.dev/import_status.schema.json", | ||
| "type": "object", | ||
| "default": {}, | ||
| "title": "OSV.dev import status", | ||
| "description": "A schema for describing an OSV.dev import failure of an OSV record.", | ||
| "required": [ | ||
| "invalid_records" | ||
| ], | ||
| "properties": { | ||
| "invalid_records": { | ||
| "type": "array", | ||
| "default": [], | ||
| "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. |
||
| "required": [ | ||
| "id", | ||
| "reason" | ||
| ], | ||
| "properties": { | ||
| "id": { | ||
| "type": "string", | ||
| "title": "The id Schema", | ||
| "examples": [ | ||
| "GSD-2021-1001229", | ||
| "GSD-2022-1003535" | ||
| ] | ||
| }, | ||
| "reason": { | ||
| "type": "string", | ||
| "title": "The reason Schema", | ||
| "examples": [ | ||
| "INVALID_JSON", | ||
| "DELETED" | ||
| ] | ||
| } | ||
|
There was a problem hiding this comment. Should this have an 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. |
||
| }, | ||
| "examples": [{ | ||
| "id": "GSD-2021-1001229", | ||
| "reason": "INVALID_JSON" | ||
| }, | ||
| { | ||
| "id": "GSD-2022-1003535", | ||
| "reason": "DELETED" | ||
| }] | ||
| }, | ||
| "examples": [ | ||
| [{ | ||
| "id": "GSD-2021-1001229", | ||
| "reason": "INVALID_JSON" | ||
| }, | ||
| { | ||
| "id": "GSD-2022-1003535", | ||
| "reason": "DELETED" | ||
| }] | ||
| ] | ||
| } | ||
| }, | ||
| "examples": [{ | ||
| "invalid_records": [{ | ||
| "id": "GSD-2021-1001229", | ||
| "reason": "INVALID_JSON" | ||
| }, | ||
| { | ||
| "id": "GSD-2022-1003535", | ||
| "reason": "DELETED" | ||
| }] | ||
| }] | ||
andrewpollock marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've improved on them.