{ "openapi": "3.1.0", "info": { "title": "openmixer REST API", "description": "Generated from the running console’s own address space, field limits and refusal catalog — never hand-written. Every entity also answers OPTIONS with its live contract (writable fields, ranges, enumerated options), which is the source of truth this document mirrors at generation time.", "version": "2026-09-02", "license": { "name": "GPL-3.0-or-later", "identifier": "GPL-3.0-or-later" } }, "servers": [ { "url": "http://localhost:8080/api" } ], "security": [], "tags": [ { "name": "channel", "description": "Rows under /channel." }, { "name": "patchbay", "description": "Rows under /patchbay." }, { "name": "console", "description": "Rows under /console." }, { "name": "surface", "description": "Rows under /surface." }, { "name": "telemetry", "description": "Rows under /telemetry." }, { "name": "clock", "description": "Rows under /clock." }, { "name": "history", "description": "Rows under /history." }, { "name": "rme", "description": "Rows under /rme." }, { "name": "cue", "description": "Rows under /cue." }, { "name": "measurement", "description": "Rows under /measurement." }, { "name": "safety", "description": "Rows under /safety." }, { "name": "adapter", "description": "Rows under /adapter." }, { "name": "channelConfigs", "description": "Rows under /channelConfigs." }, { "name": "discovery", "description": "Rows under /discovery." }, { "name": "scenes", "description": "Rows under /scenes." }, { "name": "sessions", "description": "Rows under /sessions." }, { "name": "source", "description": "Rows under /source." }, { "name": "takes", "description": "Rows under /takes." }, { "name": "net", "description": "Rows under /net." }, { "name": "patch", "description": "Rows under /patch." }, { "name": "patches", "description": "Rows under /patches." }, { "name": "record", "description": "Rows under /record." }, { "name": "adapterType", "description": "Rows under /adapterType." }, { "name": "clipboard", "description": "Rows under /clipboard." }, { "name": "plugins", "description": "Rows under /plugins." }, { "name": "reac", "description": "Rows under /reac." }, { "name": "stagebox", "description": "Rows under /stagebox." }, { "name": "talkback", "description": "Rows under /talkback." }, { "name": "vsc", "description": "Rows under /vsc." }, { "name": "directPath", "description": "Rows under /directPath." }, { "name": "hardware", "description": "Rows under /hardware." }, { "name": "meters", "description": "Rows under /meters." }, { "name": "scene", "description": "Rows under /scene." }, { "name": "session", "description": "Rows under /session." }, { "name": "stageboxModel", "description": "Rows under /stageboxModel." }, { "name": "streams", "description": "Rows under /streams." }, { "name": "warnings", "description": "Rows under /warnings." } ], "paths": { "/api/channel": { "get": { "tags": [ "channel" ], "operationId": "get_channel", "summary": "/channel", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "clipped": { "type": "array" }, "strips": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel", "summary": "The live contract for /channel", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "channel" ], "operationId": "patch_channel", "summary": "Update /channel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clipped": { "type": "array" }, "strips": { "type": "array" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "clipped": { "type": "array" }, "strips": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/align": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_align", "summary": "/channel/{kind}/{index}/align", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "delayMs": { "type": "number", "minimum": 0, "maximum": 100, "description": "step 0.01, ms" }, "reference": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_align", "summary": "The live contract for /channel/{kind}/{index}/align", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_align", "summary": "Update /channel/{kind}/{index}/align", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "delayMs": { "type": "number", "minimum": 0, "maximum": 100, "description": "step 0.01, ms" }, "reference": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "delayMs": { "type": "number", "minimum": 0, "maximum": 100, "description": "step 0.01, ms" }, "reference": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/align/measurement": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_align_measurement", "summary": "/channel/{kind}/{index}/align/measurement", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "at": { "type": "number", "readOnly": true }, "frames": { "type": "number", "readOnly": true }, "reference": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_align_measurement", "summary": "The live contract for /channel/{kind}/{index}/align/measurement", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/capability": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_capability", "summary": "/channel/{kind}/{index}/capability", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "features": { "type": "array", "readOnly": true }, "gainRange": { "type": "object", "readOnly": true }, "known": { "type": "array", "readOnly": true }, "writable": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_capability", "summary": "The live contract for /channel/{kind}/{index}/capability", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/chain": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_chain", "summary": "/channel/{kind}/{index}/chain", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_chain", "summary": "The live contract for /channel/{kind}/{index}/chain", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/chain/processors/{processorId}": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_chain_processors_processorId", "summary": "/channel/{kind}/{index}/chain/processors/{processorId}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "kind": { "type": "string", "readOnly": true }, "label": { "type": "string", "readOnly": true }, "plugin": { "type": "string" }, "sort": { "type": "number", "minimum": -1000000, "maximum": 1000000, "readOnly": true }, "tapPoint": { "type": "string", "enum": [ "Top-Of-Ch", "Post-Trim", "Pre-EQ", "Post-EQ", "Pre-Fader", "Post-Fader" ], "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_chain_processors_processorId", "summary": "The live contract for /channel/{kind}/{index}/chain/processors/{processorId}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "processorId", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_chain_processors_processorId", "summary": "Update /channel/{kind}/{index}/chain/processors/{processorId}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "plugin": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "kind": { "type": "string", "readOnly": true }, "label": { "type": "string", "readOnly": true }, "plugin": { "type": "string" }, "sort": { "type": "number", "minimum": -1000000, "maximum": 1000000, "readOnly": true }, "tapPoint": { "type": "string", "enum": [ "Top-Of-Ch", "Post-Trim", "Pre-EQ", "Post-EQ", "Pre-Fader", "Post-Fader" ], "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/chain/processors/{processorId}/params/{symbol}": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_chain_processors_processorId_params_symbol", "summary": "/channel/{kind}/{index}/chain/processors/{processorId}/params/{symbol}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_chain_processors_processorId_params_symbol", "summary": "The live contract for /channel/{kind}/{index}/chain/processors/{processorId}/params/{symbol}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "processorId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/channel/{kind}/{index}/chain/processors/{processorId}/properties/{property}": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_chain_processors_processorId_properties_property", "summary": "/channel/{kind}/{index}/chain/processors/{processorId}/properties/{property}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_chain_processors_processorId_properties_property", "summary": "The live contract for /channel/{kind}/{index}/chain/processors/{processorId}/properties/{property}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "processorId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "property", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/channel/{kind}/{index}/clip": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_clip", "summary": "/channel/{kind}/{index}/clip", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "at": { "type": "string", "readOnly": true }, "clipped": { "type": "boolean" }, "count": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_clip", "summary": "The live contract for /channel/{kind}/{index}/clip", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_clip", "summary": "Update /channel/{kind}/{index}/clip", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clipped": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "at": { "type": "string", "readOnly": true }, "clipped": { "type": "boolean" }, "count": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/colour": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_colour", "summary": "/channel/{kind}/{index}/colour", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "colour": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_colour", "summary": "The live contract for /channel/{kind}/{index}/colour", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_colour", "summary": "Update /channel/{kind}/{index}/colour", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "colour": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "colour": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/delay": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_delay", "summary": "/channel/{kind}/{index}/delay", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "feedback": { "type": "number", "minimum": 0, "maximum": 0.99 }, "mix": { "type": "number", "minimum": 0, "maximum": 1 }, "on": { "type": "boolean" }, "pingpong": { "type": "boolean" }, "sync": { "type": "boolean" }, "syncDivision": { "type": "number", "minimum": 0.0625, "maximum": 16 }, "timeMs": { "type": "number", "minimum": 0, "maximum": 2000, "description": "step 1, ms" }, "tone": { "type": "number", "minimum": 0, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_delay", "summary": "The live contract for /channel/{kind}/{index}/delay", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_delay", "summary": "Update /channel/{kind}/{index}/delay", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "feedback": { "type": "number", "minimum": 0, "maximum": 0.99 }, "mix": { "type": "number", "minimum": 0, "maximum": 1 }, "on": { "type": "boolean" }, "pingpong": { "type": "boolean" }, "sync": { "type": "boolean" }, "syncDivision": { "type": "number", "minimum": 0.0625, "maximum": 16 }, "timeMs": { "type": "number", "minimum": 0, "maximum": 2000, "description": "step 1, ms" }, "tone": { "type": "number", "minimum": 0, "maximum": 1 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "feedback": { "type": "number", "minimum": 0, "maximum": 0.99 }, "mix": { "type": "number", "minimum": 0, "maximum": 1 }, "on": { "type": "boolean" }, "pingpong": { "type": "boolean" }, "sync": { "type": "boolean" }, "syncDivision": { "type": "number", "minimum": 0.0625, "maximum": 16 }, "timeMs": { "type": "number", "minimum": 0, "maximum": 2000, "description": "step 1, ms" }, "tone": { "type": "number", "minimum": 0, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/dynamics": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_dynamics", "summary": "/channel/{kind}/{index}/dynamics", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "attackMs": { "type": "number", "minimum": 0.1, "maximum": 100, "description": "step 1, ms" }, "kind": { "type": "string", "enum": [ "comp", "limiter" ] }, "makeupDb": { "type": "number", "minimum": 0, "maximum": 24, "description": "step 0.5, dB" }, "on": { "type": "boolean" }, "ratio": { "type": "number", "minimum": 1, "maximum": 20, "description": "step 0.5" }, "releaseMs": { "type": "number", "minimum": 5, "maximum": 3000, "description": "step 10, ms" }, "thresholdDb": { "type": "number", "minimum": -60, "maximum": 0, "description": "step 1, dB" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_dynamics", "summary": "The live contract for /channel/{kind}/{index}/dynamics", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_dynamics", "summary": "Update /channel/{kind}/{index}/dynamics", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "attackMs": { "type": "number", "minimum": 0.1, "maximum": 100, "description": "step 1, ms" }, "kind": { "type": "string", "enum": [ "comp", "limiter" ] }, "makeupDb": { "type": "number", "minimum": 0, "maximum": 24, "description": "step 0.5, dB" }, "on": { "type": "boolean" }, "ratio": { "type": "number", "minimum": 1, "maximum": 20, "description": "step 0.5" }, "releaseMs": { "type": "number", "minimum": 5, "maximum": 3000, "description": "step 10, ms" }, "thresholdDb": { "type": "number", "minimum": -60, "maximum": 0, "description": "step 1, dB" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "attackMs": { "type": "number", "minimum": 0.1, "maximum": 100, "description": "step 1, ms" }, "kind": { "type": "string", "enum": [ "comp", "limiter" ] }, "makeupDb": { "type": "number", "minimum": 0, "maximum": 24, "description": "step 0.5, dB" }, "on": { "type": "boolean" }, "ratio": { "type": "number", "minimum": 1, "maximum": 20, "description": "step 0.5" }, "releaseMs": { "type": "number", "minimum": 5, "maximum": 3000, "description": "step 10, ms" }, "thresholdDb": { "type": "number", "minimum": -60, "maximum": 0, "description": "step 1, dB" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/eq": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_eq", "summary": "/channel/{kind}/{index}/eq", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "on": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_eq", "summary": "The live contract for /channel/{kind}/{index}/eq", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_eq", "summary": "Update /channel/{kind}/{index}/eq", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "on": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "on": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/eq/bands": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_eq_bands", "summary": "/channel/{kind}/{index}/eq/bands", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "bands": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_eq_bands", "summary": "The live contract for /channel/{kind}/{index}/eq/bands", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_eq_bands", "summary": "Update /channel/{kind}/{index}/eq/bands", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bands": { "type": "array" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "bands": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/eq/bands/{bandId}": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_eq_bands_bandId", "summary": "/channel/{kind}/{index}/eq/bands/{bandId}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "freqHz": { "type": "number", "minimum": 20, "maximum": 20000, "description": "step 10, Hz" }, "gainDb": { "type": "number", "minimum": -15, "maximum": 15, "description": "step 0.5, dB" }, "id": { "type": "string", "readOnly": true }, "on": { "type": "boolean" }, "q": { "type": "number", "description": "Range depends on the instance (hardware-reported); not fixed at the schema level." }, "type": { "type": "string", "enum": [ "bell", "lowShelf", "highShelf", "notch" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_eq_bands_bandId", "summary": "The live contract for /channel/{kind}/{index}/eq/bands/{bandId}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "bandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_eq_bands_bandId", "summary": "Update /channel/{kind}/{index}/eq/bands/{bandId}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "freqHz": { "type": "number", "minimum": 20, "maximum": 20000, "description": "step 10, Hz" }, "gainDb": { "type": "number", "minimum": -15, "maximum": 15, "description": "step 0.5, dB" }, "on": { "type": "boolean" }, "q": { "type": "number", "description": "Range depends on the instance (hardware-reported); not fixed at the schema level." }, "type": { "type": "string", "enum": [ "bell", "lowShelf", "highShelf", "notch" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "freqHz": { "type": "number", "minimum": 20, "maximum": 20000, "description": "step 10, Hz" }, "gainDb": { "type": "number", "minimum": -15, "maximum": 15, "description": "step 0.5, dB" }, "id": { "type": "string", "readOnly": true }, "on": { "type": "boolean" }, "q": { "type": "number", "description": "Range depends on the instance (hardware-reported); not fixed at the schema level." }, "type": { "type": "string", "enum": [ "bell", "lowShelf", "highShelf", "notch" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/eq/bands/sort": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_eq_bands_sort", "summary": "/channel/{kind}/{index}/eq/bands/sort", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_eq_bands_sort", "summary": "The live contract for /channel/{kind}/{index}/eq/bands/sort", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_eq_bands_sort", "summary": "Update /channel/{kind}/{index}/eq/bands/sort", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/eq/filters/{filter}": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_eq_filters_filter", "summary": "/channel/{kind}/{index}/eq/filters/{filter}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "freqHz": { "type": "number", "description": "Range depends on the instance (hardware-reported); not fixed at the schema level." }, "on": { "type": "boolean" }, "slope": { "type": "number" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_eq_filters_filter", "summary": "The live contract for /channel/{kind}/{index}/eq/filters/{filter}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "filter", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_eq_filters_filter", "summary": "Update /channel/{kind}/{index}/eq/filters/{filter}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "freqHz": { "type": "number", "description": "Range depends on the instance (hardware-reported); not fixed at the schema level." }, "on": { "type": "boolean" }, "slope": { "type": "number" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "freqHz": { "type": "number", "description": "Range depends on the instance (hardware-reported); not fixed at the schema level." }, "on": { "type": "boolean" }, "slope": { "type": "number" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/fader": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_fader", "summary": "/channel/{kind}/{index}/fader", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "audibleDb": { "type": "number", "readOnly": true }, "dcaScale": { "type": "number", "readOnly": true }, "position": { "type": "number", "minimum": 0, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_fader", "summary": "The live contract for /channel/{kind}/{index}/fader", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_fader", "summary": "Update /channel/{kind}/{index}/fader", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "position": { "type": "number", "minimum": 0, "maximum": 1 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "audibleDb": { "type": "number", "readOnly": true }, "dcaScale": { "type": "number", "readOnly": true }, "position": { "type": "number", "minimum": 0, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/fbs": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_fbs", "summary": "/channel/{kind}/{index}/fbs", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoBands": { "type": "number", "readOnly": true }, "cooldownMinutes": { "type": "number", "minimum": 0, "maximum": 120, "description": "step 1, min" }, "holdSeconds": { "type": "number", "minimum": 1, "maximum": 300, "description": "step 1, s" }, "maxAutoBands": { "type": "number", "minimum": 1, "maximum": 24, "description": "step 1" }, "mergeCents": { "type": "number", "minimum": 0, "maximum": 600, "description": "step 10, cents" }, "mode": { "type": "string", "enum": [ "off", "ringout", "live" ] }, "notchQ": { "type": "number", "minimum": 0.3, "maximum": 116, "description": "step 1" }, "sensitivity": { "type": "number", "minimum": 0, "maximum": 1, "description": "step 0.05" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_fbs", "summary": "The live contract for /channel/{kind}/{index}/fbs", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_fbs", "summary": "Update /channel/{kind}/{index}/fbs", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cooldownMinutes": { "type": "number", "minimum": 0, "maximum": 120, "description": "step 1, min" }, "holdSeconds": { "type": "number", "minimum": 1, "maximum": 300, "description": "step 1, s" }, "maxAutoBands": { "type": "number", "minimum": 1, "maximum": 24, "description": "step 1" }, "mergeCents": { "type": "number", "minimum": 0, "maximum": 600, "description": "step 10, cents" }, "mode": { "type": "string", "enum": [ "off", "ringout", "live" ] }, "notchQ": { "type": "number", "minimum": 0.3, "maximum": 116, "description": "step 1" }, "sensitivity": { "type": "number", "minimum": 0, "maximum": 1, "description": "step 0.05" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoBands": { "type": "number", "readOnly": true }, "cooldownMinutes": { "type": "number", "minimum": 0, "maximum": 120, "description": "step 1, min" }, "holdSeconds": { "type": "number", "minimum": 1, "maximum": 300, "description": "step 1, s" }, "maxAutoBands": { "type": "number", "minimum": 1, "maximum": 24, "description": "step 1" }, "mergeCents": { "type": "number", "minimum": 0, "maximum": 600, "description": "step 10, cents" }, "mode": { "type": "string", "enum": [ "off", "ringout", "live" ] }, "notchQ": { "type": "number", "minimum": 0.3, "maximum": 116, "description": "step 1" }, "sensitivity": { "type": "number", "minimum": 0, "maximum": 1, "description": "step 0.05" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/fbs/candidates": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_fbs_candidates", "summary": "/channel/{kind}/{index}/fbs/candidates", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_fbs_candidates", "summary": "The live contract for /channel/{kind}/{index}/fbs/candidates", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/fbs/lastAction": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_fbs_lastAction", "summary": "/channel/{kind}/{index}/fbs/lastAction", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_fbs_lastAction", "summary": "The live contract for /channel/{kind}/{index}/fbs/lastAction", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/gain": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_gain", "summary": "/channel/{kind}/{index}/gain", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "db": { "type": "number", "description": "Range depends on the instance (hardware-reported); not fixed at the schema level.", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_gain", "summary": "The live contract for /channel/{kind}/{index}/gain", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/gate": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_gate", "summary": "/channel/{kind}/{index}/gate", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "attackMs": { "type": "number", "minimum": 0, "maximum": 500, "description": "step 0.5, ms" }, "holdMs": { "type": "number", "minimum": 0, "maximum": 2000, "description": "step 5, ms" }, "hysteresisDb": { "type": "number", "minimum": 0, "maximum": 24, "description": "step 0.5, dB" }, "kneeEndDb": { "type": "number", "minimum": -80, "maximum": 0, "description": "step 1, dB" }, "kneeStartDb": { "type": "number", "minimum": -80, "maximum": 0, "description": "step 1, dB" }, "on": { "type": "boolean" }, "rangeDb": { "type": "number", "minimum": -90, "maximum": 0, "description": "step 1, dB" }, "ratio": { "type": "number", "minimum": 1, "maximum": 100, "description": "step 1" }, "releaseMs": { "type": "number", "minimum": 0, "maximum": 5000, "description": "step 10, ms" }, "thresholdDb": { "type": "number", "minimum": -80, "maximum": 0, "description": "step 1, dB" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_gate", "summary": "The live contract for /channel/{kind}/{index}/gate", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_gate", "summary": "Update /channel/{kind}/{index}/gate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "attackMs": { "type": "number", "minimum": 0, "maximum": 500, "description": "step 0.5, ms" }, "holdMs": { "type": "number", "minimum": 0, "maximum": 2000, "description": "step 5, ms" }, "hysteresisDb": { "type": "number", "minimum": 0, "maximum": 24, "description": "step 0.5, dB" }, "kneeEndDb": { "type": "number", "minimum": -80, "maximum": 0, "description": "step 1, dB" }, "kneeStartDb": { "type": "number", "minimum": -80, "maximum": 0, "description": "step 1, dB" }, "on": { "type": "boolean" }, "rangeDb": { "type": "number", "minimum": -90, "maximum": 0, "description": "step 1, dB" }, "ratio": { "type": "number", "minimum": 1, "maximum": 100, "description": "step 1" }, "releaseMs": { "type": "number", "minimum": 0, "maximum": 5000, "description": "step 10, ms" }, "thresholdDb": { "type": "number", "minimum": -80, "maximum": 0, "description": "step 1, dB" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "attackMs": { "type": "number", "minimum": 0, "maximum": 500, "description": "step 0.5, ms" }, "holdMs": { "type": "number", "minimum": 0, "maximum": 2000, "description": "step 5, ms" }, "hysteresisDb": { "type": "number", "minimum": 0, "maximum": 24, "description": "step 0.5, dB" }, "kneeEndDb": { "type": "number", "minimum": -80, "maximum": 0, "description": "step 1, dB" }, "kneeStartDb": { "type": "number", "minimum": -80, "maximum": 0, "description": "step 1, dB" }, "on": { "type": "boolean" }, "rangeDb": { "type": "number", "minimum": -90, "maximum": 0, "description": "step 1, dB" }, "ratio": { "type": "number", "minimum": 1, "maximum": 100, "description": "step 1" }, "releaseMs": { "type": "number", "minimum": 0, "maximum": 5000, "description": "step 10, ms" }, "thresholdDb": { "type": "number", "minimum": -80, "maximum": 0, "description": "step 1, dB" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/headAmp": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_headAmp", "summary": "/channel/{kind}/{index}/headAmp", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "gainDb": { "type": "number", "description": "Range depends on the instance (hardware-reported); not fixed at the schema level." }, "gainRange": { "type": "object", "readOnly": true }, "pad": { "type": "boolean" }, "phantom": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_headAmp", "summary": "The live contract for /channel/{kind}/{index}/headAmp", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_headAmp", "summary": "Update /channel/{kind}/{index}/headAmp", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gainDb": { "type": "number", "description": "Range depends on the instance (hardware-reported); not fixed at the schema level." }, "pad": { "type": "boolean" }, "phantom": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "gainDb": { "type": "number", "description": "Range depends on the instance (hardware-reported); not fixed at the schema level." }, "gainRange": { "type": "object", "readOnly": true }, "pad": { "type": "boolean" }, "phantom": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/hrp": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_hrp", "summary": "/channel/{kind}/{index}/hrp", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "minimum": 0, "maximum": 1 }, "autoBands": { "type": "number", "readOnly": true }, "freeze": { "type": "boolean" }, "maxAutoBands": { "type": "number", "minimum": 1, "maximum": 24, "description": "step 1" }, "mode": { "type": "string", "enum": [ "off", "monitor", "adaptive" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_hrp", "summary": "The live contract for /channel/{kind}/{index}/hrp", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_hrp", "summary": "Update /channel/{kind}/{index}/hrp", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "minimum": 0, "maximum": 1 }, "freeze": { "type": "boolean" }, "maxAutoBands": { "type": "number", "minimum": 1, "maximum": 24, "description": "step 1" }, "mode": { "type": "string", "enum": [ "off", "monitor", "adaptive" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "minimum": 0, "maximum": 1 }, "autoBands": { "type": "number", "readOnly": true }, "freeze": { "type": "boolean" }, "maxAutoBands": { "type": "number", "minimum": 1, "maximum": 24, "description": "step 1" }, "mode": { "type": "string", "enum": [ "off", "monitor", "adaptive" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/hrp/report": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_hrp_report", "summary": "/channel/{kind}/{index}/hrp/report", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "at": { "type": "number", "readOnly": true }, "voices": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_hrp_report", "summary": "The live contract for /channel/{kind}/{index}/hrp/report", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/hrp/reset": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_hrp_reset", "summary": "/channel/{kind}/{index}/hrp/reset", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_hrp_reset", "summary": "The live contract for /channel/{kind}/{index}/hrp/reset", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_hrp_reset", "summary": "Update /channel/{kind}/{index}/hrp/reset", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/inserts": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_inserts", "summary": "/channel/{kind}/{index}/inserts", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "plugins": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_inserts", "summary": "The live contract for /channel/{kind}/{index}/inserts", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_inserts", "summary": "Update /channel/{kind}/{index}/inserts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "plugins": { "type": "array" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "plugins": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/inserts/{slot}": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_inserts_slot", "summary": "/channel/{kind}/{index}/inserts/{slot}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_inserts_slot", "summary": "The live contract for /channel/{kind}/{index}/inserts/{slot}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "slot", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/channel/{kind}/{index}/inserts/{slot}/params/{symbol}": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_inserts_slot_params_symbol", "summary": "/channel/{kind}/{index}/inserts/{slot}/params/{symbol}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_inserts_slot_params_symbol", "summary": "The live contract for /channel/{kind}/{index}/inserts/{slot}/params/{symbol}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "slot", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/channel/{kind}/{index}/inserts/{slot}/properties/{property}": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_inserts_slot_properties_property", "summary": "/channel/{kind}/{index}/inserts/{slot}/properties/{property}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_inserts_slot_properties_property", "summary": "The live contract for /channel/{kind}/{index}/inserts/{slot}/properties/{property}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "slot", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "property", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/channel/{kind}/{index}/inserts/suitability": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_inserts_suitability", "summary": "/channel/{kind}/{index}/inserts/suitability", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_inserts_suitability", "summary": "The live contract for /channel/{kind}/{index}/inserts/suitability", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/instrument": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_instrument", "summary": "/channel/{kind}/{index}/instrument", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "instrument": { "type": "string", "enum": [ "kick-in", "kick-out", "snare-top", "snare-bottom", "hihat", "tom-rack", "tom-floor", "overheads", "congas", "bongos", "timbales", "cajon", "hand-perc", "bass-di", "bass-mic", "upright-bass", "synth-bass", "egtr-amp", "agtr-di", "agtr-steel", "egtr-clean", "egtr-crunch", "keys-di", "piano", "grand-piano", "electric-piano", "hammond-organ", "synth-pad", "synth-lead", "lead-vocal-m", "lead-vocal-f", "backing-vocal", "spoken-word", "choir", "brass", "fiscorn", "flugelhorn", "trumpet", "cornet", "french-horn", "trombone-tenor", "trombone-bass", "trombone-alto", "trombone-valve", "tuba", "sax-soprano", "sax-alto", "sax-tenor", "sax-baritone", "strings", "violin-section", "solo-violin", "viola", "cello", "double-bass-arco", "playback-stereo", "backing-tracks", "click-track", "talkback-band" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_instrument", "summary": "The live contract for /channel/{kind}/{index}/instrument", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_instrument", "summary": "Update /channel/{kind}/{index}/instrument", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "instrument": { "type": "string", "enum": [ "kick-in", "kick-out", "snare-top", "snare-bottom", "hihat", "tom-rack", "tom-floor", "overheads", "congas", "bongos", "timbales", "cajon", "hand-perc", "bass-di", "bass-mic", "upright-bass", "synth-bass", "egtr-amp", "agtr-di", "agtr-steel", "egtr-clean", "egtr-crunch", "keys-di", "piano", "grand-piano", "electric-piano", "hammond-organ", "synth-pad", "synth-lead", "lead-vocal-m", "lead-vocal-f", "backing-vocal", "spoken-word", "choir", "brass", "fiscorn", "flugelhorn", "trumpet", "cornet", "french-horn", "trombone-tenor", "trombone-bass", "trombone-alto", "trombone-valve", "tuba", "sax-soprano", "sax-alto", "sax-tenor", "sax-baritone", "strings", "violin-section", "solo-violin", "viola", "cello", "double-bass-arco", "playback-stereo", "backing-tracks", "click-track", "talkback-band" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "instrument": { "type": "string", "enum": [ "kick-in", "kick-out", "snare-top", "snare-bottom", "hihat", "tom-rack", "tom-floor", "overheads", "congas", "bongos", "timbales", "cajon", "hand-perc", "bass-di", "bass-mic", "upright-bass", "synth-bass", "egtr-amp", "agtr-di", "agtr-steel", "egtr-clean", "egtr-crunch", "keys-di", "piano", "grand-piano", "electric-piano", "hammond-organ", "synth-pad", "synth-lead", "lead-vocal-m", "lead-vocal-f", "backing-vocal", "spoken-word", "choir", "brass", "fiscorn", "flugelhorn", "trumpet", "cornet", "french-horn", "trombone-tenor", "trombone-bass", "trombone-alto", "trombone-valve", "tuba", "sax-soprano", "sax-alto", "sax-tenor", "sax-baritone", "strings", "violin-section", "solo-violin", "viola", "cello", "double-bass-arco", "playback-stereo", "backing-tracks", "click-track", "talkback-band" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/link": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_link", "summary": "/channel/{kind}/{index}/link", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "linked": { "type": "boolean" }, "partner": { "type": "string" }, "role": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_link", "summary": "The live contract for /channel/{kind}/{index}/link", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_link", "summary": "Update /channel/{kind}/{index}/link", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "linked": { "type": "boolean" }, "partner": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "linked": { "type": "boolean" }, "partner": { "type": "string" }, "role": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/meter": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_meter", "summary": "/channel/{kind}/{index}/meter", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "at": { "type": "number", "readOnly": true }, "level": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_meter", "summary": "The live contract for /channel/{kind}/{index}/meter", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/mixMinus": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_mixMinus", "summary": "/channel/{kind}/{index}/mixMinus", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_mixMinus", "summary": "The live contract for /channel/{kind}/{index}/mixMinus", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_mixMinus", "summary": "Update /channel/{kind}/{index}/mixMinus", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/mixMinus/excluded": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_mixMinus_excluded", "summary": "/channel/{kind}/{index}/mixMinus/excluded", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_mixMinus_excluded", "summary": "The live contract for /channel/{kind}/{index}/mixMinus/excluded", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/mute": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_mute", "summary": "/channel/{kind}/{index}/mute", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "audibleMute": { "type": "boolean", "readOnly": true }, "byGroup": { "type": "boolean", "readOnly": true }, "byPanic": { "type": "boolean", "readOnly": true }, "bySip": { "type": "boolean", "readOnly": true }, "individual": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_mute", "summary": "The live contract for /channel/{kind}/{index}/mute", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_mute", "summary": "Update /channel/{kind}/{index}/mute", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "individual": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "audibleMute": { "type": "boolean", "readOnly": true }, "byGroup": { "type": "boolean", "readOnly": true }, "byPanic": { "type": "boolean", "readOnly": true }, "bySip": { "type": "boolean", "readOnly": true }, "individual": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/name": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_name", "summary": "/channel/{kind}/{index}/name", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_name", "summary": "The live contract for /channel/{kind}/{index}/name", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_name", "summary": "Update /channel/{kind}/{index}/name", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/pan": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_pan", "summary": "/channel/{kind}/{index}/pan", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "pan": { "type": "number", "minimum": -1, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_pan", "summary": "The live contract for /channel/{kind}/{index}/pan", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_pan", "summary": "Update /channel/{kind}/{index}/pan", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pan": { "type": "number", "minimum": -1, "maximum": 1 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "pan": { "type": "number", "minimum": -1, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/polarity": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_polarity", "summary": "/channel/{kind}/{index}/polarity", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "inverted": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_polarity", "summary": "The live contract for /channel/{kind}/{index}/polarity", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_polarity", "summary": "Update /channel/{kind}/{index}/polarity", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inverted": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "inverted": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/recallSafe": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_recallSafe", "summary": "/channel/{kind}/{index}/recallSafe", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "all": { "type": "boolean" }, "effective": { "type": "array", "readOnly": true }, "scopes": { "type": "string", "enum": [ "fader", "mute", "sends", "eq", "dyn", "inserts" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_recallSafe", "summary": "The live contract for /channel/{kind}/{index}/recallSafe", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_recallSafe", "summary": "Update /channel/{kind}/{index}/recallSafe", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "all": { "type": "boolean" }, "scopes": { "type": "string", "enum": [ "fader", "mute", "sends", "eq", "dyn", "inserts" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "all": { "type": "boolean" }, "effective": { "type": "array", "readOnly": true }, "scopes": { "type": "string", "enum": [ "fader", "mute", "sends", "eq", "dyn", "inserts" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/record": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_record", "summary": "/channel/{kind}/{index}/record", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "armed": { "type": "boolean" }, "taps": { "type": "string", "enum": [ "Post-Trim", "Pre-Fader", "Post-Fader" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_record", "summary": "The live contract for /channel/{kind}/{index}/record", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_record", "summary": "Update /channel/{kind}/{index}/record", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "armed": { "type": "boolean" }, "taps": { "type": "string", "enum": [ "Post-Trim", "Pre-Fader", "Post-Fader" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "armed": { "type": "boolean" }, "taps": { "type": "string", "enum": [ "Post-Trim", "Pre-Fader", "Post-Fader" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/reverb": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_reverb", "summary": "/channel/{kind}/{index}/reverb", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "algorithm": { "type": "string", "enum": [ "room", "plate", "hall" ] }, "damping": { "type": "number", "minimum": 0, "maximum": 1 }, "highcut": { "type": "number", "minimum": 0, "maximum": 20000, "description": "step 10, Hz" }, "lowcut": { "type": "number", "minimum": 0, "maximum": 20000, "description": "step 10, Hz" }, "mix": { "type": "number", "minimum": 0, "maximum": 1 }, "on": { "type": "boolean" }, "predelayMs": { "type": "number", "minimum": 0, "maximum": 100, "description": "step 1, ms" }, "size": { "type": "number", "minimum": 0, "maximum": 1 }, "width": { "type": "number", "minimum": 0, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_reverb", "summary": "The live contract for /channel/{kind}/{index}/reverb", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_reverb", "summary": "Update /channel/{kind}/{index}/reverb", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "algorithm": { "type": "string", "enum": [ "room", "plate", "hall" ] }, "damping": { "type": "number", "minimum": 0, "maximum": 1 }, "highcut": { "type": "number", "minimum": 0, "maximum": 20000, "description": "step 10, Hz" }, "lowcut": { "type": "number", "minimum": 0, "maximum": 20000, "description": "step 10, Hz" }, "mix": { "type": "number", "minimum": 0, "maximum": 1 }, "on": { "type": "boolean" }, "predelayMs": { "type": "number", "minimum": 0, "maximum": 100, "description": "step 1, ms" }, "size": { "type": "number", "minimum": 0, "maximum": 1 }, "width": { "type": "number", "minimum": 0, "maximum": 1 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "algorithm": { "type": "string", "enum": [ "room", "plate", "hall" ] }, "damping": { "type": "number", "minimum": 0, "maximum": 1 }, "highcut": { "type": "number", "minimum": 0, "maximum": 20000, "description": "step 10, Hz" }, "lowcut": { "type": "number", "minimum": 0, "maximum": 20000, "description": "step 10, Hz" }, "mix": { "type": "number", "minimum": 0, "maximum": 1 }, "on": { "type": "boolean" }, "predelayMs": { "type": "number", "minimum": 0, "maximum": 100, "description": "step 1, ms" }, "size": { "type": "number", "minimum": 0, "maximum": 1 }, "width": { "type": "number", "minimum": 0, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/rta/arming": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_rta_arming", "summary": "/channel/{kind}/{index}/rta/arming", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "armed": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_rta_arming", "summary": "The live contract for /channel/{kind}/{index}/rta/arming", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_rta_arming", "summary": "Update /channel/{kind}/{index}/rta/arming", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "armed": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "armed": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/send/{busKind}/{busIndex}": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_send_busKind_busIndex", "summary": "/channel/{kind}/{index}/send/{busKind}/{busIndex}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "level": { "type": "number", "minimum": 0, "maximum": 1 }, "tap": { "type": "string", "enum": [ "Top-Of-Ch", "Post-Trim", "Pre-EQ", "Post-EQ", "Pre-Fader", "Post-Fader" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_send_busKind_busIndex", "summary": "The live contract for /channel/{kind}/{index}/send/{busKind}/{busIndex}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "busKind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "busIndex", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_send_busKind_busIndex", "summary": "Update /channel/{kind}/{index}/send/{busKind}/{busIndex}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "level": { "type": "number", "minimum": 0, "maximum": 1 }, "tap": { "type": "string", "enum": [ "Top-Of-Ch", "Post-Trim", "Pre-EQ", "Post-EQ", "Pre-Fader", "Post-Fader" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "level": { "type": "number", "minimum": 0, "maximum": 1 }, "tap": { "type": "string", "enum": [ "Top-Of-Ch", "Post-Trim", "Pre-EQ", "Post-EQ", "Pre-Fader", "Post-Fader" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/solo": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_solo", "summary": "/channel/{kind}/{index}/solo", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "solo": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_solo", "summary": "The live contract for /channel/{kind}/{index}/solo", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_solo", "summary": "Update /channel/{kind}/{index}/solo", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "solo": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "solo": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/soloSafe": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_soloSafe", "summary": "/channel/{kind}/{index}/soloSafe", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "safe": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_soloSafe", "summary": "The live contract for /channel/{kind}/{index}/soloSafe", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_soloSafe", "summary": "Update /channel/{kind}/{index}/soloSafe", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "safe": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "safe": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/source": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_source", "summary": "/channel/{kind}/{index}/source", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "track" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_source", "summary": "The live contract for /channel/{kind}/{index}/source", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_source", "summary": "Update /channel/{kind}/{index}/source", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "track" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "track" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/speakerAlign": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_speakerAlign", "summary": "/channel/{kind}/{index}/speakerAlign", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_speakerAlign", "summary": "The live contract for /channel/{kind}/{index}/speakerAlign", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/spectrum": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_spectrum", "summary": "/channel/{kind}/{index}/spectrum", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "at": { "type": "number", "readOnly": true }, "bands": { "type": "string", "readOnly": true }, "mags": { "type": "array", "readOnly": true }, "muted": { "type": "boolean", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_spectrum", "summary": "The live contract for /channel/{kind}/{index}/spectrum", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/{kind}/{index}/trim": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_trim", "summary": "/channel/{kind}/{index}/trim", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "db": { "type": "number", "minimum": -24, "maximum": 24, "description": "step 0.1, dB" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_trim", "summary": "The live contract for /channel/{kind}/{index}/trim", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_kind_index_trim", "summary": "Update /channel/{kind}/{index}/trim", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "db": { "type": "number", "minimum": -24, "maximum": 24, "description": "step 0.1, dB" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "db": { "type": "number", "minimum": -24, "maximum": 24, "description": "step 0.1, dB" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/{kind}/{index}/width": { "get": { "tags": [ "channel" ], "operationId": "get_channel_kind_index_width", "summary": "/channel/{kind}/{index}/width", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "width": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_kind_index_width", "summary": "The live contract for /channel/{kind}/{index}/width", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/channel/dca/{index}/members": { "get": { "tags": [ "channel" ], "operationId": "get_channel_dca_index_members", "summary": "/channel/dca/{index}/members", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array" }, "parents": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_dca_index_members", "summary": "The live contract for /channel/dca/{index}/members", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_dca_index_members", "summary": "Update /channel/dca/{index}/members", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array" }, "parents": { "type": "array" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array" }, "parents": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/matrix/{index}/input/{srcKind}/{srcIndex}": { "get": { "tags": [ "channel" ], "operationId": "get_channel_matrix_index_input_srcKind_srcIndex", "summary": "/channel/matrix/{index}/input/{srcKind}/{srcIndex}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "level": { "type": "number", "minimum": 0, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_matrix_index_input_srcKind_srcIndex", "summary": "The live contract for /channel/matrix/{index}/input/{srcKind}/{srcIndex}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "srcKind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "srcIndex", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_matrix_index_input_srcKind_srcIndex", "summary": "Update /channel/matrix/{index}/input/{srcKind}/{srcIndex}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "level": { "type": "number", "minimum": 0, "maximum": 1 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "level": { "type": "number", "minimum": 0, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/muteGroup/{index}/active": { "get": { "tags": [ "channel" ], "operationId": "get_channel_muteGroup_index_active", "summary": "/channel/muteGroup/{index}/active", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_muteGroup_index_active", "summary": "The live contract for /channel/muteGroup/{index}/active", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_muteGroup_index_active", "summary": "Update /channel/muteGroup/{index}/active", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/muteGroup/{index}/members": { "get": { "tags": [ "channel" ], "operationId": "get_channel_muteGroup_index_members", "summary": "/channel/muteGroup/{index}/members", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_muteGroup_index_members", "summary": "The live contract for /channel/muteGroup/{index}/members", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_muteGroup_index_members", "summary": "Update /channel/muteGroup/{index}/members", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channel/muteGroup/{index}/name": { "get": { "tags": [ "channel" ], "operationId": "get_channel_muteGroup_index_name", "summary": "/channel/muteGroup/{index}/name", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channel" ], "operationId": "options_channel_muteGroup_index_name", "summary": "The live contract for /channel/muteGroup/{index}/name", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channel" ], "operationId": "patch_channel_muteGroup_index_name", "summary": "Update /channel/muteGroup/{index}/name", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patchbay/devices": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_devices", "summary": "/patchbay/devices", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_devices", "summary": "The live contract for /patchbay/devices", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patchbay/disconnect": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_disconnect", "summary": "/patchbay/disconnect", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apply": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_disconnect", "summary": "The live contract for /patchbay/disconnect", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "patchbay" ], "operationId": "patch_patchbay_disconnect", "summary": "Update /patchbay/disconnect", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "apply": { "type": "string" }, "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apply": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patchbay/exclusive": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_exclusive", "summary": "/patchbay/exclusive", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "held": { "type": "string", "readOnly": true }, "wanted": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_exclusive", "summary": "The live contract for /patchbay/exclusive", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "patchbay" ], "operationId": "patch_patchbay_exclusive", "summary": "Update /patchbay/exclusive", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "wanted": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "held": { "type": "string", "readOnly": true }, "wanted": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patchbay/external": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_external", "summary": "/patchbay/external", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "edges": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_external", "summary": "The live contract for /patchbay/external", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patchbay/external/{edgeId}": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_external_edgeId", "summary": "/patchbay/external/{edgeId}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_external_edgeId", "summary": "The live contract for /patchbay/external/{edgeId}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "edgeId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/patchbay/filter": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_filter", "summary": "/patchbay/filter", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "exclude": { "type": "array" }, "include": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_filter", "summary": "The live contract for /patchbay/filter", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "patchbay" ], "operationId": "patch_patchbay_filter", "summary": "Update /patchbay/filter", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "exclude": { "type": "array" }, "include": { "type": "array" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "exclude": { "type": "array" }, "include": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patchbay/hotInputs": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_hotInputs", "summary": "/patchbay/hotInputs", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "inputs": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_hotInputs", "summary": "The live contract for /patchbay/hotInputs", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patchbay/ignored": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_ignored", "summary": "/patchbay/ignored", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "policies": { "type": "object" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_ignored", "summary": "The live contract for /patchbay/ignored", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "patchbay" ], "operationId": "patch_patchbay_ignored", "summary": "Update /patchbay/ignored", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "policies": { "type": "object" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "policies": { "type": "object" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patchbay/ignored/{source}": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_ignored_source", "summary": "/patchbay/ignored/{source}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "policy": { "type": "string", "enum": [ "offered", "no-auto-patch", "leave-alone" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_ignored_source", "summary": "The live contract for /patchbay/ignored/{source}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "patchbay" ], "operationId": "patch_patchbay_ignored_source", "summary": "Update /patchbay/ignored/{source}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "policy": { "type": "string", "enum": [ "offered", "no-auto-patch", "leave-alone" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "policy": { "type": "string", "enum": [ "offered", "no-auto-patch", "leave-alone" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patchbay/nodes": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_nodes", "summary": "/patchbay/nodes", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "hidden": { "type": "array", "readOnly": true }, "sinks": { "type": "array", "readOnly": true }, "sources": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_nodes", "summary": "The live contract for /patchbay/nodes", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patchbay/stageboxes": { "get": { "tags": [ "patchbay" ], "operationId": "get_patchbay_stageboxes", "summary": "/patchbay/stageboxes", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patchbay" ], "operationId": "options_patchbay_stageboxes", "summary": "The live contract for /patchbay/stageboxes", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/console": { "get": { "tags": [ "console" ], "operationId": "get_console", "summary": "/console", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "readOnly": true }, "role": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "console" ], "operationId": "options_console", "summary": "The live contract for /console", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/console/allocation": { "get": { "tags": [ "console" ], "operationId": "get_console_allocation", "summary": "/console/allocation", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "aux": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "busRoof": { "type": "number", "readOnly": true }, "busesClaimed": { "type": "number", "readOnly": true }, "dca": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "declared": { "type": "boolean", "readOnly": true }, "fxReturn": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "group": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "inputChannels": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "main": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "matrix": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "mixMinus": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "name": { "type": "string" }, "refusedBuses": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "console" ], "operationId": "options_console_allocation", "summary": "The live contract for /console/allocation", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "console" ], "operationId": "patch_console_allocation", "summary": "Update /console/allocation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aux": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "dca": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "fxReturn": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "group": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "inputChannels": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "main": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "matrix": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "mixMinus": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "name": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "aux": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "busRoof": { "type": "number", "readOnly": true }, "busesClaimed": { "type": "number", "readOnly": true }, "dca": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "declared": { "type": "boolean", "readOnly": true }, "fxReturn": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "group": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "inputChannels": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "main": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "matrix": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "mixMinus": { "type": "number", "minimum": 0, "maximum": 512, "description": "step 1" }, "name": { "type": "string" }, "refusedBuses": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/console/bpm": { "get": { "tags": [ "console" ], "operationId": "get_console_bpm", "summary": "/console/bpm", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "bpm": { "type": "number", "minimum": 30, "maximum": 300 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "console" ], "operationId": "options_console_bpm", "summary": "The live contract for /console/bpm", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "console" ], "operationId": "patch_console_bpm", "summary": "Update /console/bpm", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bpm": { "type": "number", "minimum": 30, "maximum": 300 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "bpm": { "type": "number", "minimum": 30, "maximum": 300 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/console/bpm/tap": { "get": { "tags": [ "console" ], "operationId": "get_console_bpm_tap", "summary": "/console/bpm/tap", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "console" ], "operationId": "options_console_bpm_tap", "summary": "The live contract for /console/bpm/tap", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "console" ], "operationId": "patch_console_bpm_tap", "summary": "Update /console/bpm/tap", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/console/defaults": { "get": { "tags": [ "console" ], "operationId": "get_console_defaults", "summary": "/console/defaults", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "gainDb": { "type": "number", "minimum": 0, "maximum": 55, "description": "step 1, dB" }, "pad": { "type": "boolean" }, "phantom": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "console" ], "operationId": "options_console_defaults", "summary": "The live contract for /console/defaults", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "console" ], "operationId": "patch_console_defaults", "summary": "Update /console/defaults", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gainDb": { "type": "number", "minimum": 0, "maximum": 55, "description": "step 1, dB" }, "pad": { "type": "boolean" }, "phantom": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "gainDb": { "type": "number", "minimum": 0, "maximum": 55, "description": "step 1, dB" }, "pad": { "type": "boolean" }, "phantom": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/console/locale": { "get": { "tags": [ "console" ], "operationId": "get_console_locale", "summary": "/console/locale", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "console" ], "operationId": "options_console_locale", "summary": "The live contract for /console/locale", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "console" ], "operationId": "patch_console_locale", "summary": "Update /console/locale", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/console/pdc": { "get": { "tags": [ "console" ], "operationId": "get_console_pdc", "summary": "/console/pdc", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "console" ], "operationId": "options_console_pdc", "summary": "The live contract for /console/pdc", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "console" ], "operationId": "patch_console_pdc", "summary": "Update /console/pdc", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/console/quantum": { "get": { "tags": [ "console" ], "operationId": "get_console_quantum", "summary": "/console/quantum", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "floor": { "type": "string" }, "live": { "type": "string" }, "rate": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "console" ], "operationId": "options_console_quantum", "summary": "The live contract for /console/quantum", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "console" ], "operationId": "patch_console_quantum", "summary": "Update /console/quantum", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "floor": { "type": "string" }, "live": { "type": "string" }, "rate": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "floor": { "type": "string" }, "live": { "type": "string" }, "rate": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/console/speakerAlign": { "get": { "tags": [ "console" ], "operationId": "get_console_speakerAlign", "summary": "/console/speakerAlign", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mic": { "type": "string" }, "reference": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "console" ], "operationId": "options_console_speakerAlign", "summary": "The live contract for /console/speakerAlign", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "console" ], "operationId": "patch_console_speakerAlign", "summary": "Update /console/speakerAlign", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mic": { "type": "string" }, "reference": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mic": { "type": "string" }, "reference": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/surface/autodetect": { "get": { "tags": [ "surface" ], "operationId": "get_surface_autodetect", "summary": "/surface/autodetect", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "surface" ], "operationId": "options_surface_autodetect", "summary": "The live contract for /surface/autodetect", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "surface" ], "operationId": "patch_surface_autodetect", "summary": "Update /surface/autodetect", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/surface/detected": { "get": { "tags": [ "surface" ], "operationId": "get_surface_detected", "summary": "/surface/detected", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "surface" ], "operationId": "options_surface_detected", "summary": "The live contract for /surface/detected", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/surface/gestures": { "get": { "tags": [ "surface" ], "operationId": "get_surface_gestures", "summary": "/surface/gestures", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirmDestructive": { "type": "boolean" }, "doubleTapMs": { "type": "number", "minimum": 100, "maximum": 600 }, "longPressMs": { "type": "number", "minimum": 400, "maximum": 2000 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "surface" ], "operationId": "options_surface_gestures", "summary": "The live contract for /surface/gestures", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "surface" ], "operationId": "patch_surface_gestures", "summary": "Update /surface/gestures", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "confirmDestructive": { "type": "boolean" }, "doubleTapMs": { "type": "number", "minimum": 100, "maximum": 600 }, "longPressMs": { "type": "number", "minimum": 400, "maximum": 2000 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirmDestructive": { "type": "boolean" }, "doubleTapMs": { "type": "number", "minimum": 100, "maximum": 600 }, "longPressMs": { "type": "number", "minimum": 400, "maximum": 2000 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/surface/pages": { "get": { "tags": [ "surface" ], "operationId": "get_surface_pages", "summary": "/surface/pages", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "surface" ], "operationId": "options_surface_pages", "summary": "The live contract for /surface/pages", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/surface/pages/{index}": { "get": { "tags": [ "surface" ], "operationId": "get_surface_pages_index", "summary": "/surface/pages/{index}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "surface" ], "operationId": "options_surface_pages_index", "summary": "The live contract for /surface/pages/{index}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/surface/preferences": { "get": { "tags": [ "surface" ], "operationId": "get_surface_preferences", "summary": "/surface/preferences", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "bayMenuPosition": { "type": "string", "enum": [ "top", "left", "right" ] }, "confirmConfigApply": { "type": "boolean" }, "density": { "type": "string", "enum": [ "auto", "compact", "normal", "comfortable" ] }, "dismissedMissingKey": { "type": "string" }, "eqFillMode": { "type": "string", "enum": [ "summed", "bands", "off" ] }, "eqTap": { "type": "string", "enum": [ "pre", "post", "both" ] }, "hideUnpatched": { "type": "boolean" }, "narrowOnOverflow": { "type": "boolean" }, "occupiedPatch": { "type": "string", "enum": [ "warn", "unpatch" ] }, "panelTap": { "type": "string", "enum": [ "pre", "post", "both" ] }, "processingPanel": { "type": "object" }, "sendBus": { "type": "string" }, "theme": { "type": "string", "enum": [ "dark", "hc", "light" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "surface" ], "operationId": "options_surface_preferences", "summary": "The live contract for /surface/preferences", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "surface" ], "operationId": "patch_surface_preferences", "summary": "Update /surface/preferences", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bayMenuPosition": { "type": "string", "enum": [ "top", "left", "right" ] }, "confirmConfigApply": { "type": "boolean" }, "density": { "type": "string", "enum": [ "auto", "compact", "normal", "comfortable" ] }, "dismissedMissingKey": { "type": "string" }, "eqFillMode": { "type": "string", "enum": [ "summed", "bands", "off" ] }, "eqTap": { "type": "string", "enum": [ "pre", "post", "both" ] }, "hideUnpatched": { "type": "boolean" }, "narrowOnOverflow": { "type": "boolean" }, "occupiedPatch": { "type": "string", "enum": [ "warn", "unpatch" ] }, "panelTap": { "type": "string", "enum": [ "pre", "post", "both" ] }, "processingPanel": { "type": "object" }, "sendBus": { "type": "string" }, "theme": { "type": "string", "enum": [ "dark", "hc", "light" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "bayMenuPosition": { "type": "string", "enum": [ "top", "left", "right" ] }, "confirmConfigApply": { "type": "boolean" }, "density": { "type": "string", "enum": [ "auto", "compact", "normal", "comfortable" ] }, "dismissedMissingKey": { "type": "string" }, "eqFillMode": { "type": "string", "enum": [ "summed", "bands", "off" ] }, "eqTap": { "type": "string", "enum": [ "pre", "post", "both" ] }, "hideUnpatched": { "type": "boolean" }, "narrowOnOverflow": { "type": "boolean" }, "occupiedPatch": { "type": "string", "enum": [ "warn", "unpatch" ] }, "panelTap": { "type": "string", "enum": [ "pre", "post", "both" ] }, "processingPanel": { "type": "object" }, "sendBus": { "type": "string" }, "theme": { "type": "string", "enum": [ "dark", "hc", "light" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/surface/selection": { "get": { "tags": [ "surface" ], "operationId": "get_surface_selection", "summary": "/surface/selection", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "surface" ], "operationId": "options_surface_selection", "summary": "The live contract for /surface/selection", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "surface" ], "operationId": "patch_surface_selection", "summary": "Update /surface/selection", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/surface/touch/{kind}/{index}": { "get": { "tags": [ "surface" ], "operationId": "get_surface_touch_kind_index", "summary": "/surface/touch/{kind}/{index}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "touched": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "surface" ], "operationId": "options_surface_touch_kind_index", "summary": "The live contract for /surface/touch/{kind}/{index}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "surface" ], "operationId": "patch_surface_touch_kind_index", "summary": "Update /surface/touch/{kind}/{index}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "touched": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "touched": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/telemetry/convergence": { "get": { "tags": [ "telemetry" ], "operationId": "get_telemetry_convergence", "summary": "/telemetry/convergence", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "barrier": { "type": "number", "readOnly": true }, "continuous": { "type": "array", "readOnly": true }, "corrections": { "type": "number", "readOnly": true }, "heartbeatMs": { "type": "number", "readOnly": true }, "revision": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "telemetry" ], "operationId": "options_telemetry_convergence", "summary": "The live contract for /telemetry/convergence", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/telemetry/convergence/corrections": { "get": { "tags": [ "telemetry" ], "operationId": "get_telemetry_convergence_corrections", "summary": "/telemetry/convergence/corrections", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "readOnly": true }, "total": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "telemetry" ], "operationId": "options_telemetry_convergence_corrections", "summary": "The live contract for /telemetry/convergence/corrections", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/telemetry/latency": { "get": { "tags": [ "telemetry" ], "operationId": "get_telemetry_latency", "summary": "/telemetry/latency", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "at": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "telemetry" ], "operationId": "options_telemetry_latency", "summary": "The live contract for /telemetry/latency", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/telemetry/perf": { "get": { "tags": [ "telemetry" ], "operationId": "get_telemetry_perf", "summary": "/telemetry/perf", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "readOnly": true }, "ops": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "telemetry" ], "operationId": "options_telemetry_perf", "summary": "The live contract for /telemetry/perf", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/telemetry/process": { "get": { "tags": [ "telemetry" ], "operationId": "get_telemetry_process", "summary": "/telemetry/process", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "activeResources": { "type": "number", "readOnly": true }, "cpuPercent": { "type": "number", "readOnly": true }, "cpuSystemPercent": { "type": "number", "readOnly": true }, "cpuUserPercent": { "type": "number", "readOnly": true }, "eventLoopLagMaxMs": { "type": "number", "readOnly": true }, "eventLoopLagMeanMs": { "type": "number", "readOnly": true }, "eventLoopLagP99Ms": { "type": "number", "readOnly": true }, "externalMb": { "type": "number", "readOnly": true }, "heapTotalMb": { "type": "number", "readOnly": true }, "heapUsedMb": { "type": "number", "readOnly": true }, "rssMb": { "type": "number", "readOnly": true }, "uptimeS": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "telemetry" ], "operationId": "options_telemetry_process", "summary": "The live contract for /telemetry/process", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/telemetry/rt": { "get": { "tags": [ "telemetry" ], "operationId": "get_telemetry_rt", "summary": "/telemetry/rt", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "telemetry" ], "operationId": "options_telemetry_rt", "summary": "The live contract for /telemetry/rt", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/telemetry/subscription": { "get": { "tags": [ "telemetry" ], "operationId": "get_telemetry_subscription", "summary": "/telemetry/subscription", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "convergence": { "type": "number", "readOnly": true }, "latency": { "type": "number", "readOnly": true }, "meters": { "type": "number", "readOnly": true }, "process": { "type": "number", "readOnly": true }, "rt": { "type": "number", "readOnly": true }, "rtaInstances": { "type": "number", "readOnly": true }, "spectrum": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "telemetry" ], "operationId": "options_telemetry_subscription", "summary": "The live contract for /telemetry/subscription", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/clock": { "get": { "tags": [ "clock" ], "operationId": "get_clock", "summary": "/clock", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "quantum": { "type": "number", "readOnly": true }, "rate": { "type": "number", "readOnly": true }, "supportedRates": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "clock" ], "operationId": "options_clock", "summary": "The live contract for /clock", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/clock/force": { "get": { "tags": [ "clock" ], "operationId": "get_clock_force", "summary": "/clock/force", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rate": { "type": "number", "enum": [ 0, 44100, 48000, 88200, 96000, 176400, 192000 ] }, "rateNotApplied": { "type": "boolean", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "clock" ], "operationId": "options_clock_force", "summary": "The live contract for /clock/force", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "clock" ], "operationId": "patch_clock_force", "summary": "Update /clock/force", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rate": { "type": "number", "enum": [ 0, 44100, 48000, 88200, 96000, 176400, 192000 ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rate": { "type": "number", "enum": [ 0, 44100, 48000, 88200, 96000, 176400, 192000 ] }, "rateNotApplied": { "type": "boolean", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/clock/ownership": { "get": { "tags": [ "clock" ], "operationId": "get_clock_ownership", "summary": "/clock/ownership", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "designatedReference": { "type": "string" }, "freeRunOverride": { "type": "boolean" }, "role": { "type": "string", "enum": [ "master", "follower" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "clock" ], "operationId": "options_clock_ownership", "summary": "The live contract for /clock/ownership", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "clock" ], "operationId": "patch_clock_ownership", "summary": "Update /clock/ownership", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "designatedReference": { "type": "string" }, "freeRunOverride": { "type": "boolean" }, "role": { "type": "string", "enum": [ "master", "follower" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "designatedReference": { "type": "string" }, "freeRunOverride": { "type": "boolean" }, "role": { "type": "string", "enum": [ "master", "follower" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/clock/ownership/reference": { "get": { "tags": [ "clock" ], "operationId": "get_clock_ownership_reference", "summary": "/clock/ownership/reference", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "designated": { "type": "boolean", "readOnly": true }, "eligible": { "type": "boolean", "readOnly": true }, "flagged": { "type": "boolean", "readOnly": true }, "lockDetail": { "type": "string", "readOnly": true }, "override": { "type": "boolean", "readOnly": true }, "paceLocked": { "type": "boolean", "readOnly": true }, "paceOwner": { "type": "string", "readOnly": true }, "rates": { "type": "array", "readOnly": true }, "reason": { "type": "string", "readOnly": true }, "reference": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "clock" ], "operationId": "options_clock_ownership_reference", "summary": "The live contract for /clock/ownership/reference", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/clock/references": { "get": { "tags": [ "clock" ], "operationId": "get_clock_references", "summary": "/clock/references", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "references": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "clock" ], "operationId": "options_clock_references", "summary": "The live contract for /clock/references", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/clock/warnings": { "get": { "tags": [ "clock" ], "operationId": "get_clock_warnings", "summary": "/clock/warnings", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "warnings": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "clock" ], "operationId": "options_clock_warnings", "summary": "The live contract for /clock/warnings", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/history": { "get": { "tags": [ "history" ], "operationId": "get_history", "summary": "/history", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "bound": { "type": "number", "readOnly": true }, "entries": { "type": "array", "readOnly": true }, "undone": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "history" ], "operationId": "options_history", "summary": "The live contract for /history", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/history/cursor": { "get": { "tags": [ "history" ], "operationId": "get_history_cursor", "summary": "/history/cursor", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "canRedo": { "type": "boolean", "readOnly": true }, "canUndo": { "type": "boolean", "readOnly": true }, "depth": { "type": "number", "readOnly": true }, "redoDepth": { "type": "number", "readOnly": true }, "redoId": { "type": "string", "readOnly": true }, "redoLabel": { "type": "string", "readOnly": true }, "undoId": { "type": "string", "readOnly": true }, "undoLabel": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "history" ], "operationId": "options_history_cursor", "summary": "The live contract for /history/cursor", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/history/cursor/redo": { "get": { "tags": [ "history" ], "operationId": "get_history_cursor_redo", "summary": "/history/cursor/redo", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "history" ], "operationId": "options_history_cursor_redo", "summary": "The live contract for /history/cursor/redo", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "history" ], "operationId": "patch_history_cursor_redo", "summary": "Update /history/cursor/redo", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "string" }, "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/history/cursor/undo": { "get": { "tags": [ "history" ], "operationId": "get_history_cursor_undo", "summary": "/history/cursor/undo", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "history" ], "operationId": "options_history_cursor_undo", "summary": "The live contract for /history/cursor/undo", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "history" ], "operationId": "patch_history_cursor_undo", "summary": "Update /history/cursor/undo", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "string" }, "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/history/entries/{id}": { "get": { "tags": [ "history" ], "operationId": "get_history_entries_id", "summary": "/history/entries/{id}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "history" ], "operationId": "options_history_entries_id", "summary": "The live contract for /history/entries/{id}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/history/entries/{id}/revert": { "get": { "tags": [ "history" ], "operationId": "get_history_entries_id_revert", "summary": "/history/entries/{id}/revert", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "history" ], "operationId": "options_history_entries_id_revert", "summary": "The live contract for /history/entries/{id}/revert", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "history" ], "operationId": "patch_history_entries_id_revert", "summary": "Update /history/entries/{id}/revert", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "string" }, "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/rme/totalmix": { "get": { "tags": [ "rme" ], "operationId": "get_rme_totalmix", "summary": "/rme/totalmix", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mainTrimDb": { "type": "number", "minimum": -60, "maximum": 6, "description": "dB" }, "phonesBalanceDb": { "type": "number", "minimum": -6, "maximum": 6, "description": "dB" }, "phonesTrimDb": { "type": "number", "minimum": -60, "maximum": 6, "description": "dB" }, "present": { "type": "boolean", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "rme" ], "operationId": "options_rme_totalmix", "summary": "The live contract for /rme/totalmix", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "rme" ], "operationId": "patch_rme_totalmix", "summary": "Update /rme/totalmix", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mainTrimDb": { "type": "number", "minimum": -60, "maximum": 6, "description": "dB" }, "phonesBalanceDb": { "type": "number", "minimum": -6, "maximum": 6, "description": "dB" }, "phonesTrimDb": { "type": "number", "minimum": -60, "maximum": 6, "description": "dB" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mainTrimDb": { "type": "number", "minimum": -60, "maximum": 6, "description": "dB" }, "phonesBalanceDb": { "type": "number", "minimum": -6, "maximum": 6, "description": "dB" }, "phonesTrimDb": { "type": "number", "minimum": -60, "maximum": 6, "description": "dB" }, "present": { "type": "boolean", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/rme/totalmix/matrix": { "get": { "tags": [ "rme" ], "operationId": "get_rme_totalmix_matrix", "summary": "/rme/totalmix/matrix", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "destinations": { "type": "array", "readOnly": true }, "open": { "type": "object", "readOnly": true }, "present": { "type": "boolean", "readOnly": true }, "sources": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "rme" ], "operationId": "options_rme_totalmix_matrix", "summary": "The live contract for /rme/totalmix/matrix", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/rme/totalmix/matrix/{src}/{dst}": { "get": { "tags": [ "rme" ], "operationId": "get_rme_totalmix_matrix_src_dst", "summary": "/rme/totalmix/matrix/{src}/{dst}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "db": { "type": "number", "minimum": -60, "maximum": 6, "description": "dB" }, "present": { "type": "boolean", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "rme" ], "operationId": "options_rme_totalmix_matrix_src_dst", "summary": "The live contract for /rme/totalmix/matrix/{src}/{dst}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "src", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dst", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "rme" ], "operationId": "patch_rme_totalmix_matrix_src_dst", "summary": "Update /rme/totalmix/matrix/{src}/{dst}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "db": { "type": "number", "minimum": -60, "maximum": 6, "description": "dB" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "db": { "type": "number", "minimum": -60, "maximum": 6, "description": "dB" }, "present": { "type": "boolean", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/rme/totalmix/out/{dst}": { "get": { "tags": [ "rme" ], "operationId": "get_rme_totalmix_out_dst", "summary": "/rme/totalmix/out/{dst}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "db": { "type": "number", "minimum": -60, "maximum": 6, "description": "dB", "readOnly": true }, "present": { "type": "boolean", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "rme" ], "operationId": "options_rme_totalmix_out_dst", "summary": "The live contract for /rme/totalmix/out/{dst}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "dst", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/rme/totalmix/owned": { "get": { "tags": [ "rme" ], "operationId": "get_rme_totalmix_owned", "summary": "/rme/totalmix/owned", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "owned": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "rme" ], "operationId": "options_rme_totalmix_owned", "summary": "The live contract for /rme/totalmix/owned", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "rme" ], "operationId": "patch_rme_totalmix_owned", "summary": "Update /rme/totalmix/owned", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "owned": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "owned": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/rme/totalmix/reassert": { "get": { "tags": [ "rme" ], "operationId": "get_rme_totalmix_reassert", "summary": "/rme/totalmix/reassert", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "rme" ], "operationId": "options_rme_totalmix_reassert", "summary": "The live contract for /rme/totalmix/reassert", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "rme" ], "operationId": "patch_rme_totalmix_reassert", "summary": "Update /rme/totalmix/reassert", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/cue": { "get": { "tags": [ "cue" ], "operationId": "get_cue", "summary": "/cue", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "pfl", "afl", "sip" ] }, "takeover": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "cue" ], "operationId": "options_cue", "summary": "The live contract for /cue", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "cue" ], "operationId": "patch_cue", "summary": "Update /cue", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "pfl", "afl", "sip" ] }, "takeover": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "pfl", "afl", "sip" ] }, "takeover": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/cue/clear": { "get": { "tags": [ "cue" ], "operationId": "get_cue_clear", "summary": "/cue/clear", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "cue" ], "operationId": "options_cue_clear", "summary": "The live contract for /cue/clear", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "cue" ], "operationId": "patch_cue_clear", "summary": "Update /cue/clear", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/cue/monitor": { "get": { "tags": [ "cue" ], "operationId": "get_cue_monitor", "summary": "/cue/monitor", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "output": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "cue" ], "operationId": "options_cue_monitor", "summary": "The live contract for /cue/monitor", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "cue" ], "operationId": "patch_cue_monitor", "summary": "Update /cue/monitor", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "output": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "output": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/cue/monitor/level": { "get": { "tags": [ "cue" ], "operationId": "get_cue_monitor_level", "summary": "/cue/monitor/level", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dim": { "type": "boolean" }, "level": { "type": "number", "minimum": 0, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "cue" ], "operationId": "options_cue_monitor_level", "summary": "The live contract for /cue/monitor/level", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "cue" ], "operationId": "patch_cue_monitor_level", "summary": "Update /cue/monitor/level", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "dim": { "type": "boolean" }, "level": { "type": "number", "minimum": 0, "maximum": 1 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dim": { "type": "boolean" }, "level": { "type": "number", "minimum": 0, "maximum": 1 } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/cue/sip": { "get": { "tags": [ "cue" ], "operationId": "get_cue_sip", "summary": "/cue/sip", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "cue" ], "operationId": "options_cue_sip", "summary": "The live contract for /cue/sip", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "cue" ], "operationId": "patch_cue_sip", "summary": "Update /cue/sip", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/measurement": { "get": { "tags": [ "measurement" ], "operationId": "get_measurement", "summary": "/measurement", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cost": { "type": "object", "readOnly": true }, "latency": { "type": "object", "readOnly": true }, "localOnly": { "type": "number", "readOnly": true }, "localState": { "type": "string", "readOnly": true }, "plugins": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "measurement" ], "operationId": "options_measurement", "summary": "The live contract for /measurement", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/measurement/local": { "get": { "tags": [ "measurement" ], "operationId": "get_measurement_local", "summary": "/measurement/local", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "measurement" ], "operationId": "options_measurement_local", "summary": "The live contract for /measurement/local", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/measurement/plan": { "get": { "tags": [ "measurement" ], "operationId": "get_measurement_plan", "summary": "/measurement/plan", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dimensions": { "type": "array", "readOnly": true }, "droppedRates": { "type": "array", "readOnly": true }, "missingRates": { "type": "object", "readOnly": true }, "pluginCount": { "type": "number", "readOnly": true }, "rates": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "measurement" ], "operationId": "options_measurement_plan", "summary": "The live contract for /measurement/plan", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/measurement/run": { "get": { "tags": [ "measurement" ], "operationId": "get_measurement_run", "summary": "/measurement/run", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dimensions": { "type": "string" }, "force": { "type": "string" }, "label": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "rates": { "type": "string" }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "measurement" ], "operationId": "options_measurement_run", "summary": "The live contract for /measurement/run", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "measurement" ], "operationId": "patch_measurement_run", "summary": "Update /measurement/run", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "dimensions": { "type": "string" }, "force": { "type": "string" }, "label": { "type": "string" }, "rates": { "type": "string" }, "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dimensions": { "type": "string" }, "force": { "type": "string" }, "label": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "rates": { "type": "string" }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/measurement/shipped": { "get": { "tags": [ "measurement" ], "operationId": "get_measurement_shipped", "summary": "/measurement/shipped", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cpuModel": { "type": "string", "readOnly": true }, "dimensions": { "type": "array", "readOnly": true }, "governor": { "type": "string", "readOnly": true }, "host": { "type": "string", "readOnly": true }, "measuredAt": { "type": "string", "readOnly": true }, "plugins": { "type": "number", "readOnly": true }, "rates": { "type": "array", "readOnly": true }, "relativeRankingOnly": { "type": "boolean", "readOnly": true }, "runId": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "measurement" ], "operationId": "options_measurement_shipped", "summary": "The live contract for /measurement/shipped", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/safety": { "get": { "tags": [ "safety" ], "operationId": "get_safety", "summary": "/safety", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "muteGroups": { "type": "array", "readOnly": true }, "panic": { "type": "object", "readOnly": true }, "spares": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "safety" ], "operationId": "options_safety", "summary": "The live contract for /safety", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/safety/loop": { "get": { "tags": [ "safety" ], "operationId": "get_safety_loop", "summary": "/safety/loop", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "loop": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "safety" ], "operationId": "options_safety_loop", "summary": "The live contract for /safety/loop", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/safety/panic": { "get": { "tags": [ "safety" ], "operationId": "get_safety_panic", "summary": "/safety/panic", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "mains", "all" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "safety" ], "operationId": "options_safety_panic", "summary": "The live contract for /safety/panic", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "safety" ], "operationId": "patch_safety_panic", "summary": "Update /safety/panic", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "mains", "all" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "mains", "all" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/safety/panic/targets": { "get": { "tags": [ "safety" ], "operationId": "get_safety_panic_targets", "summary": "/safety/panic/targets", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "allMutesInputs": { "type": "boolean", "readOnly": true }, "mains": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "safety" ], "operationId": "options_safety_panic_targets", "summary": "The live contract for /safety/panic/targets", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/safety/spares/{kind}/{index}": { "get": { "tags": [ "safety" ], "operationId": "get_safety_spares_kind_index", "summary": "/safety/spares/{kind}/{index}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "safety" ], "operationId": "options_safety_spares_kind_index", "summary": "The live contract for /safety/spares/{kind}/{index}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/adapter": { "get": { "tags": [ "adapter" ], "operationId": "get_adapter", "summary": "/adapter", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "adapter" ], "operationId": "options_adapter", "summary": "The live contract for /adapter", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/adapter/{id}": { "get": { "tags": [ "adapter" ], "operationId": "get_adapter_id", "summary": "/adapter/{id}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "adapter" ], "operationId": "options_adapter_id", "summary": "The live contract for /adapter/{id}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/adapter/{id}/settings": { "get": { "tags": [ "adapter" ], "operationId": "get_adapter_id_settings", "summary": "/adapter/{id}/settings", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "adapter" ], "operationId": "options_adapter_id_settings", "summary": "The live contract for /adapter/{id}/settings", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/adapter/{id}/status": { "get": { "tags": [ "adapter" ], "operationId": "get_adapter_id_status", "summary": "/adapter/{id}/status", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "adapter" ], "operationId": "options_adapter_id_status", "summary": "The live contract for /adapter/{id}/status", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/channelConfigs": { "get": { "tags": [ "channelConfigs" ], "operationId": "get_channelConfigs", "summary": "/channelConfigs", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channelConfigs" ], "operationId": "options_channelConfigs", "summary": "The live contract for /channelConfigs", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channelConfigs/{id}": { "get": { "tags": [ "channelConfigs" ], "operationId": "get_channelConfigs_id", "summary": "/channelConfigs/{id}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channelConfigs" ], "operationId": "options_channelConfigs_id", "summary": "The live contract for /channelConfigs/{id}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/channelConfigs/{id}/apply/{kind}/{index}": { "get": { "tags": [ "channelConfigs" ], "operationId": "get_channelConfigs_id_apply_kind_index", "summary": "/channelConfigs/{id}/apply/{kind}/{index}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channelConfigs" ], "operationId": "options_channelConfigs_id_apply_kind_index", "summary": "The live contract for /channelConfigs/{id}/apply/{kind}/{index}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "channelConfigs" ], "operationId": "patch_channelConfigs_id_apply_kind_index", "summary": "Update /channelConfigs/{id}/apply/{kind}/{index}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm": { "type": "string" }, "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/channelConfigs/{id}/applyMoves/{kind}/{index}": { "get": { "tags": [ "channelConfigs" ], "operationId": "get_channelConfigs_id_applyMoves_kind_index", "summary": "/channelConfigs/{id}/applyMoves/{kind}/{index}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "channelConfigs" ], "operationId": "options_channelConfigs_id_applyMoves_kind_index", "summary": "The live contract for /channelConfigs/{id}/applyMoves/{kind}/{index}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "/api/discovery/device/{protocol}/{id}/adapter": { "get": { "tags": [ "discovery" ], "operationId": "get_discovery_device_protocol_id_adapter", "summary": "/discovery/device/{protocol}/{id}/adapter", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "discovery" ], "operationId": "options_discovery_device_protocol_id_adapter", "summary": "The live contract for /discovery/device/{protocol}/{id}/adapter", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "protocol", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/discovery/devices": { "get": { "tags": [ "discovery" ], "operationId": "get_discovery_devices", "summary": "/discovery/devices", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "discovery" ], "operationId": "options_discovery_devices", "summary": "The live contract for /discovery/devices", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/discovery/probe/{protocol}/{scope}": { "get": { "tags": [ "discovery" ], "operationId": "get_discovery_probe_protocol_scope", "summary": "/discovery/probe/{protocol}/{scope}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "discovery" ], "operationId": "options_discovery_probe_protocol_scope", "summary": "The live contract for /discovery/probe/{protocol}/{scope}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "protocol", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/discovery/scan": { "get": { "tags": [ "discovery" ], "operationId": "get_discovery_scan", "summary": "/discovery/scan", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "discovery" ], "operationId": "options_discovery_scan", "summary": "The live contract for /discovery/scan", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "discovery" ], "operationId": "patch_discovery_scan", "summary": "Update /discovery/scan", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/scenes": { "get": { "tags": [ "scenes" ], "operationId": "get_scenes", "summary": "/scenes", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "scenes" ], "operationId": "options_scenes", "summary": "The live contract for /scenes", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/scenes/{id}": { "get": { "tags": [ "scenes" ], "operationId": "get_scenes_id", "summary": "/scenes/{id}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "scenes" ], "operationId": "options_scenes_id", "summary": "The live contract for /scenes/{id}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/scenes/{id}/recall": { "get": { "tags": [ "scenes" ], "operationId": "get_scenes_id_recall", "summary": "/scenes/{id}/recall", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "scenes" ], "operationId": "options_scenes_id_recall", "summary": "The live contract for /scenes/{id}/recall", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "scenes" ], "operationId": "patch_scenes_id_recall", "summary": "Update /scenes/{id}/recall", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/scenes/{id}/recallKeeps": { "get": { "tags": [ "scenes" ], "operationId": "get_scenes_id_recallKeeps", "summary": "/scenes/{id}/recallKeeps", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "scenes" ], "operationId": "options_scenes_id_recallKeeps", "summary": "The live contract for /scenes/{id}/recallKeeps", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/sessions": { "get": { "tags": [ "sessions" ], "operationId": "get_sessions", "summary": "/sessions", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "sessions" ], "operationId": "options_sessions", "summary": "The live contract for /sessions", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/sessions/{id}": { "get": { "tags": [ "sessions" ], "operationId": "get_sessions_id", "summary": "/sessions/{id}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "sessions" ], "operationId": "options_sessions_id", "summary": "The live contract for /sessions/{id}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/sessions/{id}/apply": { "get": { "tags": [ "sessions" ], "operationId": "get_sessions_id_apply", "summary": "/sessions/{id}/apply", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "sessions" ], "operationId": "options_sessions_id_apply", "summary": "The live contract for /sessions/{id}/apply", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "sessions" ], "operationId": "patch_sessions_id_apply", "summary": "Update /sessions/{id}/apply", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/sessions/{id}/applyKeeps": { "get": { "tags": [ "sessions" ], "operationId": "get_sessions_id_applyKeeps", "summary": "/sessions/{id}/applyKeeps", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "sessions" ], "operationId": "options_sessions_id_applyKeeps", "summary": "The live contract for /sessions/{id}/applyKeeps", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/source": { "get": { "tags": [ "source" ], "operationId": "get_source", "summary": "/source", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sources": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "source" ], "operationId": "options_source", "summary": "The live contract for /source", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/source/{id}": { "get": { "tags": [ "source" ], "operationId": "get_source_id", "summary": "/source/{id}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "adapterId": { "type": "string" }, "icon": { "type": "string" }, "input": { "type": "string" }, "name": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "source" ], "operationId": "options_source_id", "summary": "The live contract for /source/{id}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "source" ], "operationId": "patch_source_id", "summary": "Update /source/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "adapterId": { "type": "string" }, "icon": { "type": "string" }, "input": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "adapterId": { "type": "string" }, "icon": { "type": "string" }, "input": { "type": "string" }, "name": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/source/{id}/headAmp": { "get": { "tags": [ "source" ], "operationId": "get_source_id_headAmp", "summary": "/source/{id}/headAmp", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "source" ], "operationId": "options_source_id_headAmp", "summary": "The live contract for /source/{id}/headAmp", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/source/{id}/patch": { "get": { "tags": [ "source" ], "operationId": "get_source_id_patch", "summary": "/source/{id}/patch", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "adapterId": { "type": "string", "readOnly": true }, "input": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "source" ], "operationId": "options_source_id_patch", "summary": "The live contract for /source/{id}/patch", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/takes": { "get": { "tags": [ "takes" ], "operationId": "get_takes", "summary": "/takes", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "takes" ], "operationId": "options_takes", "summary": "The live contract for /takes", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/takes/{id}": { "get": { "tags": [ "takes" ], "operationId": "get_takes_id", "summary": "/takes/{id}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "takes" ], "operationId": "options_takes_id", "summary": "The live contract for /takes/{id}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/takes/{id}/export": { "get": { "tags": [ "takes" ], "operationId": "get_takes_id_export", "summary": "/takes/{id}/export", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "takes" ], "operationId": "options_takes_id_export", "summary": "The live contract for /takes/{id}/export", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "takes" ], "operationId": "patch_takes_id_export", "summary": "Update /takes/{id}/export", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/takes/{id}/render": { "get": { "tags": [ "takes" ], "operationId": "get_takes_id_render", "summary": "/takes/{id}/render", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true }, "tracks": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "takes" ], "operationId": "options_takes_id_render", "summary": "The live contract for /takes/{id}/render", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "takes" ], "operationId": "patch_takes_id_render", "summary": "Update /takes/{id}/render", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "string" }, "running": { "type": "boolean" }, "tracks": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "string" }, "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true }, "tracks": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/net/binding": { "get": { "tags": [ "net" ], "operationId": "get_net_binding", "summary": "/net/binding", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "host": { "type": "string", "readOnly": true }, "port": { "type": "number", "readOnly": true }, "sources": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "net" ], "operationId": "options_net_binding", "summary": "The live contract for /net/binding", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/net/interfaces": { "get": { "tags": [ "net" ], "operationId": "get_net_interfaces", "summary": "/net/interfaces", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "interfaces": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "net" ], "operationId": "options_net_interfaces", "summary": "The live contract for /net/interfaces", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/net/overrides": { "get": { "tags": [ "net" ], "operationId": "get_net_overrides", "summary": "/net/overrides", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "appliesOnRestart": { "type": "boolean", "readOnly": true }, "host": { "type": "string" }, "port": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "net" ], "operationId": "options_net_overrides", "summary": "The live contract for /net/overrides", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "net" ], "operationId": "patch_net_overrides", "summary": "Update /net/overrides", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "appliesOnRestart": { "type": "boolean", "readOnly": true }, "host": { "type": "string" }, "port": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patch/input/{kind}/{index}": { "get": { "tags": [ "patch" ], "operationId": "get_patch_input_kind_index", "summary": "/patch/input/{kind}/{index}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "endpoints": { "type": "array" }, "sourceRef": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patch" ], "operationId": "options_patch_input_kind_index", "summary": "The live contract for /patch/input/{kind}/{index}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "patch" ], "operationId": "patch_patch_input_kind_index", "summary": "Update /patch/input/{kind}/{index}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "endpoints": { "type": "array" }, "sourceRef": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "endpoints": { "type": "array" }, "sourceRef": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patch/output/{kind}/{index}": { "get": { "tags": [ "patch" ], "operationId": "get_patch_output_kind_index", "summary": "/patch/output/{kind}/{index}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "legs": { "type": "array" }, "locked": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patch" ], "operationId": "options_patch_output_kind_index", "summary": "The live contract for /patch/output/{kind}/{index}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "patch": { "tags": [ "patch" ], "operationId": "patch_patch_output_kind_index", "summary": "Update /patch/output/{kind}/{index}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "legs": { "type": "array" }, "locked": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "legs": { "type": "array" }, "locked": { "type": "boolean" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patch/output/{kind}/{index}/leg/{legId}": { "get": { "tags": [ "patch" ], "operationId": "get_patch_output_kind_index_leg_legId", "summary": "/patch/output/{kind}/{index}/leg/{legId}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "L": { "type": "string" }, "R": { "type": "string" }, "delayMs": { "type": "number", "minimum": 0, "maximum": 1000, "description": "step 1, ms" }, "monoFoldDb": { "type": "number", "minimum": -12, "maximum": 0, "description": "step 1, dB" }, "mute": { "type": "boolean" }, "trimDb": { "type": "number", "minimum": -40, "maximum": 12, "description": "step 1, dB" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patch" ], "operationId": "options_patch_output_kind_index_leg_legId", "summary": "The live contract for /patch/output/{kind}/{index}/leg/{legId}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "input", "fxReturn", "aux", "mix", "matrix", "cue", "main", "fxSend", "dca", "muteGroup", "mixMinus" ] } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "legId", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "patch" ], "operationId": "patch_patch_output_kind_index_leg_legId", "summary": "Update /patch/output/{kind}/{index}/leg/{legId}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "L": { "type": "string" }, "R": { "type": "string" }, "delayMs": { "type": "number", "minimum": 0, "maximum": 1000, "description": "step 1, ms" }, "monoFoldDb": { "type": "number", "minimum": -12, "maximum": 0, "description": "step 1, dB" }, "mute": { "type": "boolean" }, "trimDb": { "type": "number", "minimum": -40, "maximum": 12, "description": "step 1, dB" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "L": { "type": "string" }, "R": { "type": "string" }, "delayMs": { "type": "number", "minimum": 0, "maximum": 1000, "description": "step 1, ms" }, "monoFoldDb": { "type": "number", "minimum": -12, "maximum": 0, "description": "step 1, dB" }, "mute": { "type": "boolean" }, "trimDb": { "type": "number", "minimum": -40, "maximum": 12, "description": "step 1, dB" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patches": { "get": { "tags": [ "patches" ], "operationId": "get_patches", "summary": "/patches", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patches" ], "operationId": "options_patches", "summary": "The live contract for /patches", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/patches/{id}": { "get": { "tags": [ "patches" ], "operationId": "get_patches_id", "summary": "/patches/{id}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patches" ], "operationId": "options_patches_id", "summary": "The live contract for /patches/{id}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/patches/{id}/apply": { "get": { "tags": [ "patches" ], "operationId": "get_patches_id_apply", "summary": "/patches/{id}/apply", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "patches" ], "operationId": "options_patches_id_apply", "summary": "The live contract for /patches/{id}/apply", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "patches" ], "operationId": "patch_patches_id_apply", "summary": "Update /patches/{id}/apply", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/record": { "get": { "tags": [ "record" ], "operationId": "get_record", "summary": "/record", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "armedCount": { "type": "number", "readOnly": true }, "phase": { "type": "string", "readOnly": true }, "positionFrames": { "type": "number", "readOnly": true }, "rate": { "type": "number", "readOnly": true }, "startedAt": { "type": "number", "readOnly": true }, "takeId": { "type": "string", "readOnly": true }, "xruns": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "record" ], "operationId": "options_record", "summary": "The live contract for /record", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/record/start": { "get": { "tags": [ "record" ], "operationId": "get_record_start", "summary": "/record/start", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "record" ], "operationId": "options_record_start", "summary": "The live contract for /record/start", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "record" ], "operationId": "patch_record_start", "summary": "Update /record/start", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/record/stop": { "get": { "tags": [ "record" ], "operationId": "get_record_stop", "summary": "/record/stop", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "record" ], "operationId": "options_record_stop", "summary": "The live contract for /record/stop", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "record" ], "operationId": "patch_record_stop", "summary": "Update /record/stop", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/adapterType": { "get": { "tags": [ "adapterType" ], "operationId": "get_adapterType", "summary": "/adapterType", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "adapterType" ], "operationId": "options_adapterType", "summary": "The live contract for /adapterType", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/adapterType/{type}": { "get": { "tags": [ "adapterType" ], "operationId": "get_adapterType_type", "summary": "/adapterType/{type}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "adapterType" ], "operationId": "options_adapterType_type", "summary": "The live contract for /adapterType/{type}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/clipboard/{slot}": { "get": { "tags": [ "clipboard" ], "operationId": "get_clipboard_slot", "summary": "/clipboard/{slot}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "names": { "type": "array", "readOnly": true }, "parts": { "type": "string", "enum": [ "dynamics", "processing", "strip", "eq", "gate", "comp", "chain", "trim", "mix", "sends", "label" ] }, "sources": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "clipboard" ], "operationId": "options_clipboard_slot", "summary": "The live contract for /clipboard/{slot}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "slot", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "clipboard" ], "operationId": "patch_clipboard_slot", "summary": "Update /clipboard/{slot}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "parts": { "type": "string", "enum": [ "dynamics", "processing", "strip", "eq", "gate", "comp", "chain", "trim", "mix", "sends", "label" ] }, "sources": { "type": "array" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "names": { "type": "array", "readOnly": true }, "parts": { "type": "string", "enum": [ "dynamics", "processing", "strip", "eq", "gate", "comp", "chain", "trim", "mix", "sends", "label" ] }, "sources": { "type": "array" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/clipboard/{slot}/paste": { "get": { "tags": [ "clipboard" ], "operationId": "get_clipboard_slot_paste", "summary": "/clipboard/{slot}/paste", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "parts": { "type": "string" }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true }, "targets": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "clipboard" ], "operationId": "options_clipboard_slot_paste", "summary": "The live contract for /clipboard/{slot}/paste", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "slot", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "clipboard" ], "operationId": "patch_clipboard_slot_paste", "summary": "Update /clipboard/{slot}/paste", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "parts": { "type": "string" }, "running": { "type": "boolean" }, "targets": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "parts": { "type": "string" }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true }, "targets": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/plugins": { "get": { "tags": [ "plugins" ], "operationId": "get_plugins", "summary": "/plugins", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "plugins": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "plugins" ], "operationId": "options_plugins", "summary": "The live contract for /plugins", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/plugins/{uri}": { "get": { "tags": [ "plugins" ], "operationId": "get_plugins_uri", "summary": "/plugins/{uri}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "audioInputs": { "type": "number", "readOnly": true }, "audioOutputs": { "type": "number", "readOnly": true }, "family": { "type": "string", "readOnly": true }, "hasMidiIn": { "type": "boolean", "readOnly": true }, "label": { "type": "string", "readOnly": true }, "latencyClass": { "type": "string", "readOnly": true }, "lv2Class": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "notForLive": { "type": "boolean", "readOnly": true }, "params": { "type": "array", "readOnly": true }, "points": { "type": "array", "readOnly": true }, "role": { "type": "string", "readOnly": true }, "uri": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "plugins" ], "operationId": "options_plugins_uri", "summary": "The live contract for /plugins/{uri}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "uri", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/reac/segment": { "get": { "tags": [ "reac" ], "operationId": "get_reac_segment", "summary": "/reac/segment", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "reac" ], "operationId": "options_reac_segment", "summary": "The live contract for /reac/segment", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/reac/segment/{name}": { "get": { "tags": [ "reac" ], "operationId": "get_reac_segment_name", "summary": "/reac/segment/{name}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "reac" ], "operationId": "options_reac_segment_name", "summary": "The live contract for /reac/segment/{name}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/stagebox": { "get": { "tags": [ "stagebox" ], "operationId": "get_stagebox", "summary": "/stagebox", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "boxes": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "stagebox" ], "operationId": "options_stagebox", "summary": "The live contract for /stagebox", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/stagebox/{boxId}": { "get": { "tags": [ "stagebox" ], "operationId": "get_stagebox_boxId", "summary": "/stagebox/{boxId}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "model": { "type": "string", "readOnly": true }, "name": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "stagebox" ], "operationId": "options_stagebox_boxId", "summary": "The live contract for /stagebox/{boxId}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "boxId", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "stagebox" ], "operationId": "patch_stagebox_boxId", "summary": "Update /stagebox/{boxId}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "model": { "type": "string", "readOnly": true }, "name": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/talkback/generator/{generator}": { "get": { "tags": [ "talkback" ], "operationId": "get_talkback_generator_generator", "summary": "/talkback/generator/{generator}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "freqHz": { "type": "number", "minimum": 20, "maximum": 20000 }, "level": { "type": "number", "minimum": 0, "maximum": 1 }, "node": { "type": "string", "readOnly": true }, "route": { "type": "string" }, "running": { "type": "boolean" }, "waveform": { "type": "string", "enum": [ "sine", "square", "saw", "triangle" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "talkback" ], "operationId": "options_talkback_generator_generator", "summary": "The live contract for /talkback/generator/{generator}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "generator", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "tags": [ "talkback" ], "operationId": "patch_talkback_generator_generator", "summary": "Update /talkback/generator/{generator}", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "freqHz": { "type": "number", "minimum": 20, "maximum": 20000 }, "level": { "type": "number", "minimum": 0, "maximum": 1 }, "route": { "type": "string" }, "running": { "type": "boolean" }, "waveform": { "type": "string", "enum": [ "sine", "square", "saw", "triangle" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "freqHz": { "type": "number", "minimum": 20, "maximum": 20000 }, "level": { "type": "number", "minimum": 0, "maximum": 1 }, "node": { "type": "string", "readOnly": true }, "route": { "type": "string" }, "running": { "type": "boolean" }, "waveform": { "type": "string", "enum": [ "sine", "square", "saw", "triangle" ] } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/talkback/mic": { "get": { "tags": [ "talkback" ], "operationId": "get_talkback_mic", "summary": "/talkback/mic", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "route": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "talkback" ], "operationId": "options_talkback_mic", "summary": "The live contract for /talkback/mic", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "talkback" ], "operationId": "patch_talkback_mic", "summary": "Update /talkback/mic", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "route": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "route": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/vsc": { "get": { "tags": [ "vsc" ], "operationId": "get_vsc", "summary": "/vsc", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "convertBytes": { "type": "number", "readOnly": true }, "convertTotalBytes": { "type": "number", "readOnly": true }, "engaged": { "type": "boolean" }, "engagedCount": { "type": "number", "readOnly": true }, "finding": { "type": "string", "readOnly": true }, "graphRate": { "type": "number", "readOnly": true }, "lengthFrames": { "type": "number", "readOnly": true }, "phase": { "type": "string", "readOnly": true }, "playing": { "type": "boolean" }, "positionFrames": { "type": "number", "minimum": 0, "maximum": 16588800000 }, "progress": { "type": "number", "readOnly": true }, "rate": { "type": "number", "readOnly": true }, "skippedEmpty": { "type": "array", "readOnly": true }, "takeId": { "type": "string" }, "takeRate": { "type": "number", "readOnly": true }, "trackCount": { "type": "number", "readOnly": true }, "underruns": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "vsc" ], "operationId": "options_vsc", "summary": "The live contract for /vsc", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "vsc" ], "operationId": "patch_vsc", "summary": "Update /vsc", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "engaged": { "type": "boolean" }, "playing": { "type": "boolean" }, "positionFrames": { "type": "number", "minimum": 0, "maximum": 16588800000 }, "takeId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "convertBytes": { "type": "number", "readOnly": true }, "convertTotalBytes": { "type": "number", "readOnly": true }, "engaged": { "type": "boolean" }, "engagedCount": { "type": "number", "readOnly": true }, "finding": { "type": "string", "readOnly": true }, "graphRate": { "type": "number", "readOnly": true }, "lengthFrames": { "type": "number", "readOnly": true }, "phase": { "type": "string", "readOnly": true }, "playing": { "type": "boolean" }, "positionFrames": { "type": "number", "minimum": 0, "maximum": 16588800000 }, "progress": { "type": "number", "readOnly": true }, "rate": { "type": "number", "readOnly": true }, "skippedEmpty": { "type": "array", "readOnly": true }, "takeId": { "type": "string" }, "takeRate": { "type": "number", "readOnly": true }, "trackCount": { "type": "number", "readOnly": true }, "underruns": { "type": "number", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/vsc/eject": { "get": { "tags": [ "vsc" ], "operationId": "get_vsc_eject", "summary": "/vsc/eject", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "vsc" ], "operationId": "options_vsc_eject", "summary": "The live contract for /vsc/eject", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "patch": { "tags": [ "vsc" ], "operationId": "patch_vsc_eject", "summary": "Update /vsc/eject", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "running": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The row after the write.", "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "readOnly": true }, "progress": { "type": "string", "readOnly": true }, "refusal": { "type": "string", "readOnly": true }, "report": { "type": "string", "readOnly": true }, "running": { "type": "boolean" }, "startedAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/directPath/{source}": { "get": { "tags": [ "directPath" ], "operationId": "get_directPath_source", "summary": "/directPath/{source}", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "directPath" ], "operationId": "options_directPath_source", "summary": "The live contract for /directPath/{source}", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/hardware/missing": { "get": { "tags": [ "hardware" ], "operationId": "get_hardware_missing", "summary": "/hardware/missing", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "missing": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "hardware" ], "operationId": "options_hardware_missing", "summary": "The live contract for /hardware/missing", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/meters": { "get": { "tags": [ "meters" ], "operationId": "get_meters", "summary": "/meters", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first. Computes only while at least one client is watching it (`?watch=1`); otherwise idle.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "at": { "type": "number", "readOnly": true }, "channels": { "type": "array", "readOnly": true }, "compGr": { "type": "string", "readOnly": true }, "gateGr": { "type": "string", "readOnly": true }, "level": { "type": "string", "readOnly": true }, "loudness": { "type": "object", "readOnly": true }, "right": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "meters" ], "operationId": "options_meters", "summary": "The live contract for /meters", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/scene/current": { "get": { "tags": [ "scene" ], "operationId": "get_scene_current", "summary": "/scene/current", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "recalledAt": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "scene" ], "operationId": "options_scene_current", "summary": "The live contract for /scene/current", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/session/current": { "get": { "tags": [ "session" ], "operationId": "get_session_current", "summary": "/session/current", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "session" ], "operationId": "options_session_current", "summary": "The live contract for /session/current", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/stageboxModel": { "get": { "tags": [ "stageboxModel" ], "operationId": "get_stageboxModel", "summary": "/stageboxModel", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "models": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "stageboxModel" ], "operationId": "options_stageboxModel", "summary": "The live contract for /stageboxModel", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } }, "/api/streams/{id}/demand": { "get": { "tags": [ "streams" ], "operationId": "get_streams_id_demand", "summary": "/streams/{id}/demand", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "streams" ], "operationId": "options_streams_id_demand", "summary": "The live contract for /streams/{id}/demand", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/api/warnings": { "get": { "tags": [ "warnings" ], "operationId": "get_warnings", "summary": "/warnings", "x-sse-watchable": true, "description": "Add `?watch=1` to follow this row live over server-sent events, snapshot first.", "responses": { "200": { "description": "The row’s current value.", "content": { "application/json": { "schema": { "type": "object", "properties": { "resolved": { "type": "array", "readOnly": true }, "warnings": { "type": "array", "readOnly": true } } } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } }, "options": { "tags": [ "warnings" ], "operationId": "options_warnings", "summary": "The live contract for /warnings", "description": "Publishes this row’s writable fields, ranges and enumerated options as the server currently serves them — the authority this generated document mirrors at build time, not a substitute for asking the running console.", "responses": { "200": { "description": "The row’s live contract.", "content": { "application/json": { "schema": { "type": "object" } } } }, "4XX": { "$ref": "#/components/responses/Refusal" } } } } }, "components": { "schemas": { "RefusalCode": { "type": "string", "enum": [ "no-state-dir", "takeover-unsupported", "no-stagebox-registry", "invalid-message", "sip-disarmed", "sip-needs-confirm", "stagebox.assign.unknown-device", "stagebox.assign.no-such-side", "stagebox.assign.clear-outputs-unsupported", "stagebox.assign.bad-start-channel", "stagebox.assign.exceeds-box-width", "stagebox.assign.exceeds-audio-fabric", "insert.latency.exceeds-budget", "insert.latency.may-exceed-budget", "insert.latency.unknown-at-rate", "insert.latency.within-budget", "rt.budget", "measurement.engine-live", "measurement.already-running", "measurement.no-rates", "measurement.nothing-local", "plugins.instances-exhausted", "record.already-running", "record.nothing-armed", "record.no-space", "record.no-engine", "record.rate-unknown", "render.no-engine", "render.no-tracks", "render.no-space", "render.already-running", "export.no-engine", "export.no-main", "export.empty", "export.unreadable", "export.no-space", "export.already-running", "render.recording", "render.playback", "record.vsc-active", "vsc.no-take", "vsc.no-track", "vsc.rate-mismatch", "vsc.recording", "vsc.no-such-take", "vsc.take-unplayable", "vsc.no-engine", "vsc.not-engaged", "discovery.blind.link", "discovery.blind.global", "discovery.reac.nic-enumeration-failed", "discovery.reac.passive-listen-failed", "discovery.reac.active-probe-failed", "discovery.reac.link-busy", "discovery.reac.active-probe-no-reason", "discovery.reac.registry-unloaded", "discovery.reac.not-publishing", "discovery.reac.predates-discovery", "discovery.reac.unknown-state", "discovery.reac.unparseable", "discovery.reac.stale", "discovery.reac.not-listening-here", "clock.no-owner.title", "clock.no-owner.detail", "clock.two-owners.title", "clock.two-owners.detail", "clock.unqualified-master.title", "clock.synthetic-driver.title", "clock.synthetic-driver.detail", "xrun.growing.title", "xrun.growing.detail.raise", "xrun.growing.detail.raise-holder", "xrun.growing.detail.relax", "xrun.growing.detail.unknown", "hardware.missing.summary", "hardware.missing.clause-separator", "hardware.missing.input-patches", "hardware.missing.output-routes", "hardware.missing.no-patches", "hardware.missing.configured-on", "hardware.missing.not-connected", "hardware.missing.bridge-down", "hardware.missing.surface", "hardware.contradiction.model", "hardware.contradiction.width", "hardware.contradiction.channels", "feedback.loop.no-cuttable-edge", "undo.label.route", "undo.label.bpm", "undo.label.stripOrder", "undo.label.gate", "undo.label.delay", "undo.label.reverb", "undo.label.eq", "undo.label.paste", "undo.label.send", "undo.label.set.fader", "undo.label.set.gain", "undo.label.set.pan", "undo.label.set.trim", "undo.label.set.phantom", "undo.label.set.polarity", "undo.label.set.align", "undo.label.set.name", "undo.label.set.colour", "undo.label.set.instrument" ], "description": "Every refusal, warning and undo-label code the server can send.\n\n**server refusals (shipped wire codes — do not rename)**: `no-state-dir`, `takeover-unsupported`, `no-stagebox-registry`, `invalid-message`, `sip-disarmed`, `sip-needs-confirm`\n\n**stagebox bulk-assignment refusals (core `StageboxAssignError`)**: `stagebox.assign.unknown-device`, `stagebox.assign.no-such-side`, `stagebox.assign.clear-outputs-unsupported`, `stagebox.assign.bad-start-channel`, `stagebox.assign.exceeds-box-width`, `stagebox.assign.exceeds-audio-fabric`\n\n**insert latency-budget findings (core `judgeChainLatency`)**: `insert.latency.exceeds-budget`, `insert.latency.may-exceed-budget`, `insert.latency.unknown-at-rate`, `insert.latency.within-budget`\n\n**engine real-time headroom**: `rt.budget`\n\n**plugin analysis (issue #342)**: `measurement.engine-live`, `measurement.already-running`, `measurement.no-rates`, `measurement.nothing-local`\n\n**the plugin host's instance table (audio-engine `ModHostClient`)**: `plugins.instances-exhausted`\n\n**multitrack record (2026-07-16-recording-vsc.md §2.3)**: `record.already-running`, `record.nothing-armed`, `record.no-space`, `record.no-engine`, `record.rate-unknown`\n\n**the offline HRP render (2026-07-16-recording-vsc.md §0.5)**: `render.no-engine`, `render.no-tracks`, `render.no-space`, `render.already-running`\n\n**the MAIN print export (2026-07-16-recording-vsc.md §0.6)**: `export.no-engine`, `export.no-main`, `export.empty`, `export.unreadable`, `export.no-space`, `export.already-running`, `render.recording`, `render.playback`, `record.vsc-active`\n\n**virtual soundcheck (2026-07-16-recording-vsc.md §3)**: `vsc.no-take`, `vsc.no-track`, `vsc.rate-mismatch`, `vsc.recording`, `vsc.no-such-take`, `vsc.take-unplayable`, `vsc.no-engine`, `vsc.not-engaged`\n\n**discovery blindness: the headline**: `discovery.blind.link`, `discovery.blind.global`\n\n**discovery blindness: why (REAC raw-socket prober)**: `discovery.reac.nic-enumeration-failed`, `discovery.reac.passive-listen-failed`, `discovery.reac.active-probe-failed`, `discovery.reac.link-busy`, `discovery.reac.active-probe-no-reason`\n\n**discovery blindness: why (reac-pw property prober)**: `discovery.reac.registry-unloaded`, `discovery.reac.not-publishing`, `discovery.reac.predates-discovery`, `discovery.reac.unknown-state`, `discovery.reac.unparseable`, `discovery.reac.stale`, `discovery.reac.not-listening-here`\n\n**clock cross-checks (Setup → Clock, and the warnings badge)**: `clock.no-owner.title`, `clock.no-owner.detail`, `clock.two-owners.title`, `clock.two-owners.detail`, `clock.unqualified-master.title`, `clock.synthetic-driver.title`, `clock.synthetic-driver.detail`\n\n**xrun cross-checks (issue #657: warn, with numbers, never block)**: `xrun.growing.title`, `xrun.growing.detail.raise`, `xrun.growing.detail.raise-holder`, `xrun.growing.detail.relax`, `xrun.growing.detail.unknown`\n\n**absent hardware after a session restore**: `hardware.missing.summary`, `hardware.missing.clause-separator`, `hardware.missing.input-patches`, `hardware.missing.output-routes`, `hardware.missing.no-patches`, `hardware.missing.configured-on`, `hardware.missing.not-connected`, `hardware.missing.bridge-down`, `hardware.missing.surface`\n\n**a stored value contradicted by the hardware itself**: `hardware.contradiction.model`, `hardware.contradiction.width`, `hardware.contradiction.channels`\n\n**routing loops (howl-round topology, issue #378)**: `feedback.loop.no-cuttable-edge`\n\n**undo / redo entry labels**: `undo.label.route`, `undo.label.bpm`, `undo.label.stripOrder`, `undo.label.gate`, `undo.label.delay`, `undo.label.reverb`, `undo.label.eq`, `undo.label.paste`, `undo.label.send`\n\n**Undo — per-parameter labels**: `undo.label.set.fader`, `undo.label.set.gain`, `undo.label.set.pan`, `undo.label.set.trim`, `undo.label.set.phantom`, `undo.label.set.polarity`, `undo.label.set.align`, `undo.label.set.name`, `undo.label.set.colour`, `undo.label.set.instrument`" }, "CodedRefusal": { "type": "object", "required": [ "code", "params" ], "properties": { "code": { "$ref": "#/components/schemas/RefusalCode" }, "params": { "type": "object", "description": "Named, wire-serialisable scalars only — the exact fields the code’s localised sentence interpolates. Shape varies per code; see the code’s own description." } } } }, "responses": { "Refusal": { "description": "A structured refusal: a stable code plus the parameters its sentence needs. The client renders the code in its own locale rather than reading display prose from the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodedRefusal" } } } } } } }