error-envelope

Generated reference page for spec/v1/schemas/errors/error-envelope.json.

Metadata

• Type: JSON Schema
• Source: spec/v1/schemas/errors/error-envelope.json
• Raw: View Raw

Summary

• Schema ID: https://agent-service.spec/v1/schemas/errors/error-envelope.json
• Defs: 0
• Properties: 4
• Required: 3

Source

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/errors/error-envelope.json",
  "type": "object",
  "additionalProperties": false,
  "required": ["code", "message", "error"],
  "properties": {
    "code": {
      "type": "integer",
      "minimum": 1
    },
    "message": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "error": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name", "message"],
      "properties": {
        "name": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        }
      }
    }
  }
}