Kong · Schema

API Specification

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
id	string	The API specification identifier.
content	string	The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).
validation_messages	array	The errors that occurred while parsing the API specification.
type	string	The type of specification being stored. This allows us to render the specification correctly.
created_at	object
updated_at	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiSpec",
  "title": "API Specification",
  "type": "object",
  "properties": {
    "id": {
      "description": "The API specification identifier.",
      "type": "string",
      "format": "uuid",
      "example": "7710d5c4-d902-410b-992f-18b814155b53",
      "readOnly": true
    },
    "content": {
      "description": "The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).\n",
      "example": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}",
      "type": "string"
    },
    "validation_messages": {
      "description": "The errors that occurred while parsing the API specification.",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "type": "string"
          }
        }
      },
      "readOnly": true
    },
    "type": {
      "description": "The type of specification being stored. This allows us to render the specification correctly.\n",
      "type": "string",
      "example": "oas3",
      "enum": [
        "oas2",
        "oas3",
        "asyncapi"
      ],
      "title": "API Spec Type",
      "x-speakeasy-unknown-values": "allow"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    }
  },
  "additionalProperties": false
}