Schema map-tables-response-schema.json

Show original (referenced schemas with $ref)

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "description": "Describes the map table object",
    "properties": {
        "activation": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "additionalProperties": false,
            "description": "Parameters concerned with activation of the transport parameters",
            "properties": {
                "activation_time": {
                    "anyOf": [
                        {
                            "pattern": "^[0-9]+:[0-9]+$",
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating the absolute time the receiver will or did actually activate for scheduled activations, or the time activation occurred for immediate activations. On the staged endpoint this field returns to null once the activation is completed. For immediate activations on the staged endpoint this property will be the time the activation actually occurred in the response to the PATCH request, but null in response to any GET requests thereafter."
                },
                "mode": {
                    "anyOf": [
                        {
                            "enum": [
                                "activate_immediate",
                                "activate_scheduled_absolute",
                                "activate_scheduled_relative"
                            ],
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Mode of activation: immediate (on message receipt), scheduled_absolute (when internal clock >= requested_time), scheduled_relative (when internal clock >= time of message receipt + requested_time), or null (no activation scheduled). This parameter returns to null on the staged endpoint once an activation is completed. For immediate activations, in the response to the PATCH request this field will be set to 'activate_immediate', but will be null in response to any subsequent GET requests."
                },
                "requested_time": {
                    "anyOf": [
                        {
                            "pattern": "^[0-9]+:[0-9]+$",
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating time (absolute or relative) for activation requested. This field returns to null once the activation is completed on the staged endpoint. For an immediate activation this field will always be null on the staged endpoint, even in the response to the PATCH request."
                }
            },
            "required": [
                "mode",
                "requested_time",
                "activation_time"
            ],
            "type": "object"
        },
        "map": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "description": "Describes one map table entry",
            "patternProperties": {
                "^[a-zA-Z0-9\\-_]+$": {
                    "description": "Names of the output",
                    "patternProperties": {
                        "^(0|([1-9][0-9]*))$": {
                            "description": "Index of channels",
                            "properties": {
                                "channel_index": {
                                    "description": "Index of channel to be connected.",
                                    "type": [
                                        "integer",
                                        "null"
                                    ]
                                },
                                "input": {
                                    "description": "Name of the input the channel to be connected belongs to. null for disconnected.",
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                }
                            },
                            "required": [
                                "input",
                                "channel_index"
                            ]
                        }
                    }
                }
            },
            "title": "Map table entry",
            "type": "object"
        }
    },
    "required": [
        "activation",
        "map"
    ],
    "title": "Map table resource",
    "type": "object"
}

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