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

AsyncAPI schema versions

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://asyncapi.com/definitions/3.1.0/server.json",
  "description": "An object representing a message broker, a server or any other kind of computer program capable of sending and/or receiving data.",
  "type": "object",
  "required": [ "host", "protocol" ],
  "properties": {
    "title": {
      "description": "A human-friendly title for the server.",
      "type": "string"
    },
    "description": {
      "description": "A longer description of the server. CommonMark is allowed.",
      "type": "string"
    },
    "bindings": {
      "oneOf": [
        {
          "$ref": "http://asyncapi.com/definitions/3.1.0/Reference.json"
        },
        {
          "$ref": "http://asyncapi.com/definitions/3.1.0/serverBindingsObject.json"
        }
      ]
    },
    "externalDocs": {
      "oneOf": [
        {
          "$ref": "http://asyncapi.com/definitions/3.1.0/Reference.json"
        },
        {
          "$ref": "http://asyncapi.com/definitions/3.1.0/externalDocs.json"
        }
      ]
    },
    "host": {
      "description": "The server host name. It MAY include the port. This field supports Server Variables. Variable substitutions will be made when a variable is named in {braces}.",
      "type": "string"
    },
    "pathname": {
      "description": "The path to a resource in the host. This field supports Server Variables. Variable substitutions will be made when a variable is named in {braces}.",
      "type": "string"
    },
    "protocol": {
      "description": "The protocol this server supports for connection.",
      "type": "string"
    },
    "protocolVersion": {
      "description": "An optional string describing the server. CommonMark syntax MAY be used for rich text representation.",
      "type": "string"
    },
    "security": {
      "$ref": "http://asyncapi.com/definitions/3.1.0/securityRequirements.json"
    },
    "summary": {
      "description": "A brief summary of the server.",
      "type": "string"
    },
    "tags": {
      "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"
          }
        ]
      }
    },
    "variables": {
      "$ref": "http://asyncapi.com/definitions/3.1.0/serverVariables.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/server.json"
  }
}