Schema endpoint.json

Resolve referenced schemas (may reorder keys)

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes an endpoint that is capable of sending or receiving network flows.",
  "required": [
    "id",
    "chassis_id",
    "port_id",
    "ip_address",
    "attached_network_device"
  ],
  "properties": {
    "id": {
      "description": "Globally unique identifier for the network endpoint",
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
    },
    "chassis_id": {
      "description": "Chassis ID of the interface, as signalled in LLDP from this endpoint. Maybe null where LLDP is unsuitable for use (ie. virtualised environments). Matches to IS-04 nodes/interfaces/chassis-id and should be same.",
      "anyOf": [
        {
          "type": "string",
          "pattern": "^([0-9a-f]{2}[-]){5}([0-9a-f]{2})$",
          "description": "When the Chassis ID is a MAC address, use this format"
        },
        {
          "type": "string",
          "pattern": "^.+$",
          "description": "When the Chassis ID is anything other than a MAC address, a freeform string may be used"
        },
        {
          "type": "null",
          "description": "When the Chassis ID is unavailable it should be set to null"
        }
      ]
    },
    "port_id": {
      "type": "string",
      "description": "MAC address of the endpoint.",
      "pattern": "^([0-9a-f]{2}[-]){5}([0-9a-f]{2})$"
    },
    "ip_address": {
      "type": "string",
      "description": "IP address on which the endpoint sends/receives flows. IP must be unique in the network.",
      "anyOf": [
        {
          "format": "ipv4"
        },
        {
          "format": "ipv6"
        }
      ]
    },
    "attached_network_device": {
      "type": "object",
      "description": "Peer network device (switch) details. This can not be an endpoint.",
      "required": [
        "chassis_id",
        "port_id"
      ],
      "properties": {
        "chassis_id": {
          "type": "string",
          "description": "MAC address for the peer network device.",
          "pattern": "^([0-9a-f]{2}[-]){5}([0-9a-f]{2})$"
        },
        "port_id": {
          "type": "string",
          "description": "The ifAlias of the peer network device the end point is connected to."
        }
      }
    },
    "max_bandwidth": {
      "type": "string",
      "pattern": "^(?:0.|[1-9][0-9]*[.])?[0-9]+[kMG]bit\/s$",
      "description": "Optional. Maximum bandwidth that the sender is allowed to send. Format as numbers followed by kbit/s, Mbit/s, Gbit/s."
    },
    "role": {
      "description": "Optional with default. The role of the endpoint as a sender or receiver.",
      "type": "string",
      "enum": [
        "sender",
        "receiver",
        "both"
      ],
      "default": "both"
    },
    "label": {
      "description": "Optional. Freeform string label for the endpoint",
      "type": "string"
    }
  }
}

Documentation built at 13:05:31 CDT on 2023-07-12.
(c) AMWA 2023. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.