Schema nodeapi-receiver-target.json

Show original (referenced schemas with $ref)

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "Describes the possible requests to a Node's Receiver target resource",
    "oneOf": [
        {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "description": "Describes a sender",
            "properties": {
                "description": {
                    "description": "Detailed description of the Sender",
                    "type": "string"
                },
                "device_id": {
                    "description": "Device ID which this Sender forms part of",
                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                    "type": "string"
                },
                "flow_id": {
                    "description": "ID of the Flow currently passing via this Sender",
                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                    "type": "string"
                },
                "id": {
                    "description": "Globally unique identifier for the Sender",
                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                    "type": "string"
                },
                "label": {
                    "description": "Freeform string label for the Sender",
                    "type": "string"
                },
                "manifest_href": {
                    "description": "HTTP URL to a file describing how to connect to the Sender (SDP for RTP)",
                    "format": "uri",
                    "type": "string"
                },
                "tags": {
                    "description": "Key value set of freeform string tags to aid in filtering Senders. Values should be represented as an array of strings. Can be empty.",
                    "patternProperties": {
                        "": {
                            "items": {
                                "type": "string"
                            },
                            "type": "array"
                        }
                    },
                    "type": "object"
                },
                "transport": {
                    "description": "Transport type used by the Sender in URN format",
                    "enum": [
                        "urn:x-nmos:transport:rtp",
                        "urn:x-nmos:transport:rtp.ucast",
                        "urn:x-nmos:transport:rtp.mcast",
                        "urn:x-nmos:transport:dash"
                    ],
                    "format": "uri",
                    "type": "string"
                },
                "version": {
                    "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed",
                    "pattern": "^[0-9]+:[0-9]+$",
                    "type": "string"
                }
            },
            "required": [
                "id",
                "version",
                "label",
                "description",
                "flow_id",
                "transport",
                "device_id",
                "manifest_href"
            ],
            "title": "Sender resource",
            "type": "object"
        },
        {
            "additionalProperties": false,
            "description": "Describes an empty object",
            "properties": {},
            "required": [],
            "title": "Empty object schema",
            "type": "object"
        }
    ],
    "title": "Receiver target resource",
    "type": "object"
}

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