apps/core
1
0
Fork 0
mirror of https://github.com/datarhei/core.git synced 2025-10-03 15:16:39 +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": {