@asyncapi/specs/definitions/1.2.0/asyncapi.json

AsyncAPI schema versions

{
  "title": "AsyncAPI 1.2.0 schema.",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "http://asyncapi.com/definitions/1.2.0/asyncapi.json",
  "type": "object",
  "required": [
    "asyncapi",
    "info"
  ],
  "oneOf": [
    {
      "required": [
        "topics"
      ]
    },
    {
      "required": [
        "stream"
      ]
    },
    {
      "required": [
        "events"
      ]
    }
  ],
  "additionalProperties": false,
  "patternProperties": {
    "^x-": {
      "$ref": "http://asyncapi.com/definitions/1.2.0/vendorExtension.json"
    }
  },
  "properties": {
    "asyncapi": {
      "type": "string",
      "enum": [
        "1.0.0",
        "1.1.0",
        "1.2.0"
      ],
      "description": "The AsyncAPI specification version of this document."
    },
    "info": {
      "$ref": "http://asyncapi.com/definitions/1.2.0/info.json"
    },
    "baseTopic": {
      "type": "string",
      "pattern": "^[^/.]",
      "description": "The base topic to the API. Example: 'hitch'.",
      "default": ""
    },
    "servers": {
      "type": "array",
      "items": {
        "$ref": "http://asyncapi.com/definitions/1.2.0/server.json"
      },
      "uniqueItems": true
    },
    "topics": {
      "$ref": "http://asyncapi.com/definitions/1.2.0/topics.json"
    },
    "stream": {
      "$ref": "http://asyncapi.com/definitions/1.2.0/stream.json",
      "description": "The list of messages a consumer can read or write from/to a streaming API."
    },
    "events": {
      "$ref": "http://asyncapi.com/definitions/1.2.0/events.json",
      "description": "The list of messages an events API sends and/or receives."
    },
    "components": {
      "$ref": "http://asyncapi.com/definitions/1.2.0/components.json"
    },
    "tags": {
      "type": "array",
      "items": {
        "$ref": "http://asyncapi.com/definitions/1.2.0/tag.json"
      },
      "uniqueItems": true
    },
    "security": {
      "type": "array",
      "items": {
        "$ref": "http://asyncapi.com/definitions/1.2.0/SecurityRequirement.json"
      }
    },
    "externalDocs": {
      "$ref": "http://asyncapi.com/definitions/1.2.0/externalDocs.json"
    }
  }
}