Skip to content

Instantly share code, notes, and snippets.

@chuwy
Created March 18, 2019 13:20
Show Gist options
  • Save chuwy/f03247b2c399d134d428aa81863bdfc4 to your computer and use it in GitHub Desktop.
Save chuwy/f03247b2c399d134d428aa81863bdfc4 to your computer and use it in GitHub Desktop.
Iglu Client error format
{
"anyOf": [
{
"description": "Resolution error - schema could not be found on specified repositories, defined by ResolutionError ADT in Iglu Client",
"properties": {
"repositories": {
"description": "Defined by LookupHistory ADT in Iglu Client",
"properties": {
"name": {
"type": "string",
"description": "Name of repostitory as written in resolver.json"
},
"errors": {
"type": "array",
"description": "Set of unique errors happened for for repository (probably we still should constrain the size)"
},
"attempts": {
"type": "integer",
"minimum": 0,
"description": "Amount of attempts"
}
}
}
}
},
{
"description": "Validation error - schema was found, but data is invalid or schema itself is invalid",
"anyOf": [
{
"description": "Schema is invalid and cannot be used to validate an instance",
"type": "array",
"minItems": 1,
"items": {
"properties": {
"path": {
"type": "string",
"description": "JSON Path to an issue in resolved JSON Schema"
},
"message": {
"type": "string",
"description": "Human-readable message describing schema problem"
}
}
}
},
{
"description": "Invalid data. Schema was resolved and proven to be valid, but instance is not valid against it. The error comes from a validator",
"type": "array",
"minItems": 1,
"items": {
"properties": {
"message": {
"type": "string",
"description": "Human-readable message describing a data problem"
},
"path": {
"type": "string",
"description": "JSON Path to an issue in data"
},
"keyword": {
"type": "string",
"description": "JSON Schema keyword that invalidated this instance"
},
"targets": {
"type": "string",
"description": "Violating value"
}
}
}
}
]
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment