{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://docs.caracal.run/schemas/caracal-gateway-upstream-manifest-2026-05-21.schema.json",
  "title": "Caracal Gateway-Compatible Upstream Manifest",
  "description": "Declarative compatibility metadata for an upstream intended to run behind the Caracal Gateway.",
  "type": "object",
  "required": ["schema_version", "name", "version", "resource_identifier", "protocols", "auth_modes", "scopes", "audit"],
  "properties": {
    "schema_version": {
      "const": "2026-05-21"
    },
    "name": {
      "type": "string",
      "minLength": 1
    },
    "version": {
      "type": "string",
      "minLength": 1
    },
    "resource_identifier": {
      "type": "string",
      "minLength": 1
    },
    "protocols": {
      "type": "array",
      "items": {
        "enum": ["http/1.1", "http/2", "mcp-over-http"]
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "auth_modes": {
      "type": "array",
      "items": {
        "enum": ["caracal_jwt", "provider_oauth", "provider_apikey"]
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "identity_forwarding": {
      "enum": ["forbidden", "optional_trusted_upstream", "required_trusted_upstream"]
    },
    "required_headers": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "uniqueItems": true
    },
    "health": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string"
        },
        "success_status": {
          "type": "integer",
          "minimum": 100,
          "maximum": 599
        }
      },
      "additionalProperties": false
    },
    "audit": {
      "type": "object",
      "required": ["action_result_required"],
      "properties": {
        "action_result_required": {
          "type": "boolean"
        },
        "metadata_fields": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "uniqueItems": true
        }
      },
      "additionalProperties": false
    },
    "conformance": {
      "type": "object",
      "properties": {
        "fixture_url": {
          "type": "string",
          "format": "uri"
        },
        "tested_with_caracal": {
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}