apps/core
1
0
Fork 0
mirror of https://github.com/datarhei/core.git synced 2025-09-26 20:11:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add version annotation to API methods

Browse Source
This commit is contained in:
Ingo Oppermann
2022-10-13 20:54:52 +02:00
parent 3da25c0d91
commit f746e581ae
14 changed files with 442 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
docs/docs.go
View File

@@ -62,7 +62,7 @@ const docTemplate = `{
"operationId": "graph-playground",
"responses": {
"200": {
"description": ""
"description": "OK"
}
}
}
@@ -220,6 +220,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Retrieve the currently active Restreamer configuration",
"operationId": "config-3-get",
"responses": {
@@ -244,6 +247,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Update the current Restreamer configuration",
"operationId": "config-3-set",
"parameters": [
@@ -290,6 +296,9 @@ const docTemplate = `{
"produces": [
"text/plain"
],
"tags": [
"v16.7.2"
],
"summary": "Reload the currently active configuration",
"operationId": "config-3-reload",
"responses": {
@@ -313,6 +322,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "List all files on the filesystem",
"operationId": "diskfs-3-list-files",
"parameters": [
@@ -360,6 +372,9 @@ const docTemplate = `{
"application/data",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Fetch a file from the filesystem",
"operationId": "diskfs-3-get-file",
"parameters": [
@@ -406,6 +421,9 @@ const docTemplate = `{
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Add a file to the filesystem",
"operationId": "diskfs-3-put-file",
"parameters": [
@@ -460,6 +478,9 @@ const docTemplate = `{
"produces": [
"text/plain"
],
"tags": [
"v16.7.2"
],
"summary": "Remove a file from the filesystem",
"operationId": "diskfs-3-delete-file",
"parameters": [
@@ -498,6 +519,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "List all files on the memory filesystem",
"operationId": "memfs-3-list-files",
"parameters": [
@@ -545,6 +569,9 @@ const docTemplate = `{
"application/data",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Fetch a file from the memory filesystem",
"operationId": "memfs-3-get-file",
"parameters": [
@@ -591,6 +618,9 @@ const docTemplate = `{
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Add a file to the memory filesystem",
"operationId": "memfs-3-put-file",
"parameters": [
@@ -645,6 +675,9 @@ const docTemplate = `{
"produces": [
"text/plain"
],
"tags": [
"v16.7.2"
],
"summary": "Remove a file from the memory filesystem",
"operationId": "memfs-3-delete-file",
"parameters": [
@@ -685,6 +718,9 @@ const docTemplate = `{
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Create a link to a file in the memory filesystem",
"operationId": "memfs-3-patch",
"parameters": [
@@ -732,6 +768,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Application log",
"operationId": "log-3",
"parameters": [
@@ -766,6 +805,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Retrieve JSON metadata from a key",
"operationId": "metadata-3-get",
"parameters": [
@@ -806,6 +848,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Add JSON metadata under the given key",
"operationId": "metadata-3-set",
"parameters": [
@@ -849,6 +894,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.10.0"
],
"summary": "List all known metrics with their description and labels",
"operationId": "metrics-3-describe",
"responses": {
@@ -876,6 +924,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Query the collected metrics",
"operationId": "metrics-3-metrics",
"parameters": [
@@ -916,6 +967,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "List all known processes",
"operationId": "process-3-get-all",
"parameters": [
@@ -975,6 +1029,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Add a new process",
"operationId": "process-3-add",
"parameters": [
@@ -1015,6 +1072,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "List a process by its ID",
"operationId": "process-3-get",
"parameters": [
@@ -1053,13 +1113,16 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "Replace an existing process. This is a shortcut for DELETE+POST.",
"description": "Replace an existing process.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Replace an existing process",
"operationId": "process-3-update",
"parameters": [
@@ -1111,6 +1174,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Delete a process by its ID",
"operationId": "process-3-delete",
"parameters": [
@@ -1152,6 +1218,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Issue a command to a process",
"operationId": "process-3-command",
"parameters": [
@@ -1205,6 +1274,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get the configuration of a process",
"operationId": "process-3-get-config",
"parameters": [
@@ -1249,6 +1321,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Retrieve JSON metadata stored with a process under a key",
"operationId": "process-3-get-process-metadata",
"parameters": [
@@ -1296,6 +1371,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Add JSON metadata with a process under the given key",
"operationId": "process-3-set-process-metadata",
"parameters": [
@@ -1353,6 +1431,9 @@ const docTemplate = `{
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Encode the errorframe",
"operationId": "process-3-playout-errorframencode",
"parameters": [
@@ -1408,6 +1489,9 @@ const docTemplate = `{
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Upload an error frame",
"operationId": "process-3-playout-errorframe",
"parameters": [
@@ -1480,6 +1564,9 @@ const docTemplate = `{
"image/png",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get the last keyframe",
"operationId": "process-3-playout-keyframe",
"parameters": [
@@ -1538,6 +1625,9 @@ const docTemplate = `{
"produces": [
"text/plain"
],
"tags": [
"v16.7.2"
],
"summary": "Close the current input stream",
"operationId": "process-3-playout-reopen-input",
"parameters": [
@@ -1589,6 +1679,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get the current playout status",
"operationId": "process-3-playout-status",
"parameters": [
@@ -1644,6 +1737,9 @@ const docTemplate = `{
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Switch to a new stream",
"operationId": "process-3-playout-stream",
"parameters": [
@@ -1700,10 +1796,13 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "Probe an existing process to get a detailed stream information on the inputs",
"description": "Probe an existing process to get a detailed stream information on the inputs.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Probe a process",
"operationId": "process-3-probe",
"parameters": [
@@ -1732,10 +1831,13 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "Get the logs and the log history of a process",
"description": "Get the logs and the log history of a process.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get the logs of a process",
"operationId": "process-3-get-report",
"parameters": [
@@ -1776,10 +1878,13 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "Get the state and progress data of a process",
"description": "Get the state and progress data of a process.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get the state of a process",
"operationId": "process-3-get-state",
"parameters": [
@@ -1820,10 +1925,13 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "List all currently publishing RTMP streams",
"description": "List all currently publishing RTMP streams.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "List all publishing RTMP streams",
"operationId": "rtmp-3-list-channels",
"responses": {
@@ -1846,10 +1954,13 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "Get a summary of all active and past sessions of the given collector",
"description": "Get a summary of all active and past sessions of the given collector.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get a summary of all active and past sessions",
"operationId": "session-3-summary",
"parameters": [
@@ -1877,10 +1988,13 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth)",
"description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth).",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get a minimal summary of all active sessions",
"operationId": "session-3-current",
"parameters": [
@@ -1908,10 +2022,13 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "List all detected FFmpeg capabilities",
"description": "List all detected FFmpeg capabilities.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "FFmpeg capabilities",
"operationId": "skills-3",
"responses": {
@@ -1931,10 +2048,13 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "Refresh the available FFmpeg capabilities",
"description": "Refresh the available FFmpeg capabilities.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Refresh FFmpeg capabilities",
"operationId": "skills-3-reload",
"responses": {
@@ -1958,6 +2078,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.9.0"
],
"summary": "List all publishing SRT treams",
"operationId": "srt-3-list-channels",
"responses": {
@@ -1979,6 +2102,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Fetch minimal statistics about a process",
"operationId": "widget-3-get",
"parameters": [
@@ -2427,7 +2553,7 @@ const docTemplate = `{
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/config.Auth0Tenant"
"$ref": "#/definitions/value.Auth0Tenant"
}
}
}
@@ -2837,6 +2963,9 @@ const docTemplate = `{
"cert_file": {
"type": "string"
},
"email": {
"type": "string"
},
"enable": {
"type": "boolean"
},
@@ -4052,7 +4181,7 @@ const docTemplate = `{
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/config.Auth0Tenant"
"$ref": "#/definitions/value.Auth0Tenant"
}
}
}
@@ -4462,6 +4591,9 @@ const docTemplate = `{
"cert_file": {
"type": "string"
},
"email": {
"type": "string"
},
"enable": {
"type": "boolean"
},
@@ -4741,7 +4873,7 @@ const docTemplate = `{
}
}
},
"config.Auth0Tenant": {
"value.Auth0Tenant": {
"type": "object",
"properties": {
"audience": {

158
docs/swagger.json
View File

@@ -54,7 +54,7 @@
"operationId": "graph-playground",
"responses": {
"200": {
"description": ""
"description": "OK"
}
}
}
@@ -212,6 +212,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Retrieve the currently active Restreamer configuration",
"operationId": "config-3-get",
"responses": {
@@ -236,6 +239,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Update the current Restreamer configuration",
"operationId": "config-3-set",
"parameters": [
@@ -282,6 +288,9 @@
"produces": [
"text/plain"
],
"tags": [
"v16.7.2"
],
"summary": "Reload the currently active configuration",
"operationId": "config-3-reload",
"responses": {
@@ -305,6 +314,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "List all files on the filesystem",
"operationId": "diskfs-3-list-files",
"parameters": [
@@ -352,6 +364,9 @@
"application/data",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Fetch a file from the filesystem",
"operationId": "diskfs-3-get-file",
"parameters": [
@@ -398,6 +413,9 @@
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Add a file to the filesystem",
"operationId": "diskfs-3-put-file",
"parameters": [
@@ -452,6 +470,9 @@
"produces": [
"text/plain"
],
"tags": [
"v16.7.2"
],
"summary": "Remove a file from the filesystem",
"operationId": "diskfs-3-delete-file",
"parameters": [
@@ -490,6 +511,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "List all files on the memory filesystem",
"operationId": "memfs-3-list-files",
"parameters": [
@@ -537,6 +561,9 @@
"application/data",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Fetch a file from the memory filesystem",
"operationId": "memfs-3-get-file",
"parameters": [
@@ -583,6 +610,9 @@
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Add a file to the memory filesystem",
"operationId": "memfs-3-put-file",
"parameters": [
@@ -637,6 +667,9 @@
"produces": [
"text/plain"
],
"tags": [
"v16.7.2"
],
"summary": "Remove a file from the memory filesystem",
"operationId": "memfs-3-delete-file",
"parameters": [
@@ -677,6 +710,9 @@
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Create a link to a file in the memory filesystem",
"operationId": "memfs-3-patch",
"parameters": [
@@ -724,6 +760,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Application log",
"operationId": "log-3",
"parameters": [
@@ -758,6 +797,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Retrieve JSON metadata from a key",
"operationId": "metadata-3-get",
"parameters": [
@@ -798,6 +840,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Add JSON metadata under the given key",
"operationId": "metadata-3-set",
"parameters": [
@@ -841,6 +886,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.10.0"
],
"summary": "List all known metrics with their description and labels",
"operationId": "metrics-3-describe",
"responses": {
@@ -868,6 +916,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Query the collected metrics",
"operationId": "metrics-3-metrics",
"parameters": [
@@ -908,6 +959,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "List all known processes",
"operationId": "process-3-get-all",
"parameters": [
@@ -967,6 +1021,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Add a new process",
"operationId": "process-3-add",
"parameters": [
@@ -1007,6 +1064,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "List a process by its ID",
"operationId": "process-3-get",
"parameters": [
@@ -1045,13 +1105,16 @@
"ApiKeyAuth": []
}
],
"description": "Replace an existing process. This is a shortcut for DELETE+POST.",
"description": "Replace an existing process.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Replace an existing process",
"operationId": "process-3-update",
"parameters": [
@@ -1103,6 +1166,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Delete a process by its ID",
"operationId": "process-3-delete",
"parameters": [
@@ -1144,6 +1210,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Issue a command to a process",
"operationId": "process-3-command",
"parameters": [
@@ -1197,6 +1266,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get the configuration of a process",
"operationId": "process-3-get-config",
"parameters": [
@@ -1241,6 +1313,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Retrieve JSON metadata stored with a process under a key",
"operationId": "process-3-get-process-metadata",
"parameters": [
@@ -1288,6 +1363,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Add JSON metadata with a process under the given key",
"operationId": "process-3-set-process-metadata",
"parameters": [
@@ -1345,6 +1423,9 @@
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Encode the errorframe",
"operationId": "process-3-playout-errorframencode",
"parameters": [
@@ -1400,6 +1481,9 @@
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Upload an error frame",
"operationId": "process-3-playout-errorframe",
"parameters": [
@@ -1472,6 +1556,9 @@
"image/png",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get the last keyframe",
"operationId": "process-3-playout-keyframe",
"parameters": [
@@ -1530,6 +1617,9 @@
"produces": [
"text/plain"
],
"tags": [
"v16.7.2"
],
"summary": "Close the current input stream",
"operationId": "process-3-playout-reopen-input",
"parameters": [
@@ -1581,6 +1671,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get the current playout status",
"operationId": "process-3-playout-status",
"parameters": [
@@ -1636,6 +1729,9 @@
"text/plain",
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Switch to a new stream",
"operationId": "process-3-playout-stream",
"parameters": [
@@ -1692,10 +1788,13 @@
"ApiKeyAuth": []
}
],
"description": "Probe an existing process to get a detailed stream information on the inputs",
"description": "Probe an existing process to get a detailed stream information on the inputs.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Probe a process",
"operationId": "process-3-probe",
"parameters": [
@@ -1724,10 +1823,13 @@
"ApiKeyAuth": []
}
],
"description": "Get the logs and the log history of a process",
"description": "Get the logs and the log history of a process.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get the logs of a process",
"operationId": "process-3-get-report",
"parameters": [
@@ -1768,10 +1870,13 @@
"ApiKeyAuth": []
}
],
"description": "Get the state and progress data of a process",
"description": "Get the state and progress data of a process.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get the state of a process",
"operationId": "process-3-get-state",
"parameters": [
@@ -1812,10 +1917,13 @@
"ApiKeyAuth": []
}
],
"description": "List all currently publishing RTMP streams",
"description": "List all currently publishing RTMP streams.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "List all publishing RTMP streams",
"operationId": "rtmp-3-list-channels",
"responses": {
@@ -1838,10 +1946,13 @@
"ApiKeyAuth": []
}
],
"description": "Get a summary of all active and past sessions of the given collector",
"description": "Get a summary of all active and past sessions of the given collector.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get a summary of all active and past sessions",
"operationId": "session-3-summary",
"parameters": [
@@ -1869,10 +1980,13 @@
"ApiKeyAuth": []
}
],
"description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth)",
"description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth).",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Get a minimal summary of all active sessions",
"operationId": "session-3-current",
"parameters": [
@@ -1900,10 +2014,13 @@
"ApiKeyAuth": []
}
],
"description": "List all detected FFmpeg capabilities",
"description": "List all detected FFmpeg capabilities.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "FFmpeg capabilities",
"operationId": "skills-3",
"responses": {
@@ -1923,10 +2040,13 @@
"ApiKeyAuth": []
}
],
"description": "Refresh the available FFmpeg capabilities",
"description": "Refresh the available FFmpeg capabilities.",
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Refresh FFmpeg capabilities",
"operationId": "skills-3-reload",
"responses": {
@@ -1950,6 +2070,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.9.0"
],
"summary": "List all publishing SRT treams",
"operationId": "srt-3-list-channels",
"responses": {
@@ -1971,6 +2094,9 @@
"produces": [
"application/json"
],
"tags": [
"v16.7.2"
],
"summary": "Fetch minimal statistics about a process",
"operationId": "widget-3-get",
"parameters": [
@@ -2419,7 +2545,7 @@
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/config.Auth0Tenant"
"$ref": "#/definitions/value.Auth0Tenant"
}
}
}
@@ -2829,6 +2955,9 @@
"cert_file": {
"type": "string"
},
"email": {
"type": "string"
},
"enable": {
"type": "boolean"
},
@@ -4044,7 +4173,7 @@
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/config.Auth0Tenant"
"$ref": "#/definitions/value.Auth0Tenant"
}
}
}
@@ -4454,6 +4583,9 @@
"cert_file": {
"type": "string"
},
"email": {
"type": "string"
},
"enable": {
"type": "boolean"
},
@@ -4733,7 +4865,7 @@
}
}
},
"config.Auth0Tenant": {
"value.Auth0Tenant": {
"type": "object",
"properties": {
"audience": {

114
docs/swagger.yaml
View File

@@ -122,7 +122,7 @@ definitions:
type: boolean
tenants:
items:
$ref: '#/definitions/config.Auth0Tenant'
$ref: '#/definitions/value.Auth0Tenant'
type: array
type: object
disable_localhost:
@@ -388,6 +388,8 @@ definitions:
type: boolean
cert_file:
type: string
email:
type: string
enable:
type: boolean
key_file:
@@ -1245,7 +1247,7 @@ definitions:
type: boolean
tenants:
items:
$ref: '#/definitions/config.Auth0Tenant'
$ref: '#/definitions/value.Auth0Tenant'
type: array
type: object
disable_localhost:
@@ -1511,6 +1513,8 @@ definitions:
type: boolean
cert_file:
type: string
email:
type: string
enable:
type: boolean
key_file:
@@ -1691,7 +1695,7 @@ definitions:
uptime:
type: integer
type: object
config.Auth0Tenant:
value.Auth0Tenant:
properties:
audience:
type: string
@@ -1767,7 +1771,7 @@ paths:
- text/html
responses:
"200":
description: ""
description: OK
security:
- ApiKeyAuth: []
summary: Load GraphQL playground
@@ -1876,6 +1880,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Retrieve the currently active Restreamer configuration
tags:
- v16.7.2
put:
consumes:
- application/json
@@ -1907,6 +1913,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Update the current Restreamer configuration
tags:
- v16.7.2
/api/v3/config/reload:
get:
description: Reload the currently active configuration. This will trigger a
@@ -1922,6 +1930,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Reload the currently active configuration
tags:
- v16.7.2
/api/v3/fs/disk:
get:
description: List all files on the filesystem. The listing can be ordered by
@@ -1952,6 +1962,8 @@ paths:
security:
- ApiKeyAuth: []
summary: List all files on the filesystem
tags:
- v16.7.2
/api/v3/fs/disk/{path}:
delete:
description: Remove a file from the filesystem
@@ -1976,6 +1988,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Remove a file from the filesystem
tags:
- v16.7.2
get:
description: Fetch a file from the filesystem. The contents of that file are
returned.
@@ -2005,6 +2019,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Fetch a file from the filesystem
tags:
- v16.7.2
put:
consumes:
- application/data
@@ -2043,6 +2059,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Add a file to the filesystem
tags:
- v16.7.2
/api/v3/fs/mem:
get:
description: List all files on the memory filesystem. The listing can be ordered
@@ -2073,6 +2091,8 @@ paths:
security:
- ApiKeyAuth: []
summary: List all files on the memory filesystem
tags:
- v16.7.2
/api/v3/fs/mem/{path}:
delete:
description: Remove a file from the memory filesystem
@@ -2097,6 +2117,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Remove a file from the memory filesystem
tags:
- v16.7.2
get:
description: Fetch a file from the memory filesystem
operationId: memfs-3-get-file
@@ -2125,6 +2147,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Fetch a file from the memory filesystem
tags:
- v16.7.2
patch:
consumes:
- application/data
@@ -2158,6 +2182,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Create a link to a file in the memory filesystem
tags:
- v16.7.2
put:
consumes:
- application/data
@@ -2196,6 +2222,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Add a file to the memory filesystem
tags:
- v16.7.2
/api/v3/log:
get:
description: Get the last log lines of the Restreamer application
@@ -2217,6 +2245,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Application log
tags:
- v16.7.2
/api/v3/metadata/{key}:
get:
description: Retrieve the previously stored JSON metadata under the given key.
@@ -2245,6 +2275,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Retrieve JSON metadata from a key
tags:
- v16.7.2
put:
description: Add arbitrary JSON metadata under the given key. If the key exists,
all already stored metadata with this key will be overwritten. If the key
@@ -2274,6 +2306,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Add JSON metadata under the given key
tags:
- v16.7.2
/api/v3/metrics:
get:
description: List all known metrics with their description and labels
@@ -2290,6 +2324,8 @@ paths:
security:
- ApiKeyAuth: []
summary: List all known metrics with their description and labels
tags:
- v16.10.0
post:
consumes:
- application/json
@@ -2316,6 +2352,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Query the collected metrics
tags:
- v16.7.2
/api/v3/process:
get:
description: List all known processes. Use the query parameter to filter the
@@ -2360,6 +2398,8 @@ paths:
security:
- ApiKeyAuth: []
summary: List all known processes
tags:
- v16.7.2
post:
consumes:
- application/json
@@ -2386,6 +2426,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Add a new process
tags:
- v16.7.2
/api/v3/process/{id}:
delete:
description: Delete a process by its ID
@@ -2410,6 +2452,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Delete a process by its ID
tags:
- v16.7.2
get:
description: List a process by its ID. Use the filter parameter to specifiy
the level of detail of the output.
@@ -2439,10 +2483,12 @@ paths:
security:
- ApiKeyAuth: []
summary: List a process by its ID
tags:
- v16.7.2
put:
consumes:
- application/json
description: Replace an existing process. This is a shortcut for DELETE+POST.
description: Replace an existing process.
operationId: process-3-update
parameters:
- description: Process ID
@@ -2474,6 +2520,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Replace an existing process
tags:
- v16.7.2
/api/v3/process/{id}/command:
put:
consumes:
@@ -2510,6 +2558,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Issue a command to a process
tags:
- v16.7.2
/api/v3/process/{id}/config:
get:
description: Get the configuration of a process. This is the configuration as
@@ -2539,6 +2589,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Get the configuration of a process
tags:
- v16.7.2
/api/v3/process/{id}/metadata/{key}:
get:
description: Retrieve the previously stored JSON metadata under the given key.
@@ -2572,6 +2624,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Retrieve JSON metadata stored with a process under a key
tags:
- v16.7.2
put:
description: Add arbitrary JSON metadata under the given key. If the key exists,
all already stored metadata with this key will be overwritten. If the key
@@ -2611,6 +2665,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Add JSON metadata with a process under the given key
tags:
- v16.7.2
/api/v3/process/{id}/playout/{inputid}/errorframe/{name}:
post:
consumes:
@@ -2660,6 +2716,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Upload an error frame
tags:
- v16.7.2
/api/v3/process/{id}/playout/{inputid}/errorframe/encode:
get:
description: Immediately encode the errorframe (if available and looping)
@@ -2694,6 +2752,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Encode the errorframe
tags:
- v16.7.2
/api/v3/process/{id}/playout/{inputid}/keyframe/{name}:
get:
description: Get the last keyframe of an input of a process. The extension of
@@ -2735,6 +2795,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Get the last keyframe
tags:
- v16.7.2
/api/v3/process/{id}/playout/{inputid}/reopen:
get:
description: Close the current input stream such that it will be automatically
@@ -2769,6 +2831,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Close the current input stream
tags:
- v16.7.2
/api/v3/process/{id}/playout/{inputid}/status:
get:
description: Get the current playout status of an input of a process
@@ -2802,6 +2866,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Get the current playout status
tags:
- v16.7.2
/api/v3/process/{id}/playout/{inputid}/stream:
put:
consumes:
@@ -2845,10 +2911,12 @@ paths:
security:
- ApiKeyAuth: []
summary: Switch to a new stream
tags:
- v16.7.2
/api/v3/process/{id}/probe:
get:
description: Probe an existing process to get a detailed stream information
on the inputs
on the inputs.
operationId: process-3-probe
parameters:
- description: Process ID
@@ -2866,9 +2934,11 @@ paths:
security:
- ApiKeyAuth: []
summary: Probe a process
tags:
- v16.7.2
/api/v3/process/{id}/report:
get:
description: Get the logs and the log history of a process
description: Get the logs and the log history of a process.
operationId: process-3-get-report
parameters:
- description: Process ID
@@ -2894,9 +2964,11 @@ paths:
security:
- ApiKeyAuth: []
summary: Get the logs of a process
tags:
- v16.7.2
/api/v3/process/{id}/state:
get:
description: Get the state and progress data of a process
description: Get the state and progress data of a process.
operationId: process-3-get-state
parameters:
- description: Process ID
@@ -2922,9 +2994,11 @@ paths:
security:
- ApiKeyAuth: []
summary: Get the state of a process
tags:
- v16.7.2
/api/v3/rtmp:
get:
description: List all currently publishing RTMP streams
description: List all currently publishing RTMP streams.
operationId: rtmp-3-list-channels
produces:
- application/json
@@ -2938,9 +3012,11 @@ paths:
security:
- ApiKeyAuth: []
summary: List all publishing RTMP streams
tags:
- v16.7.2
/api/v3/session:
get:
description: Get a summary of all active and past sessions of the given collector
description: Get a summary of all active and past sessions of the given collector.
operationId: session-3-summary
parameters:
- description: Comma separated list of collectors
@@ -2957,10 +3033,12 @@ paths:
security:
- ApiKeyAuth: []
summary: Get a summary of all active and past sessions
tags:
- v16.7.2
/api/v3/session/active:
get:
description: Get a minimal summary of all active sessions (i.e. number of sessions,
bandwidth)
bandwidth).
operationId: session-3-current
parameters:
- description: Comma separated list of collectors
@@ -2977,9 +3055,11 @@ paths:
security:
- ApiKeyAuth: []
summary: Get a minimal summary of all active sessions
tags:
- v16.7.2
/api/v3/skills:
get:
description: List all detected FFmpeg capabilities
description: List all detected FFmpeg capabilities.
operationId: skills-3
produces:
- application/json
@@ -2991,9 +3071,11 @@ paths:
security:
- ApiKeyAuth: []
summary: FFmpeg capabilities
tags:
- v16.7.2
/api/v3/skills/reload:
get:
description: Refresh the available FFmpeg capabilities
description: Refresh the available FFmpeg capabilities.
operationId: skills-3-reload
produces:
- application/json
@@ -3005,6 +3087,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Refresh FFmpeg capabilities
tags:
- v16.7.2
/api/v3/srt:
get:
description: List all currently publishing SRT streams. This endpoint is EXPERIMENTAL
@@ -3022,6 +3106,8 @@ paths:
security:
- ApiKeyAuth: []
summary: List all publishing SRT treams
tags:
- v16.9.0
/api/v3/widget/process/{id}:
get:
description: Fetch minimal statistics about a process, which is not protected
@@ -3045,6 +3131,8 @@ paths:
schema:
$ref: '#/definitions/api.Error'
summary: Fetch minimal statistics about a process
tags:
- v16.7.2
/memfs/{path}:
delete:
description: Remove a file from the memory filesystem