{ "openapi": "3.1.0", "info": { "title": "D-Cine Player complete native TMS API", "version": "4.2.30", "description": "Native programming, playback, queue and audit contract. Capability and licence negotiation required. Future encrypted preflight remains pending; no DCI or secure-log certification claim." }, "servers": [ { "url": "http://{host}:8080", "variables": { "host": { "default": "127.0.0.1" } } } ], "paths": { "/api/player/v1/audit/exports": { "post": { "operationId": "createAuditExport", "description": "Requires audit.export. Persist an Idempotency-Key per principal. Freeze identity, sequence fence and coverage before HTTP 202. Ranges are half-open, at most 86400 elapsed seconds, ending no later than now. Only completed jobs publish documents.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 256 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditExportRequest" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Permission required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown job/document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency/journal/retention conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Expired export", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Range too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Export queue full; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Journal unavailable; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "202": { "description": "Immutable acceptance identity, progress, coverage and manifest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditExport" } } } }, "200": { "description": "Immutable acceptance identity, progress, coverage and manifest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditExport" } } } } }, "security": [ { "BearerAuth": [] }, { "APIKey": [] }, { "LoginSession": [] } ] } }, "/api/player/v1/audit/exports/{export_id}": { "get": { "operationId": "getAuditExport", "description": "Requires audit.read and the creating principal. A different principal receives 404.", "parameters": [ { "name": "export_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Permission required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown job/document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency/journal/retention conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Expired export", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Range too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Export queue full; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Journal unavailable; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Immutable acceptance identity, progress, coverage and manifest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditExport" } } } } }, "security": [ { "BearerAuth": [] }, { "APIKey": [] }, { "LoginSession": [] } ] } }, "/api/player/v1/audit/exports/{export_id}/documents/{document_id}": { "get": { "operationId": "downloadAuditDocument", "description": "Requires audit.read and creating principal. UTF-8 NDJSON with final newline, Content-Length and sha256-derived ETag. Files remain immutable for at least 24 hours after completion.", "parameters": [ { "name": "export_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Permission required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown job/document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency/journal/retention conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Expired export", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Range too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Export queue full; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Journal unavailable; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Audit records", "headers": { "Content-Length": { "schema": { "type": "integer" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/x-ndjson": { "schema": { "type": "string", "description": "One AuditEvent JSON object per line, final newline." } } } } }, "security": [ { "BearerAuth": [] }, { "APIKey": [] }, { "LoginSession": [] } ] } }, "/api/player/v1/audit/journal": { "get": { "operationId": "getAuditJournal", "description": "Requires audit.read. Recording coverage, retention, persistent identities and health.", "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Permission required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown job/document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency/journal/retention conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Expired export", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Range too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Export queue full; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Journal unavailable; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Journal metadata", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "BearerAuth": [] }, { "APIKey": [] }, { "LoginSession": [] } ] } }, "/api/player/v1/audit/retention": { "put": { "operationId": "setAuditRetention", "description": "Requires audit.export and config.write. Applies retained policy; hourly pruning waits for active export snapshots.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "retention_days" ], "properties": { "retention_days": { "type": "integer", "minimum": 1, "maximum": 3650 } } } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Permission required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown job/document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency/journal/retention conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Expired export", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Range too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Export queue full; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Journal unavailable; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Updated journal metadata" } }, "security": [ { "BearerAuth": [] }, { "APIKey": [] }, { "LoginSession": [] } ] } }, "/api/player/v1/audit/schemas/{name}": { "get": { "operationId": "downloadAuditSchema", "description": "Requires audit.read. Fixed schema whitelist; no filesystem path lookup.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "enum": [ "audit-event.schema.json", "audit-export.schema.json", "audit-api.openapi.json" ] } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Permission required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown job/document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency/journal/retention conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Expired export", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Range too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Export queue full; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Journal unavailable; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Canonical schema or OpenAPI contract", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "BearerAuth": [] }, { "APIKey": [] }, { "LoginSession": [] } ] } }, "/api/player/v1/audit/documentation": { "get": { "operationId": "downloadAuditDocumentation", "description": "Requires audit.read. Installation, export and Catcher integration handoff.", "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Permission required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown job/document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency/journal/retention conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Expired export", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Range too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Export queue full; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Journal unavailable; honour Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Markdown handoff", "content": { "text/markdown": { "schema": { "type": "string" } } } } }, "security": [ { "BearerAuth": [] }, { "APIKey": [] }, { "LoginSession": [] } ] } }, "/api/auth/session": { "get": { "operationId": "get_api_auth_session", "summary": "GET /api/auth/session", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/auth/login": { "post": { "operationId": "post_api_auth_login", "summary": "POST /api/auth/login", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ], "additionalProperties": true } } } } } }, "/api/auth/logout": { "post": { "operationId": "post_api_auth_logout", "summary": "POST /api/auth/logout", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } } } }, "/api/auth/lock": { "post": { "operationId": "post_api_auth_lock", "summary": "POST /api/auth/lock", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } } } }, "/api/player/v1/shows/{id}/validate": { "post": { "operationId": "post_api_player_v1_shows_id_validate", "summary": "POST /shows/{id}/validate", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Show updates with an id require the show ETag; schedule window replacement requires global ETag; priority requires job ETag. Recommended for all other conditional mutations." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validate_request" } } } } } }, "/api/player/v1/capabilities": { "get": { "operationId": "get_api_player_v1_capabilities", "summary": "GET /capabilities", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capabilities" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/device-info": { "get": { "operationId": "get_api_player_v1_device_info", "summary": "GET /device-info", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_info" }, "examples": { "unconfigured": { "value": { "schema": "d-cine.player-api.device-info.v1", "sampled_at_utc": "2026-10-13T03:00:00Z", "player": { "device_id": "urn:uuid:29ecba4a-3dc6-4d3c-9075-cda7799268c5", "product": "dcp-cine-player", "manufacturer": null, "model": null, "serial_number": null, "identity_source": "installation", "components": [ { "id": "player-service", "kind": "Software", "manufacturer": null, "description": "DCP-Cine Player service", "version": "4.2.30", "source": "build" } ] }, "audio": { "decode_formats": null, "decode_formats_source": null, "installed_formats": null, "installed_formats_source": null, "configured_at_utc": null }, "screen_capabilities": { "digital_3d": null, "closed_captions": null, "source": null }, "connected_devices": { "state": "unsupported", "items": [] }, "protocol_compatibility": { "barco": { "enabled": false, "identity_mode": "legacy_barco", "emulated_identity": true } }, "warnings": [ { "code": "MANUFACTURER_UNREPORTED", "path": "player.manufacturer" }, { "code": "DEVICE_SERIAL_UNREPORTED", "path": "player.serial_number" } ] } } } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" }, "description": "Metadata responses are never stored by HTTP caches." } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "description": "Authenticated status.read for GET; config.write for PUT. Independent of playback/ingest licences and recipient certificate. GET uses persisted/cached values only; no discovery or device control. PUT is a complete administrator declaration replacement." } }, "/api/player/v1/device-info/configuration": { "get": { "operationId": "get_api_player_v1_device_info_configuration", "summary": "GET /device-info/configuration", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_metadata_saved" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" }, "description": "Metadata responses are never stored by HTTP caches." } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "description": "Authenticated status.read for GET; config.write for PUT. Independent of playback/ingest licences and recipient certificate. GET uses persisted/cached values only; no discovery or device control. PUT is a complete administrator declaration replacement." }, "put": { "operationId": "put_api_player_v1_device_info_configuration", "summary": "PUT /device-info/configuration", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_metadata_saved" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" }, "description": "Metadata responses are never stored by HTTP caches." } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_metadata_configuration" } } } }, "description": "Authenticated status.read for GET; config.write for PUT. Independent of playback/ingest licences and recipient certificate. GET uses persisted/cached values only; no discovery or device control. PUT is a complete administrator declaration replacement." } }, "/api/player/v1/identity": { "get": { "operationId": "get_api_player_v1_identity", "summary": "GET /identity", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recipient_identity" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/identity/recipient-certificate": { "get": { "operationId": "get_api_player_v1_identity_recipient_certificate", "summary": "GET /identity/recipient-certificate", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/x-pem-file": { "schema": { "type": "string" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/automation/cues": { "get": { "operationId": "get_api_player_v1_automation_cues", "summary": "GET /automation/cues", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/automation/cues/ensure": { "post": { "operationId": "post_api_player_v1_automation_cues_ensure", "summary": "POST /automation/cues/ensure", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ensure_cues_request" } } } } } }, "/api/player/v1/automation/macros": { "get": { "operationId": "get_api_player_v1_automation_macros", "summary": "GET /automation/macros", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/automation/cues/{id}/execute": { "post": { "operationId": "post_api_player_v1_automation_cues_id_execute", "summary": "POST /automation/cues/{id}/execute", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/automation_request" } } } } } }, "/api/player/v1/automation/macros/{id}/execute": { "post": { "operationId": "post_api_player_v1_automation_macros_id_execute", "summary": "POST /automation/macros/{id}/execute", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/automation_request" } } } } } }, "/api/player/v1/scheduler": { "get": { "operationId": "get_api_player_v1_scheduler", "summary": "GET /scheduler", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } }, "put": { "operationId": "put_api_player_v1_scheduler", "summary": "PUT /scheduler", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Show updates with an id require the show ETag; schedule window replacement requires global ETag; priority requires job ETag. Recommended for all other conditional mutations." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler_request" } } } } } }, "/api/player/v1/schedule/{id}": { "patch": { "operationId": "patch_api_player_v1_schedule_id_", "summary": "PATCH /schedule/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Show updates with an id require the show ETag; schedule window replacement requires global ETag; priority requires job ETag. Recommended for all other conditional mutations." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule_move" } } } } }, "delete": { "operationId": "delete_api_player_v1_schedule_id_", "summary": "DELETE /schedule/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Show updates with an id require the show ETag; schedule window replacement requires global ETag; priority requires job ETag. Recommended for all other conditional mutations." }, { "name": "owner_application", "in": "query", "schema": { "type": "string", "maxLength": 256 }, "description": "Required to match ownership when deleting an owned resource" }, { "name": "owner_installation_id", "in": "query", "schema": { "type": "string", "maxLength": 256 }, "description": "Required to match ownership when deleting an owned resource" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/content/kdms": { "post": { "operationId": "post_api_player_v1_content_kdms", "summary": "POST /content/kdms", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/xml": { "schema": { "type": "string", "description": "Exact KDM XML, maximum 2 MiB" } } } } }, "get": { "operationId": "get_api_player_v1_content_kdms", "summary": "GET /content/kdms", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "uuid", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "cpl_id", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "message_id", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory_page" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/status": { "get": { "operationId": "get_api_player_v1_status", "summary": "GET /status", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/player_status" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/documentation": { "get": { "operationId": "get_api_player_v1_documentation", "summary": "GET /documentation", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "text/markdown": { "schema": { "type": "string" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/schemas/{name}": { "get": { "operationId": "get_api_player_v1_schemas_name_", "summary": "GET /schemas/{name}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/tms/specification": { "get": { "operationId": "get_api_player_v1_tms_specification", "summary": "GET /tms/specification", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "text/markdown": { "schema": { "type": "string" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/tms/handoff": { "get": { "operationId": "get_api_player_v1_tms_handoff", "summary": "GET /tms/handoff", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "text/markdown": { "schema": { "type": "string" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/content/cpls": { "get": { "operationId": "get_api_player_v1_content_cpls", "summary": "GET /content/cpls", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "uuid", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "cpl_id", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "message_id", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory_page" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/content/packages": { "get": { "operationId": "get_api_player_v1_content_packages", "summary": "GET /content/packages", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "uuid", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "cpl_id", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "message_id", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory_page" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/content/packages/{id}": { "delete": { "operationId": "delete_api_player_v1_content_packages_id_", "summary": "DELETE /content/packages/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/content/cpls/{id}": { "get": { "operationId": "get_api_player_v1_content_cpls_id_", "summary": "GET /content/cpls/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/content/cpls/{id}/check": { "post": { "operationId": "post_api_player_v1_content_cpls_id_check", "summary": "POST /content/cpls/{id}/check", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } } } }, "/api/player/v1/content/kdms/{id}": { "get": { "operationId": "get_api_player_v1_content_kdms_id_", "summary": "GET /content/kdms/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } }, "delete": { "operationId": "delete_api_player_v1_content_kdms_id_", "summary": "DELETE /content/kdms/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/shows": { "get": { "operationId": "get_api_player_v1_shows", "summary": "GET /shows", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } }, "post": { "operationId": "post_api_player_v1_shows", "summary": "POST /shows", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Show updates with an id require the show ETag; schedule window replacement requires global ETag; priority requires job ETag. Recommended for all other conditional mutations." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/show_response" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/show_request" } } } } } }, "/api/player/v1/shows/{id}": { "get": { "operationId": "get_api_player_v1_shows_id_", "summary": "GET /shows/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/show_response" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } }, "delete": { "operationId": "delete_api_player_v1_shows_id_", "summary": "DELETE /shows/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Show updates with an id require the show ETag; schedule window replacement requires global ETag; priority requires job ETag. Recommended for all other conditional mutations." }, { "name": "owner_application", "in": "query", "schema": { "type": "string", "maxLength": 256 }, "description": "Required to match ownership when deleting an owned resource" }, { "name": "owner_installation_id", "in": "query", "schema": { "type": "string", "maxLength": 256 }, "description": "Required to match ownership when deleting an owned resource" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/schedule": { "get": { "operationId": "get_api_player_v1_schedule", "summary": "GET /schedule", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "description": "Omitted bounds default to seven days before now and 31 days after now" }, { "name": "through", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "description": "Omitted bounds default to seven days before now and 31 days after now" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule_response" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } }, "put": { "operationId": "put_api_player_v1_schedule", "summary": "PUT /schedule", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Show updates with an id require the show ETag; schedule window replacement requires global ETag; priority requires job ETag. Recommended for all other conditional mutations." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule_response" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule_window" } } } } }, "post": { "operationId": "post_api_player_v1_schedule", "summary": "POST /schedule", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Show updates with an id require the show ETag; schedule window replacement requires global ETag; priority requires job ETag. Recommended for all other conditional mutations." } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/booking_request" } } } } } }, "/api/player/v1/playback/select": { "post": { "operationId": "post_api_player_v1_playback_select", "summary": "POST /playback/select", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/select_request" } } } } } }, "/api/player/v1/playback/play": { "post": { "operationId": "post_api_player_v1_playback_play", "summary": "POST /playback/play", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/play_request" } } } } } }, "/api/player/v1/playback/pause": { "post": { "operationId": "post_api_player_v1_playback_pause", "summary": "POST /playback/pause", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/playback/resume": { "post": { "operationId": "post_api_player_v1_playback_resume", "summary": "POST /playback/resume", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/playback/stop": { "post": { "operationId": "post_api_player_v1_playback_stop", "summary": "POST /playback/stop", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/playback/": { "post": { "operationId": "post_api_player_v1_playback_", "summary": "POST /playback/", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } } } }, "/api/player/v1/commands/{id}": { "get": { "operationId": "get_api_player_v1_commands_id_", "summary": "GET /commands/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/command_receipt" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/ingest/local": { "post": { "operationId": "post_api_player_v1_ingest_local", "summary": "POST /ingest/local", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/local_ingest_request" } } } } } }, "/api/player/v1/ingest/remote": { "post": { "operationId": "post_api_player_v1_ingest_remote", "summary": "POST /ingest/remote", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/remote_ingest_request" } } } } } }, "/api/player/v1/ingest/sources": { "post": { "operationId": "post_api_player_v1_ingest_sources", "summary": "POST /ingest/sources", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source_profile" } } } } }, "get": { "operationId": "get_api_player_v1_ingest_sources", "summary": "GET /ingest/sources", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/ingest/sources/{id}": { "put": { "operationId": "put_api_player_v1_ingest_sources_id_", "summary": "PUT /ingest/sources/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source_profile" } } } } }, "delete": { "operationId": "delete_api_player_v1_ingest_sources_id_", "summary": "DELETE /ingest/sources/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/ingest/staging": { "get": { "operationId": "get_api_player_v1_ingest_staging", "summary": "GET /ingest/staging", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/shows/{id}/preflight": { "post": { "operationId": "post_api_player_v1_shows_id_preflight", "summary": "POST /shows/{id}/preflight", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Show updates with an id require the show ETag; schedule window replacement requires global ETag; priority requires job ETag. Recommended for all other conditional mutations." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preflight_request" } } } } } }, "/api/player/v1/requests/{key}": { "get": { "operationId": "get_api_player_v1_requests_key_", "summary": "GET /requests/{key}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/request_receipt" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/jobs": { "get": { "operationId": "get_api_player_v1_jobs", "summary": "GET /jobs", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "kind", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "state", "in": "query", "schema": { "type": "string" }, "description": "Keep filters unchanged across pages; complete=false requires another page" }, { "name": "active", "in": "query", "schema": { "type": "boolean" }, "description": "Keep filters unchanged across pages; complete=false requires another page" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job_page" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/jobs/{id}": { "get": { "operationId": "get_api_player_v1_jobs_id_", "summary": "GET /jobs/{id}", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/jobs/{id}/cancel": { "post": { "operationId": "post_api_player_v1_jobs_id_cancel", "summary": "POST /jobs/{id}/cancel", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/jobs/{id}/retry": { "post": { "operationId": "post_api_player_v1_jobs_id_retry", "summary": "POST /jobs/{id}/retry", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/api/player/v1/jobs/{id}/priority": { "post": { "operationId": "post_api_player_v1_jobs_id_priority", "summary": "POST /jobs/{id}/priority", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Show updates with an id require the show ETag; schedule window replacement requires global ETag; priority requires job ETag. Recommended for all other conditional mutations." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/priority_request" } } } } } }, "/api/player/v1/playback/seek": { "post": { "operationId": "post_api_player_v1_playback_seek", "summary": "POST /playback/seek", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/command_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seek_request" } } } } } }, "/api/player/v1/playback/previous": { "post": { "operationId": "post_api_player_v1_playback_previous", "summary": "POST /playback/previous", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/command_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/step_request" } } } } } }, "/api/player/v1/playback/next": { "post": { "operationId": "post_api_player_v1_playback_next", "summary": "POST /playback/next", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/command_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/step_request" } } } } } }, "/api/player/v1/playback/jump": { "post": { "operationId": "post_api_player_v1_playback_jump", "summary": "POST /playback/jump", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/command_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/jump_request" } } } } } }, "/api/player/v1/playback/unload": { "post": { "operationId": "post_api_player_v1_playback_unload", "summary": "POST /playback/unload", "security": [ { "bearerAuth": [] }, { "apiKey": [] }, { "loginSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Strongly recommended for all mutations; same principal, method, URL, exact body and precondition replay the stored response. Audit POST requires it." } ], "responses": { "202": { "description": "Accepted durable operation; poll status, not execution success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/command_acceptance" } } } }, "400": { "description": "Malformed or unsupported request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication required or expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "Permission or licence gate denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "409": { "description": "Dependency, ownership, conflict or idempotency refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "410": { "description": "Expired retained operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "412": { "description": "Missing or stale revision precondition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unload_request" } } } } } }, "/api/player/v1/discovery": { "get": { "operationId": "get_api_player_v1_discovery", "summary": "Discover DCP-Cine Player identity without login", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/player_discovery" }, "examples": { "demo": { "value": { "schema": "d-cine.player-api.discovery.v1", "product": "dcp-cine-player", "version": "4.2.30", "device_id": "urn:uuid:29ecba4a-3dc6-4d3c-9075-cda7799268c5", "serial_number": null, "sampled_at_utc": "2026-10-13T03:00:00Z", "recipient_certificate": null, "endpoints": { "device_info": "/api/player/v1/device-info", "recipient_certificate": "/api/player/v1/discovery/recipient-certificate" }, "warnings": [ { "code": "RECIPIENT_CERTIFICATE_UNAVAILABLE", "path": "recipient_certificate" } ] } } } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } }, "description": "Unauthenticated GET and HEAD. No control, discovery scan or metadata write. Cache-Control no-store. Certificate requests return 503 if missing/malformed/unreadable/over 64 KiB; identity requests still return 200 with partial metadata. Adjacent routes and all protected native endpoints retain authentication." } }, "/api/player/v1/discovery/recipient-certificate": { "get": { "operationId": "get_api_player_v1_discovery_recipient_certificate", "summary": "Download public recipient leaf certificate", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/x-pem-file": { "schema": { "type": "string", "description": "Canonical public leaf PEM only" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "description": "Unauthenticated GET and HEAD. No control, discovery scan or metadata write. Cache-Control no-store. Certificate requests return 503 if missing/malformed/unreadable/over 64 KiB; identity requests still return 200 with partial metadata. Adjacent routes and all protected native endpoints retain authentication." } }, "/.well-known/dcp-cine-player": { "get": { "operationId": "get_well_known_dcp_cine_player", "summary": "Discover DCP-Cine Player identity without login", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/player_discovery" }, "examples": { "demo": { "value": { "schema": "d-cine.player-api.discovery.v1", "product": "dcp-cine-player", "version": "4.2.30", "device_id": "urn:uuid:29ecba4a-3dc6-4d3c-9075-cda7799268c5", "serial_number": null, "sampled_at_utc": "2026-10-13T03:00:00Z", "recipient_certificate": null, "endpoints": { "device_info": "/api/player/v1/device-info", "recipient_certificate": "/api/player/v1/discovery/recipient-certificate" }, "warnings": [ { "code": "RECIPIENT_CERTIFICATE_UNAVAILABLE", "path": "recipient_certificate" } ] } } } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } }, "description": "Unauthenticated GET and HEAD. No control, discovery scan or metadata write. Cache-Control no-store. Certificate requests return 503 if missing/malformed/unreadable/over 64 KiB; identity requests still return 200 with partial metadata. Adjacent routes and all protected native endpoints retain authentication." } }, "/.well-known/dcp-cine-player/recipient-certificate": { "get": { "operationId": "get_well_known_dcp_cine_player_recipient_certificate", "summary": "Download public recipient leaf certificate", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/x-pem-file": { "schema": { "type": "string", "description": "Canonical public leaf PEM only" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Storage or capability unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "description": "Unauthenticated GET and HEAD. No control, discovery scan or metadata write. Cache-Control no-store. Certificate requests return 503 if missing/malformed/unreadable/over 64 KiB; identity requests still return 200 with partial metadata. Adjacent routes and all protected native endpoints retain authentication." } } }, "components": { "schemas": { "ownership": { "type": "object", "properties": { "owner_application": { "type": "string", "maxLength": 256 }, "owner_installation_id": { "type": "string", "maxLength": 256 }, "external_session_id": { "type": "string", "maxLength": 256 }, "render_hash": { "type": "string", "maxLength": 256 }, "correlation_id": { "type": "string", "maxLength": 256 } }, "required": [], "additionalProperties": true }, "cue": { "type": "object", "properties": { "name": { "type": "string" }, "target_type": { "type": "string", "enum": [ "cue", "macro" ] }, "target_name": { "type": "string" }, "reference": { "type": "string", "enum": [ "start", "end" ] }, "offset_in_milliseconds": { "type": "integer" }, "optional": { "type": "boolean" } }, "required": [ "name", "offset_in_milliseconds" ], "additionalProperties": true, "allOf": [ { "if": { "required": [ "reference" ] }, "then": { "properties": { "offset_in_milliseconds": { "type": "integer", "minimum": 0 } } } } ] }, "show_item": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 128 }, "kind": { "type": "string", "enum": [ "cpl", "black", "event_stream", "sdi_input" ] }, "cpl_id": { "type": "string", "format": "uuid" }, "content_title_text": { "type": "string" }, "content_kind": { "type": "string" }, "duration_frames": { "type": "integer", "minimum": 1 }, "edit_rate_num": { "type": "integer", "minimum": 1 }, "edit_rate_den": { "type": "integer", "minimum": 1 }, "duration_in_milliseconds": { "type": "integer", "minimum": 1, "maximum": 31536000000 }, "cues": { "type": "array", "items": { "$ref": "#/components/schemas/cue" } }, "event_stream_id": { "type": "string", "maxLength": 128 }, "source_id": { "type": "string", "maxLength": 128 } }, "required": [ "kind" ], "additionalProperties": true, "description": "Native input forbids path and package_root. Deferred CPLs need positive duration: milliseconds or consistent frames and rate. All non-CPL items need finite milliseconds. Occurrence IDs are preserved or assigned.", "not": { "anyOf": [ { "required": [ "path" ] }, { "required": [ "package_root" ] } ] } }, "show_request": { "type": "object", "properties": { "owner_application": { "type": "string", "maxLength": 256 }, "owner_installation_id": { "type": "string", "maxLength": 256 }, "external_session_id": { "type": "string", "maxLength": 256 }, "render_hash": { "type": "string", "maxLength": 256 }, "correlation_id": { "type": "string", "maxLength": 256 }, "id": { "type": "string" }, "name": { "type": "string" }, "validation_mode": { "type": "string", "enum": [ "strict", "deferred" ], "default": "strict" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/show_item" }, "minItems": 1, "maxItems": 10000 } }, "required": [ "name", "items" ], "additionalProperties": true }, "booking_request": { "type": "object", "properties": { "owner_application": { "type": "string", "maxLength": 256 }, "owner_installation_id": { "type": "string", "maxLength": 256 }, "external_session_id": { "type": "string", "maxLength": 256 }, "render_hash": { "type": "string", "maxLength": 256 }, "correlation_id": { "type": "string", "maxLength": 256 }, "id": { "type": "string" }, "playlist_id": { "type": "string" }, "start_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "conflict_policy": { "type": "string", "enum": [ "reject", "allow" ], "default": "reject" }, "override_reason": { "type": "string", "maxLength": 1024 } }, "required": [ "playlist_id", "start_at_utc" ], "additionalProperties": true }, "schedule_move": { "type": "object", "properties": { "start_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "conflict_policy": { "type": "string", "enum": [ "reject", "allow" ], "default": "reject" }, "override_reason": { "type": "string", "maxLength": 1024 } }, "required": [ "start_at_utc" ], "additionalProperties": true }, "schedule_window": { "type": "object", "properties": { "owner_application": { "type": "string", "maxLength": 256 }, "owner_installation_id": { "type": "string", "maxLength": 256 }, "external_session_id": { "type": "string", "maxLength": 256 }, "render_hash": { "type": "string", "maxLength": 256 }, "correlation_id": { "type": "string", "maxLength": 256 }, "conflict_policy": { "type": "string", "enum": [ "reject", "allow" ], "default": "reject" }, "override_reason": { "type": "string", "maxLength": 1024 }, "from": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "through": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/booking_request" } } }, "required": [ "from", "through", "items" ], "additionalProperties": true }, "remote_ingest_request": { "type": "object", "properties": { "asset_type": { "type": "string", "enum": [ "dcp" ] }, "source_id": { "type": "string" }, "relative_path": { "type": "string" }, "external_storage_url": { "type": "string", "format": "uri", "description": "ftp URL without userinfo, query or fragment" }, "source_credentials": { "type": "object", "properties": { "username": { "type": "string", "maxLength": 1024 }, "password": { "type": "string", "maxLength": 4096 } }, "required": [ "username", "password" ], "additionalProperties": true }, "cpl_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1000, "uniqueItems": true }, "label": { "type": "string", "maxLength": 1024 }, "priority": { "type": "integer", "minimum": 0, "maximum": 100, "default": 50 } }, "required": [ "asset_type", "cpl_ids" ], "additionalProperties": true, "oneOf": [ { "required": [ "source_id", "relative_path" ], "not": { "anyOf": [ { "required": [ "external_storage_url" ] }, { "required": [ "source_credentials" ] } ] } }, { "required": [ "external_storage_url" ], "not": { "anyOf": [ { "required": [ "source_id" ] }, { "required": [ "relative_path" ] } ] } } ] }, "local_ingest_request": { "type": "object", "properties": { "source_path": { "type": "string" }, "asset_type": { "type": "string", "enum": [ "dcp", "media", "kdm" ] }, "label": { "type": "string" } }, "required": [ "source_path", "asset_type" ], "additionalProperties": true }, "source_profile": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "host": { "type": "string", "maxLength": 255 }, "port": { "type": "integer", "minimum": 1, "maximum": 65535, "default": 21 }, "base_path": { "type": "string", "maxLength": 4096 }, "username": { "type": "string", "maxLength": 1024 }, "password": { "type": "string", "maxLength": 4096 }, "asset_type": { "type": "string", "enum": [ "dcp", "imf", "ear", "media", "kdm" ] } }, "required": [ "host" ], "additionalProperties": true }, "preflight_request": { "type": "object", "properties": { "start_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "show_revision": { "type": "string" } }, "required": [ "start_at_utc", "show_revision" ], "additionalProperties": true }, "validate_request": { "type": "object", "properties": { "start_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." } }, "required": [ "start_at_utc" ], "additionalProperties": true }, "priority_request": { "type": "object", "properties": { "priority": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "priority" ], "additionalProperties": true }, "issue": { "type": "object", "properties": { "item_index": { "type": "integer", "minimum": 0 }, "item_id": { "type": "string" }, "cpl_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cpl_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "type": "string" }, "severity": { "type": "string", "enum": [ "error", "warning", "pending" ] }, "message": { "type": "string" }, "remediation": { "type": "string" }, "details": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } }, "required": [ "code", "severity", "message" ], "additionalProperties": true }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "readiness": { "type": "string", "enum": [ "ready", "not_ready", "pending", "failed" ] }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/issue" } }, "validated_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "show_revision": { "type": "string" }, "validation_level": { "type": "string" }, "required_cue_policy": { "type": "string" } }, "required": [ "ready", "readiness", "issues" ], "additionalProperties": true }, "job": { "type": "object", "properties": { "id": { "type": "string" }, "job_id": { "type": "string" }, "kind": { "type": "string" }, "state": { "type": "string", "enum": [ "queued", "running", "completed", "failed", "cancelled", "cancelling", "blocked" ] }, "progress_percent": { "type": "integer" }, "revision": { "type": "string" }, "priority": { "type": "integer", "minimum": 0, "maximum": 100 }, "queue_position": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "retry_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cpl_ids": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ] }, "phase": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "transferred_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "total_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "result": {}, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "retryable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "sampled_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "job_class": { "type": "string", "enum": [ "ingest", "readiness", "check", "other" ] }, "content_name": { "type": "string" }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "started_at_utc": { "anyOf": [ { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, { "type": "null" } ] }, "finished_at_utc": { "anyOf": [ { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, { "type": "null" } ] }, "downloaded_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "download_total_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "checked_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "check_total_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "speed_bps": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "input_json": { "type": "string", "description": "Safe allowlisted display projection only; never raw stored input or protected credentials" } }, "required": [ "id", "kind", "state" ], "additionalProperties": true, "description": "completed normalizes legacy succeeded. Running integrity/indexing may display Checking; Cancelling is not terminal. Download counters remain unchanged during verification. Null/zero total means unknown size. Progress is overall; independent phase counters measure download or verification. completed with phase indexed_incomplete retains dependency issues; it is not proof of playback readiness. Historic missing verification evidence remains unknown." }, "job_acceptance": { "type": "object", "properties": { "job_id": { "type": "string" }, "state": { "type": "string" }, "status_url": { "type": "string" }, "coalesced": { "type": "boolean" } }, "required": [ "job_id", "state" ], "additionalProperties": true }, "job_page": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/job" } }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "complete": { "type": "boolean" }, "sampled_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." } }, "required": [ "items", "complete", "sampled_at_utc" ], "additionalProperties": true }, "inventory_page": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "complete": { "type": "boolean" }, "sampled_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." } }, "required": [ "items" ], "additionalProperties": true }, "show_response": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "revision": { "type": "string" }, "validation_mode": { "type": "string" }, "ownership": { "$ref": "#/components/schemas/ownership" }, "items": { "type": "array", "items": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } }, "duration_in_milliseconds": { "type": "integer" }, "ready": { "type": "boolean" }, "readiness": { "type": "string" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/issue" } }, "created_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "last_played_at_utc": { "anyOf": [ { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, { "type": "null" } ] }, "last_played_state": { "type": "string", "enum": [ "observed", "never", "unavailable" ] } }, "required": [ "id", "name", "revision", "items" ], "additionalProperties": true, "description": "Created is the original creation time preserved in SPL XML. Last played is latest observed successful SPLStart, including subsequently interrupted runs; load/edit/book do not update it. Older history without retained evidence is unavailable, not never." }, "schedule_response": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } }, "revision": { "type": "string" }, "conflicts": { "type": "array", "items": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } }, "required": [ "items", "revision" ], "additionalProperties": true }, "request_receipt": { "type": "object", "properties": { "key": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "completed", "failed", "indeterminate" ] }, "request_digest": { "type": "string" }, "http_status": { "type": "integer" }, "result": {}, "retention": { "type": "string" } }, "required": [ "key", "state", "request_digest" ], "additionalProperties": true }, "error": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/issue" } } }, "required": [ "error" ], "additionalProperties": true }, "capabilities": { "type": "object", "properties": { "shows": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "schedule": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "ingest": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "jobs": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "requests": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "audit": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "barco": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "device_metadata": { "$ref": "#/components/schemas/device_metadata_capabilities" }, "discovery": { "$ref": "#/components/schemas/discovery_capabilities" } }, "required": [], "additionalProperties": true }, "kdm_detail": { "type": "object", "properties": { "id": { "type": "string" }, "cpl_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message_id": { "type": "string" }, "content_title_text": { "type": "string" }, "recipient_thumbprint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipient_subject": { "type": "string" }, "not_valid_before_utc": { "anyOf": [ { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, { "type": "null" } ] }, "not_valid_after_utc": { "anyOf": [ { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, { "type": "null" } ] }, "imported_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "state": { "type": "string" }, "file_size_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] } }, "required": [ "id", "state" ], "additionalProperties": true }, "scan_item": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "kind": { "type": "string" }, "cpl_id": { "type": "string" }, "content_title_text": { "type": "string" }, "size_bytes": { "type": "integer", "minimum": 0 }, "encrypted": { "type": "boolean" }, "duration_in_milliseconds": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "modified_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." } }, "required": [ "name", "path" ], "additionalProperties": true }, "scheduler_request": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": true }, "automation_request": { "type": "object", "properties": { "arguments": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [], "additionalProperties": true }, "ensure_cues_request": { "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" } }, "mode": { "type": "string", "enum": [ "missing_only" ] } }, "required": [], "additionalProperties": true }, "select_request": { "type": "object", "properties": { "playlist_id": { "type": "string" }, "show_id": { "type": "string" } }, "required": [], "additionalProperties": true, "anyOf": [ { "required": [ "playlist_id" ] }, { "required": [ "show_id" ] } ] }, "play_request": { "type": "object", "properties": { "playlist_id": { "type": "string" }, "show_id": { "type": "string" } }, "required": [], "additionalProperties": true }, "seek_request": { "type": "object", "properties": { "playlist_id": { "type": "string" }, "item_id": { "type": "string" }, "position_ms": { "type": "integer" }, "offset_ms": { "type": "integer" } }, "required": [ "playlist_id", "item_id" ], "additionalProperties": true, "oneOf": [ { "required": [ "position_ms" ], "not": { "required": [ "offset_ms" ] } }, { "required": [ "offset_ms" ], "not": { "required": [ "position_ms" ] } } ] }, "step_request": { "type": "object", "properties": { "playlist_id": { "type": "string" }, "expected_item_id": { "type": "string" } }, "required": [ "playlist_id", "expected_item_id" ], "additionalProperties": true }, "jump_request": { "type": "object", "properties": { "playlist_id": { "type": "string" }, "item_id": { "type": "string" } }, "required": [ "playlist_id", "item_id" ], "additionalProperties": true }, "unload_request": { "type": "object", "properties": { "playlist_id": { "type": "string" } }, "required": [ "playlist_id" ], "additionalProperties": true }, "command_acceptance": { "type": "object", "properties": { "command_id": { "type": "string" }, "state": { "type": "string", "enum": [ "accepted" ] }, "operation": { "type": "string" }, "clamped": { "type": "boolean" } }, "required": [ "command_id", "state", "operation" ], "additionalProperties": true }, "command_receipt": { "type": "object", "properties": { "command_id": { "type": "string" }, "state": { "type": "string", "enum": [ "accepted", "completed", "failed" ] }, "result": {}, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "command_id", "state" ], "additionalProperties": true }, "device_admin_component": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z0-9._-]+$", "not": { "enum": [ "player-service", "playback-engine" ] } }, "kind": { "anyOf": [ { "type": "string", "enum": [ "Software", "Firmware", "Hardware" ] }, { "type": "null" } ] }, "manufacturer": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "description": { "type": "string", "minLength": 1, "maxLength": 256 }, "version": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 512 }, { "type": "null" } ] }, "source": { "type": "string", "const": "operator" } }, "required": [ "id", "kind", "manufacturer", "description", "version", "source" ], "additionalProperties": false }, "device_component": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "kind": { "anyOf": [ { "type": "string", "enum": [ "Software", "Firmware", "Hardware" ] }, { "type": "null" } ] }, "manufacturer": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "description": { "type": "string", "minLength": 1, "maxLength": 256 }, "version": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 512 }, { "type": "null" } ] }, "source": { "type": "string", "enum": [ "build", "device", "operator" ] } }, "required": [ "id", "kind", "manufacturer", "description", "version", "source" ], "additionalProperties": false }, "device_player": { "type": "object", "properties": { "device_id": { "type": "string", "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "product": { "type": "string", "const": "dcp-cine-player" }, "manufacturer": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "serial_number": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "identity_source": { "type": "string", "enum": [ "hardware", "installation", "operator" ] }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/device_component" }, "minItems": 1 } }, "required": [ "device_id", "product", "manufacturer", "model", "serial_number", "identity_source", "components" ], "additionalProperties": false, "description": "Persisted installation UUID survives upgrade/restart/certificate rotation. serial_number is the licence-owned issued product serial or null for an unregistered demo. Activation/reactivation of the same licence preserves it through certificate rotation; a different licence supplies its own issued serial. Never calculated from the current certificate serial, host ID or emulation identity." }, "metadata_warning": { "type": "object", "properties": { "code": { "type": "string" }, "path": { "type": "string" } }, "required": [ "code", "path" ], "additionalProperties": false }, "device_info": { "type": "object", "properties": { "schema": { "type": "string", "const": "d-cine.player-api.device-info.v1" }, "sampled_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "player": { "$ref": "#/components/schemas/device_player" }, "audio": { "type": "object", "properties": { "decode_formats": { "anyOf": [ { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "uniqueItems": true }, { "type": "null" } ] }, "decode_formats_source": { "anyOf": [ { "type": "string", "enum": [ "runtime_capability" ] }, { "type": "null" } ] }, "installed_formats": { "anyOf": [ { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "uniqueItems": true }, { "type": "null" } ] }, "installed_formats_source": { "anyOf": [ { "type": "string", "enum": [ "operator" ] }, { "type": "null" } ] }, "configured_at_utc": { "anyOf": [ { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, { "type": "null" } ] } }, "required": [ "decode_formats", "decode_formats_source", "installed_formats", "installed_formats_source", "configured_at_utc" ], "additionalProperties": false }, "screen_capabilities": { "type": "object", "properties": { "digital_3d": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "closed_captions": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "operator" ] }, { "type": "null" } ] } }, "required": [ "digital_3d", "closed_captions", "source" ], "additionalProperties": false }, "connected_devices": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "unsupported" ] }, "items": { "type": "array", "items": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "maxItems": 0 } }, "required": [ "state", "items" ], "additionalProperties": false }, "protocol_compatibility": { "type": "object", "properties": { "barco": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "identity_mode": { "type": "string", "enum": [ "legacy_barco", "real" ] }, "emulated_identity": { "type": "boolean" } }, "required": [ "enabled", "identity_mode", "emulated_identity" ], "additionalProperties": false } }, "required": [ "barco" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/metadata_warning" } } }, "required": [ "schema", "sampled_at_utc", "player", "audio", "screen_capabilities", "connected_devices", "protocol_compatibility", "warnings" ], "additionalProperties": false, "description": "Authenticated status.read snapshot; no certificate/licence prerequisite. No discovery, control or writes on GET. Bounded persisted/cached reads; structured warnings preserve partial information. Initial audio labels 5.1,7.1,IAB; consumers must tolerate agreed future additive labels. Decode/output implementation and licences differ from operator-declared installed screen soundfield. Optional connected inventory is deferred/unsupported." }, "device_metadata_configuration": { "type": "object", "properties": { "manufacturer": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "serial_number": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/device_admin_component" }, "maxItems": 32 }, "installed_formats": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "5.1", "7.1", "IAB" ] }, "uniqueItems": true }, { "type": "null" } ] }, "digital_3d": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "closed_captions": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "soap_identity_mode": { "type": "string", "enum": [ "legacy_barco", "real" ] } }, "required": [ "manufacturer", "model", "serial_number", "components", "installed_formats", "digital_3d", "closed_captions", "soap_identity_mode" ], "additionalProperties": false, "description": "Administrator-only complete replacement. Null means unconfigured; [] explicitly declares no installed audio formats. Component source must be operator; IDs player-service/playback-engine are reserved. serial_number is read-only and licence-managed: null or an echo of the current serial is accepted; other values are rejected. Running audio routing does not change these declarations." }, "device_metadata_saved": { "type": "object", "properties": { "manufacturer": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "serial_number": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/device_admin_component" }, "maxItems": 32 }, "installed_formats": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "5.1", "7.1", "IAB" ] }, "uniqueItems": true }, { "type": "null" } ] }, "digital_3d": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "closed_captions": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "soap_identity_mode": { "type": "string", "enum": [ "legacy_barco", "real" ] }, "device_id": { "type": "string", "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "audio_configured_at_utc": { "anyOf": [ { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, { "type": "null" } ] } }, "required": [ "manufacturer", "model", "serial_number", "components", "installed_formats", "digital_3d", "closed_captions", "soap_identity_mode", "device_id", "audio_configured_at_utc" ], "additionalProperties": false }, "device_metadata_capabilities": { "type": "object", "properties": { "schema": { "type": "string", "const": "d-cine.player-api.device-info.v1" }, "endpoint": { "type": "string", "const": "/api/player/v1/device-info" }, "identity": { "type": "boolean" }, "components": { "type": "boolean" }, "audio": { "type": "boolean" }, "connected_devices": { "type": "boolean" } }, "required": [ "schema", "endpoint", "identity", "components", "audio", "connected_devices" ], "additionalProperties": false }, "recipient_identity": { "type": "object", "properties": { "common_name": { "type": "string" }, "subject": { "type": "string" }, "fingerprint_sha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "serial": { "type": "string", "pattern": "^[0-9]+$", "description": "Legacy certificate serial, not equipment serial" }, "certificate_serial_number": { "type": "string", "pattern": "^[0-9]+$", "description": "Unambiguous alias of serial; both must agree" }, "not_before_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "not_after_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." } }, "required": [ "common_name", "subject", "fingerprint_sha256", "serial", "certificate_serial_number", "not_before_utc", "not_after_utc" ], "additionalProperties": false }, "discovery_certificate": { "type": "object", "properties": { "pem": { "type": "string", "description": "Canonical public leaf PEM only; no chain, PEM headers or private key" }, "fingerprint_sha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "certificate_serial_number": { "type": "string", "pattern": "^[0-9]+$", "description": "Certificate serial; distinct from the licence-owned product serial" }, "not_before_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "not_after_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." } }, "required": [ "pem", "fingerprint_sha256", "certificate_serial_number", "not_before_utc", "not_after_utc" ], "additionalProperties": false }, "player_discovery": { "type": "object", "properties": { "schema": { "type": "string", "const": "d-cine.player-api.discovery.v1" }, "product": { "type": "string", "const": "dcp-cine-player" }, "version": { "type": "string", "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$" }, "device_id": { "anyOf": [ { "type": "string", "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "serial_number": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "sampled_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "recipient_certificate": { "anyOf": [ { "$ref": "#/components/schemas/discovery_certificate" }, { "type": "null" } ] }, "endpoints": { "type": "object", "properties": { "device_info": { "type": "string", "const": "/api/player/v1/device-info" }, "recipient_certificate": { "type": "string", "const": "/api/player/v1/discovery/recipient-certificate" } }, "required": [ "device_info", "recipient_certificate" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/metadata_warning" } } }, "required": [ "schema", "product", "version", "device_id", "serial_number", "sampled_at_utc", "recipient_certificate", "endpoints", "warnings" ], "additionalProperties": false, "description": "Anonymous GET/HEAD minimal identity scan. Product/version always known; optional identity/certificate failure yields null and warnings with HTTP 200. Licence-issued serial is null for an unregistered demo; never taken from the certificate. Certificate presence does not assert active licensing or authorisation. No equipment inventory, screen/site details, licences, credentials, playback or control data." }, "discovery_capabilities": { "type": "object", "properties": { "schema": { "type": "string", "const": "d-cine.player-api.discovery.v1" }, "endpoint": { "type": "string", "const": "/api/player/v1/discovery" }, "authentication_required": { "type": "boolean", "const": false }, "public_certificate": { "type": "boolean" } }, "required": [ "schema", "endpoint", "authentication_required", "public_certificate" ], "additionalProperties": false }, "disk_space": { "type": "object", "properties": { "path": { "type": "string", "description": "Resolved configured directory used for the filesystem query" }, "mount_point": { "type": "string" }, "device": { "type": "string" }, "filesystem": { "type": "string" }, "total_bytes": { "type": "integer", "minimum": 0 }, "used_bytes": { "type": "integer", "minimum": 0 }, "free_bytes": { "type": "integer", "minimum": 0 }, "reserved_bytes": { "type": "integer", "minimum": 0 } }, "required": [ "path", "mount_point", "device", "filesystem", "total_bytes", "used_bytes", "free_bytes", "reserved_bytes" ], "additionalProperties": false, "description": "Live statfs values matching df: used=(blocks-bfree)*block size, free=bavail*block size, reserved=(bfree-bavail)*block size. Unknown mount labels are empty strings; unavailable usage is null at the parent field." }, "storage_snapshot": { "type": "object", "properties": { "system": { "anyOf": [ { "$ref": "#/components/schemas/disk_space" }, { "type": "null" } ] }, "media": { "anyOf": [ { "$ref": "#/components/schemas/disk_space" }, { "type": "null" } ] }, "same_filesystem": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "sampled_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." } }, "required": [ "system", "media", "same_filesystem", "sampled_at_utc" ], "additionalProperties": false }, "native_storage": { "type": "object", "properties": { "system": { "anyOf": [ { "$ref": "#/components/schemas/disk_space" }, { "type": "null" } ] }, "media": { "anyOf": [ { "$ref": "#/components/schemas/disk_space" }, { "type": "null" } ] }, "same_filesystem": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "sampled_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." }, "total_bytes": { "type": "integer", "minimum": 0, "description": "Legacy media total; present when media is available" }, "free_bytes": { "type": "integer", "minimum": 0, "description": "Legacy media available; present when media is available" } }, "required": [ "system", "media", "same_filesystem", "sampled_at_utc" ], "additionalProperties": true, "description": "System is the filesystem containing the service working directory; media is the configured media-root filesystem. Both shared charts use identical space values. Missing media does not hide the system disk. Authenticated status only." }, "player_status": { "type": "object", "properties": { "schema": { "type": "string", "const": "d-cine.player-api.status.v1" }, "product": { "type": "string", "const": "dcp-cine-player" }, "version": { "type": "string" }, "playback": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "storage": { "$ref": "#/components/schemas/native_storage" }, "sampled_at_utc": { "type": "string", "format": "date-time", "description": "Explicit RFC3339 timezone required; normalized to UTC Z. Fractional seconds supported." } }, "required": [ "schema", "product", "version", "playback", "storage", "sampled_at_utc" ], "additionalProperties": true }, "AuditEvent": { "title": "D-Cine operational audit event v1", "type": "object", "required": [ "schema", "player_id", "log_store_id", "event_id", "sequence", "occurred_at_utc", "recorded_at_utc", "event_type", "event_subtype", "outcome", "source", "message", "clock_trusted", "clock_source", "details", "actor", "show_id", "show_name", "schedule_id", "show_item_id", "cpl_id", "content_title_text", "content_kind", "cue_id", "cue_name", "command_id", "job_id", "error_code", "playback_run_id" ], "properties": { "schema": { "const": "d-cine.audit-event.v1" }, "player_id": { "type": "string", "format": "uuid" }, "log_store_id": { "type": "string", "format": "uuid" }, "event_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "string", "pattern": "^[1-9][0-9]{0,19}$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." }, "occurred_at_utc": { "type": "string", "format": "date-time", "pattern": "Z$" }, "recorded_at_utc": { "type": "string", "format": "date-time", "pattern": "Z$" }, "event_type": { "enum": [ "Playout", "Automation", "Ingest", "Key", "Validation", "Schedule", "Operations" ] }, "event_subtype": { "type": "string", "minLength": 1 }, "outcome": { "enum": [ "accepted", "succeeded", "failed", "interrupted", "unverified", "no_action" ] }, "source": { "enum": [ "scheduler", "tms", "web_ui", "local_ui", "engine", "system" ] }, "message": { "type": "string" }, "clock_trusted": { "type": "boolean" }, "clock_source": { "type": "string" }, "details": { "type": "object" }, "actor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "show_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "show_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "schedule_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "show_item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cpl_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content_title_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cue_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "command_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "playback_run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "additionalProperties": false }, "AuditExport": { "title": "D-Cine audit export status v1", "type": "object", "required": [ "schema", "id", "state", "status_url", "progress_percent", "player_id", "log_store_id", "mode", "format", "snapshot_sequence", "retained_after_sequence", "has_more", "record_count", "first_sequence", "last_sequence", "coverage", "documents", "expires_at_utc", "created_at_utc", "error", "code" ], "properties": { "schema": { "const": "d-cine.audit-export.v1" }, "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "completed", "failed", "cancelled" ] }, "status_url": { "type": "string" }, "progress_percent": { "type": "integer", "minimum": 0, "maximum": 100 }, "player_id": { "type": "string", "format": "uuid" }, "log_store_id": { "type": "string", "format": "uuid" }, "mode": { "enum": [ "range", "incremental" ] }, "format": { "const": "ndjson" }, "snapshot_sequence": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,19})$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." }, "retained_after_sequence": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,19})$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." }, "from_utc": { "type": "string", "format": "date-time", "pattern": "Z$" }, "through_utc": { "type": "string", "format": "date-time", "pattern": "Z$" }, "after_sequence": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,19})$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." }, "next_after_sequence": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,19})$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." }, "has_more": { "type": "boolean" }, "record_count": { "type": "integer", "minimum": 0 }, "first_sequence": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,19})$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." }, { "type": "null" } ] }, "last_sequence": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,19})$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." }, { "type": "null" } ] }, "coverage": { "type": "object", "required": [ "complete", "coverage_start_utc", "oldest_available_sequence", "oldest_available_utc", "journal_healthy", "gaps" ], "properties": { "complete": { "type": "boolean" }, "coverage_start_utc": { "type": "string", "format": "date-time", "pattern": "Z$" }, "oldest_available_sequence": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,19})$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." }, { "type": "null" } ] }, "oldest_available_utc": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "journal_healthy": { "type": "boolean" }, "gaps": { "type": "array", "items": { "type": "object", "required": [ "from_utc", "through_utc", "reason" ], "properties": { "from_utc": { "type": "string", "format": "date-time", "pattern": "Z$" }, "through_utc": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "reason": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "documents": { "type": "array", "items": { "type": "object", "required": [ "id", "filename", "media_type", "record_count", "byte_count", "sha256", "download_url" ], "properties": { "id": { "type": "string" }, "filename": { "type": "string" }, "media_type": { "const": "application/x-ndjson" }, "record_count": { "type": "integer", "minimum": 1, "maximum": 10000 }, "byte_count": { "type": "integer", "minimum": 1 }, "sha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "download_url": { "type": "string" } }, "additionalProperties": false } }, "expires_at_utc": { "type": "string", "format": "date-time", "pattern": "Z$" }, "created_at_utc": { "type": "string", "format": "date-time", "pattern": "Z$" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false, "allOf": [ { "if": { "properties": { "mode": { "const": "range" } } }, "then": { "required": [ "from_utc", "through_utc" ] } }, { "if": { "properties": { "mode": { "const": "incremental" } } }, "then": { "required": [ "after_sequence", "next_after_sequence" ] } } ] }, "AuditExportRequest": { "oneOf": [ { "type": "object", "required": [ "mode", "format", "from_utc", "through_utc" ], "properties": { "mode": { "const": "range" }, "format": { "const": "ndjson" }, "from_utc": { "type": "string", "format": "date-time" }, "through_utc": { "type": "string", "format": "date-time" }, "log_store_id": { "type": "string", "format": "uuid" }, "snapshot_sequence": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,19})$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." } }, "dependentRequired": { "log_store_id": [ "snapshot_sequence" ], "snapshot_sequence": [ "log_store_id" ] }, "additionalProperties": false }, { "type": "object", "required": [ "mode", "format", "log_store_id", "after_sequence" ], "properties": { "mode": { "const": "incremental" }, "format": { "const": "ndjson" }, "log_store_id": { "type": "string", "format": "uuid" }, "after_sequence": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,19})$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." }, "snapshot_sequence": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,19})$", "description": "Canonical decimal uint64, maximum 18446744073709551615. Never parse as a JSON number." }, "limit": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 10000 } }, "additionalProperties": false } ] }, "Error": { "type": "object", "required": [ "error", "code", "details" ], "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object" } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" }, "apiKey": { "type": "apiKey", "in": "header", "name": "X-DCP-Player-API-Key" }, "loginSession": { "type": "apiKey", "in": "cookie", "name": "dcp_player_session" }, "BearerAuth": { "type": "http", "scheme": "bearer" }, "APIKey": { "type": "apiKey", "in": "header", "name": "X-DCP-Player-API-Key" }, "LoginSession": { "type": "apiKey", "in": "cookie", "name": "dcp_player_session" } } } }