@asyncapi/specs/definitions/3.1.0/channel.json

AsyncAPI schema versions

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://asyncapi.com/definitions/3.1.0/channel.json",
  "description": "Describes a shared communication channel.",
  "type": "object",
  "properties": {
    "title": {
      "description": "A human-friendly title for the channel.",
      "type": "string"
    },
    "description": {
      "description": "A longer description of the channel. CommonMark is allowed.",
      "type": "string"
    },
    "address": {
      "description": "An optional string representation of this channel's address. The address is typically the \"topic name\", \"routing key\", \"event type\", or \"path\". When `null` or absent, it MUST be interpreted as unknown. This is useful when the address is generated dynamically at runtime or can't be known upfront. It MAY contain Channel Address Expressions.",
      "type": [ "string", "null" ]
    },
    "bindings": {
      "oneOf": [
        {
          "$ref": "http://asyncapi.com/definitions/3.1.0/Reference.json"
        },
        {
          "$ref": "http://asyncapi.com/definitions/3.1.0/channelBindingsObject.json"
        }
      ]
    },
    "externalDocs": {
      "oneOf": [
        {
          "$ref": "http://asyncapi.com/definitions/3.1.0/Reference.json"
        },
        {
          "$ref": "http://asyncapi.com/definitions/3.1.0/externalDocs.json"
        }
      ]
    },
    "messages": {
      "$ref": "http://asyncapi.com/definitions/3.1.0/channelMessages.json"
    },
    "parameters": {
      "$ref": "http://asyncapi.com/definitions/3.1.0/parameters.json"
    },
    "servers": {
      "description": "The references of the servers on which this channel is available. If absent or empty then this channel must be available on all servers.",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "$ref": "http://asyncapi.com/definitions/3.1.0/Reference.json"
      }
    },
    "summary": {
      "description": "A brief summary of the channel.",
      "type": "string"
    },
    "tags": {
      "description": "A list of tags for logical grouping of channels.",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "oneOf": [
          {
            "$ref": "http://asyncapi.com/definitions/3.1.0/Reference.json"
          },
          {
            "$ref": "http://asyncapi.com/definitions/3.1.0/tag.json"
          }
        ]
      }
    }
  },
  "patternProperties": {
    "^x-[\\w\\d\\.\\x2d_]+$": {
      "$ref": "http://asyncapi.com/definitions/3.1.0/specificationExtension.json"
    }
  },
  "additionalProperties": false,
  "example": {
    "$ref": "http://asyncapi.com/examples/3.1.0/channel.json"
  }
}