timothy/ersatztv
1
0
Fork 0
Code Issues 51 Pull Requests 5 Actions Packages Projects Releases 9 Wiki Activity

chore(api): regenerate OpenAPI spec + SPA types for logs/troubleshoot-info (#145)

Browse Source
This commit is contained in:
timothy
2026-07-07 13:34:53 +02:00
parent dfa561a97e
commit bb34014a07
2 changed files with 456 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ErsatzTV/wwwroot/openapi/v1.json
+440
View File
@@ -2663,6 +2663,65 @@
}
}
},
"/api/logs": {
"get": {
"tags": [
"Logs"
],
"summary": "Get recent log entries",
"operationId": "GetLogs",
"parameters": [
{
"name": "pageNum",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "filter",
"in": "query",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PagedLogEntriesResponseModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedLogEntriesResponseModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PagedLogEntriesResponseModel"
}
}
}
}
}
}
},
"/api/maintenance/gc": {
"get": {
"tags": [
@@ -5432,6 +5491,303 @@
}
}
},
"/api/troubleshoot/info": {
"get": {
"tags": [
"Troubleshooting"
],
"summary": "Get troubleshooting diagnostic info",
"operationId": "GetTroubleshootingInfo",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TroubleshootingInfoResponseModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TroubleshootingInfoResponseModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TroubleshootingInfoResponseModel"
}
}
}
}
}
}
},
"/api/troubleshoot/playback.m3u8": {
"head": {
"tags": [
"Troubleshooting"
],
"summary": "Start a troubleshooting playback session",
"parameters": [
{
"name": "mediaItem",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "channel",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ffmpegProfile",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "streamingMode",
"in": "query",
"schema": {
"$ref": "#/components/schemas/StreamingMode"
}
},
{
"name": "watermark",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "graphicsElement",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "streamSelector",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "subtitleId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "seekSeconds",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "start",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"Troubleshooting"
],
"summary": "Start a troubleshooting playback session",
"parameters": [
{
"name": "mediaItem",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "channel",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ffmpegProfile",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "streamingMode",
"in": "query",
"schema": {
"$ref": "#/components/schemas/StreamingMode"
}
},
{
"name": "watermark",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "graphicsElement",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "streamSelector",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "subtitleId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "seekSeconds",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "start",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/troubleshoot/playback/archive": {
"head": {
"tags": [
"Troubleshooting"
],
"summary": "Download the last troubleshooting playback session archive",
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"Troubleshooting"
],
"summary": "Download the last troubleshooting playback session archive",
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/troubleshoot/playback/sample/{mediaItemId}": {
"head": {
"tags": [
"Troubleshooting"
],
"summary": "Download a media sample archive for troubleshooting",
"parameters": [
{
"name": "mediaItemId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"Troubleshooting"
],
"summary": "Download a media sample archive for troubleshooting",
"parameters": [
{
"name": "mediaItemId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/version": {
"get": {
"tags": [
@@ -8027,6 +8383,26 @@
}
}
},
"LogEntryResponseModel": {
"required": [
"timestamp",
"level",
"message"
],
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"level": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"LogEventLevel": {
"enum": [
"Verbose",
@@ -8371,6 +8747,25 @@
}
}
},
"PagedLogEntriesResponseModel": {
"required": [
"totalCount",
"page"
],
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogEntryResponseModel"
}
}
}
},
"PagedPlayoutItemsResponseModel": {
"required": [
"totalCount",
@@ -9456,6 +9851,45 @@
],
"type": "string"
},
"TroubleshootingInfoResponseModel": {
"required": [
"generalJson",
"nvidiaCapabilities",
"qsvCapabilities",
"vaapiCapabilities",
"videoToolboxCapabilities"
],
"type": "object",
"properties": {
"generalJson": {
"type": "string"
},
"nvidiaCapabilities": {
"type": [
"null",
"string"
]
},
"qsvCapabilities": {
"type": [
"null",
"string"
]
},
"vaapiCapabilities": {
"type": [
"null",
"string"
]
},
"videoToolboxCapabilities": {
"type": [
"null",
"string"
]
}
}
},
"UiSettingsResponseModel": {
"required": [
"isDarkMode",
@@ -10403,6 +10837,9 @@
{
"name": "Libraries"
},
{
"name": "Logs"
},
{
"name": "Maintenance"
},
@@ -10427,6 +10864,9 @@
{
"name": "Smart Collections"
},
{
"name": "Troubleshooting"
},
{
"name": "Version"
},