@asyncapi/specs/definitions/3.0.0/serverVariable.json

AsyncAPI schema versions

{
  "type": "object",
  "description": "An object representing a Server Variable for server URL template substitution.",
  "additionalProperties": false,
  "patternProperties": {
    "^x-[\\w\\d\\.\\x2d_]+$": {
      "$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
    }
  },
  "properties": {
    "enum": {
      "type": "array",
      "description": "An enumeration of string values to be used if the substitution options are from a limited set.",
      "items": {
        "type": "string"
      },
  	"uniqueItems": true
    },
  	"default": {
  	  "type": "string",
  	  "description": "The default value to use for substitution, and to send, if an alternate value is not supplied."
  	},
  	"description": {
  	  "type": "string",
  	  "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation."
  	},
  	"examples": {
  	  "type": "array",
  	  "description": "An array of examples of the server variable.",
  	  "items": {
  	    "type": "string"
	  }
	}
  },
  "example": {
    "$ref": "http://asyncapi.com/examples/3.0.0/serverVariable.json"
  },
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://asyncapi.com/definitions/3.0.0/serverVariable.json"
}