Schema sender.json

Resolve referenced schemas (may reorder keys)

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes a sender",
  "title": "Sender resource",
  "allOf": [
    { "$ref": "resource_core.json" },
    {
      "type": "object",
      "required": [
        "flow_id",
        "transport",
        "device_id",
        "manifest_href",
        "interface_bindings",
        "subscription"
      ],
      "properties": {
        "caps": {
          "description": "Capabilities of this sender",
          "type": "object",
          "properties": {
          }
        },
        "flow_id": {
          "description": "ID of the Flow currently passing via this Sender. Set to null when a Flow is not currently internally routed to the Sender.",
          "type": ["string", "null"],
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
          "default": null
        },
        "transport": {
          "description": "Transport type used by the Sender in URN format",
          "type": "string",
          "oneOf": [
            {
              "pattern": "^urn:x-nmos:transport:"
            },
            {
              "not": {
                "pattern": "^urn:x-nmos:"
              }
            }
          ],
          "format": "uri"
        },
        "device_id": {
          "description": "Device ID which this Sender forms part of. This attribute is used to ensure referential integrity by registry implementations.",
          "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}$"
        },
        "manifest_href": {
          "description": "HTTP(S) accessible URL to a file describing how to connect to the Sender. Set to null when the transport type used by the Sender does not require a transport file.",
          "type": ["string", "null"],
          "format": "uri"
        },
        "interface_bindings": {
          "description": "Binding of Sender egress ports to interfaces on the parent Node.",
          "type": "array",
          "items": {
            "type":"string"
          }
        },
        "subscription": {
          "description": "Object indicating how this Sender is currently configured to send data.",
          "type": "object",
          "required": ["receiver_id", "active"],
          "properties": {
            "receiver_id": {
              "type": ["string", "null"],
              "description": "UUID of the Receiver to which this Sender is currently configured to send data. Only set if it is active, uses a unicast push-based transport and is sending to an NMOS Receiver; otherwise null.",
              "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
              "default": null
            },
            "active": {
              "type": "boolean",
              "description": "Sender is enabled and configured to send data",
              "default": false
            }
          }
        }
      }
    }
  ]
}

 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes a sender",
  "title": "Sender resource",
  "allOf": [
    { "$ref": "resource_core.json" },
    {
      "type": "object",
      "required": [
        "flow_id",
        "transport",
        "device_id",
        "manifest_href",
        "interface_bindings",
        "subscription"
      ],
      "properties": {
        "caps": {
          "description": "Capabilities of this sender",

Documentation built at 05:12:15 CST on 2024-12-11.
(c) AMWA 2024. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.