84 lines
2.3 KiB
JSON
84 lines
2.3 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "https://swagger-cli.dev/robot-schema/v1/error.schema.json",
|
|
"title": "Robot Error Response",
|
|
"description": "Envelope for all error robot-mode responses from swagger-cli. Written to stderr.",
|
|
"type": "object",
|
|
"required": ["ok", "error", "meta"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean",
|
|
"const": false
|
|
},
|
|
"error": {
|
|
"$ref": "#/$defs/error"
|
|
},
|
|
"meta": {
|
|
"$ref": "#/$defs/meta"
|
|
}
|
|
},
|
|
"$defs": {
|
|
"error": {
|
|
"type": "object",
|
|
"required": ["code", "message"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"description": "Machine-readable error code.",
|
|
"enum": [
|
|
"USAGE_ERROR",
|
|
"NETWORK_ERROR",
|
|
"INVALID_SPEC",
|
|
"ALIAS_EXISTS",
|
|
"AUTH_ERROR",
|
|
"ALIAS_NOT_FOUND",
|
|
"CACHE_LOCKED",
|
|
"CACHE_ERROR",
|
|
"CONFIG_ERROR",
|
|
"IO_ERROR",
|
|
"JSON_ERROR",
|
|
"CACHE_INTEGRITY",
|
|
"OFFLINE_MODE",
|
|
"POLICY_BLOCKED"
|
|
]
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"description": "Human-readable error description."
|
|
},
|
|
"suggestion": {
|
|
"type": "string",
|
|
"description": "Optional actionable suggestion for resolving the error."
|
|
}
|
|
}
|
|
},
|
|
"meta": {
|
|
"type": "object",
|
|
"required": ["schema_version", "tool_version", "command", "duration_ms"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"schema_version": {
|
|
"type": "integer",
|
|
"const": 1,
|
|
"description": "Robot envelope schema version. Always 1 for v1."
|
|
},
|
|
"tool_version": {
|
|
"type": "string",
|
|
"description": "SemVer version of swagger-cli that produced this output."
|
|
},
|
|
"command": {
|
|
"type": "string",
|
|
"description": "Name of the command that was executed."
|
|
},
|
|
"duration_ms": {
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"description": "Wall-clock execution time in milliseconds."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|