{ "openapi": "3.1.1", "info": { "title": "Stranto.Voxmood | v1", "version": "1.0.0" }, "servers": [ { "url": "https://voxmood.stranto.com/" } ], "paths": { "/": { "get": { "tags": [ "Stranto.Voxmood" ], "responses": { "200": { "description": "OK" } } } }, "/api/about": { "get": { "tags": [ "Stranto.Voxmood" ], "responses": { "200": { "description": "OK" } } } }, "/auth/login": { "get": { "tags": [ "Stranto.Voxmood" ], "parameters": [ { "name": "returnUrl", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/auth/logout": { "get": { "tags": [ "Stranto.Voxmood" ], "responses": { "200": { "description": "OK" } } } }, "/auth/me": { "get": { "tags": [ "Stranto.Voxmood" ], "responses": { "200": { "description": "OK" } } } }, "/auth/denied": { "get": { "tags": [ "Stranto.Voxmood" ], "responses": { "200": { "description": "OK" } } } }, "/api/radio/v1/enroll": { "post": { "tags": [ "Streamer API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/radio/v1/checkin": { "post": { "tags": [ "Streamer API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckinRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/radio/v1/playlist": { "get": { "tags": [ "Streamer API" ], "responses": { "200": { "description": "OK" } } } }, "/api/radio/v1/network": { "get": { "tags": [ "Streamer API" ], "responses": { "200": { "description": "OK" } } } }, "/api/radio/v1/commands/{id}/result": { "post": { "tags": [ "Streamer API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommandResultRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/players": { "get": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "skip", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/players/{id}": { "get": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/players/{id}/events": { "get": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "take", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/enrollments/claim": { "post": { "tags": [ "Queeny integration API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClaimEnrollmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/players/{id}/commands": { "post": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/clients": { "get": { "tags": [ "Queeny integration API" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Queeny integration API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveClientRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/clients/{id}": { "put": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveClientRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/client-background-images": { "post": { "tags": [ "Queeny integration API" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/profiles": { "get": { "tags": [ "Queeny integration API" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Queeny integration API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveStreamProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/profiles/{id}": { "put": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveStreamProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/stream-images": { "post": { "tags": [ "Queeny integration API" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/players/{id}/client": { "put": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignClientRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/players/{id}/profiles": { "put": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignProfilesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integration/v1/players/{id}/network": { "put": { "tags": [ "Queeny integration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetNetworkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/players": { "get": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "skip", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/players/{id}": { "get": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/players/{id}/events": { "get": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "take", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/enrollments/claim": { "post": { "tags": [ "Voxmood administration API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClaimEnrollmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/players/{id}/commands": { "post": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/clients": { "get": { "tags": [ "Voxmood administration API" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Voxmood administration API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveClientRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/clients/{id}": { "put": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveClientRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/client-background-images": { "post": { "tags": [ "Voxmood administration API" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/profiles": { "get": { "tags": [ "Voxmood administration API" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Voxmood administration API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveStreamProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/profiles/{id}": { "put": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveStreamProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/stream-images": { "post": { "tags": [ "Voxmood administration API" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/players/{id}/client": { "put": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignClientRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/players/{id}/profiles": { "put": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignProfilesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/players/{id}/network": { "put": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetNetworkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/access-tokens": { "get": { "tags": [ "Voxmood administration API" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Voxmood administration API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiAccessTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/v1/access-tokens/{id}": { "delete": { "tags": [ "Voxmood administration API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AssignClientRequest": { "required": [ "clientId" ], "type": "object", "properties": { "clientId": { "type": "string", "format": "uuid" } } }, "AssignProfilesRequest": { "required": [ "profileIds" ], "type": "object", "properties": { "profileIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "CheckinRequest": { "type": "object", "properties": { "deviceId": { "type": "string" }, "appVersion": { "type": "string" }, "imageVersion": { "type": "string" }, "state": { "type": "string" }, "uptimeSec": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "playlistVersion": { "type": "string" }, "playback": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "cpuTempC": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "playlistError": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "events": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RadioEventRequest" } }, "update": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "networkVersion": { "type": "string" }, "network": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "networkError": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] } } }, "ClaimEnrollmentRequest": { "required": [ "pairingCode", "name", "clientId" ], "type": "object", "properties": { "pairingCode": { "type": "string" }, "name": { "type": "string" }, "clientId": { "type": "string", "format": "uuid" } } }, "CommandResultRequest": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": [ "null", "string" ] }, "startedAt": { "type": [ "null", "string" ] }, "durationMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" } } }, "CreateApiAccessTokenRequest": { "required": [ "name", "clientId", "scopes" ], "type": "object", "properties": { "name": { "type": "string" }, "clientId": { "type": "string", "format": "uuid" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "CreateCommandRequest": { "required": [ "type", "args" ], "type": "object", "properties": { "type": { "type": "string" }, "args": { "$ref": "#/components/schemas/JsonElement" }, "lifetimeSec": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "EnrollRequest": { "type": "object", "properties": { "deviceId": { "type": "string" }, "enrollSecret": { "type": "string" }, "appVersion": { "type": "string" }, "imageVersion": { "type": "string" }, "model": { "type": [ "null", "string" ] }, "hostname": { "type": [ "null", "string" ] }, "macAddress": { "type": [ "null", "string" ] } } }, "IFormFile": { "type": "string", "format": "binary" }, "JsonElement": { }, "RadioEventRequest": { "type": "object", "properties": { "type": { "type": "string" }, "detail": { "type": "string" }, "at": { "type": "string" } } }, "SaveClientRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "reference": { "type": [ "null", "string" ] }, "backgroundImagePath": { "type": [ "null", "string" ] } } }, "SaveStreamProfileRequest": { "required": [ "name", "availableToAllClients", "clientIds", "streams" ], "type": "object", "properties": { "name": { "type": "string" }, "availableToAllClients": { "type": "boolean" }, "clientIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "streams": { "type": "array", "items": { "$ref": "#/components/schemas/SaveStreamRequest" } } } }, "SaveStreamRequest": { "required": [ "name", "url" ], "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "imagePath": { "type": [ "null", "string" ] } } }, "SetNetworkRequest": { "required": [ "mode" ], "type": "object", "properties": { "mode": { "type": "string" }, "address": { "type": [ "null", "string" ] }, "prefixLength": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "gateway": { "type": [ "null", "string" ] }, "dns": { "type": [ "null", "array" ], "items": { "type": "string" } } } } } }, "tags": [ { "name": "Stranto.Voxmood" }, { "name": "Streamer API" }, { "name": "Queeny integration API" }, { "name": "Voxmood administration API" } ] }