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

AsyncAPI schema versions

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://asyncapi.com/definitions/3.1.0/externalDocs.json",
  "description": "Allows referencing an external resource for extended documentation.",
  "type": "object",
  "required": [ "url" ],
  "properties": {
    "description": {
      "description": "A short description of the target documentation. CommonMark syntax can be used for rich text representation.",
      "type": "string"
    },
    "url": {
      "description": "The URL for the target documentation. This MUST be in the form of an absolute URL.",
      "type": "string",
      "format": "uri"
    }
  },
  "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/externalDocs.json"
  }
}