ApiIndex

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/argus-town/json-schema/argus-town-api-index-schema.json",
  "title": "ApiIndex",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/argus-town-openapi.json#/components/schemas/ApiIndex",
  "type": "object",
  "required": [
    "object",
    "version",
    "status",
    "links",
    "authentication",
    "first_call",
    "next_steps"
  ],
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "api"
      ]
    },
    "version": {
      "type": "string",
      "enum": [
        "v1"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "ok"
      ]
    },
    "links": {
      "type": "object",
      "required": [
        "documentation",
        "openapi",
        "errors",
        "providers",
        "mcp"
      ],
      "properties": {
        "documentation": {
          "type": "string"
        },
        "openapi": {
          "type": "string"
        },
        "errors": {
          "type": "string"
        },
        "providers": {
          "type": "string"
        },
        "mcp": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "authentication": {
      "type": "object",
      "required": [
        "scheme",
        "key_type",
        "create_key_url"
      ],
      "properties": {
        "scheme": {
          "type": "string",
          "enum": [
            "bearer"
          ]
        },
        "key_type": {
          "type": "string",
          "enum": [
            "api"
          ]
        },
        "create_key_url": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "first_call": {
      "type": "object",
      "required": [
        "method",
        "href",
        "curl"
      ],
      "properties": {
        "method": {
          "type": "string"
        },
        "href": {
          "type": "string"
        },
        "curl": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "next_steps": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NextStepItem"
      }
    }
  },
  "additionalProperties": true,
  "$defs": {
    "NextStepItem": {
      "type": "object",
      "required": [
        "rel",
        "method",
        "href",
        "why"
      ],
      "properties": {
        "rel": {
          "type": "string"
        },
        "method": {
          "type": "string"
        },
        "href": {
          "type": "string"
        },
        "why": {
          "type": "string"
        }
      },
      "additionalProperties": true
    }
  }
}