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

Update swagger API documentation

Browse Source
This commit is contained in:
Ingo Oppermann
2023-01-10 19:03:26 +01:00
parent 1bbb7a9c1f
commit 481cd79e6d
3 changed files with 92 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/docs.go
View File

@@ -229,7 +229,7 @@ const docTemplate = `{
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.Config"
"$ref": "#/definitions/github_com_datarhei_core_v16_http_api.Config"
}
}
}
@@ -2470,29 +2470,6 @@ const docTemplate = `{
}
}
},
"api.Config": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/api.ConfigData"
},
"created_at": {
"type": "string"
},
"loaded_at": {
"type": "string"
},
"overrides": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_at": {
"type": "string"
}
}
},
"api.ConfigData": {
"type": "object",
"properties": {
@@ -2602,6 +2579,9 @@ const docTemplate = `{
"force_gc": {
"type": "integer"
},
"memory_limit_mbytes": {
"type": "integer"
},
"profiling": {
"type": "boolean"
}
@@ -3623,7 +3603,11 @@ const docTemplate = `{
},
"avstream": {
"description": "avstream",
"$ref": "#/definitions/api.AVstream"
"allOf": [
{
"$ref": "#/definitions/api.AVstream"
}
]
},
"bitrate_kbit": {
"description": "kbit/s",
@@ -4230,6 +4214,9 @@ const docTemplate = `{
"force_gc": {
"type": "integer"
},
"memory_limit_mbytes": {
"type": "integer"
},
"profiling": {
"type": "boolean"
}
@@ -4873,6 +4860,29 @@ const docTemplate = `{
}
}
},
"github_com_datarhei_core_v16_http_api.Config": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/api.ConfigData"
},
"created_at": {
"type": "string"
},
"loaded_at": {
"type": "string"
},
"overrides": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_at": {
"type": "string"
}
}
},
"value.Auth0Tenant": {
"type": "object",
"properties": {

60
docs/swagger.json
View File

@@ -221,7 +221,7 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.Config"
"$ref": "#/definitions/github_com_datarhei_core_v16_http_api.Config"
}
}
}
@@ -2462,29 +2462,6 @@
}
}
},
"api.Config": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/api.ConfigData"
},
"created_at": {
"type": "string"
},
"loaded_at": {
"type": "string"
},
"overrides": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_at": {
"type": "string"
}
}
},
"api.ConfigData": {
"type": "object",
"properties": {
@@ -2594,6 +2571,9 @@
"force_gc": {
"type": "integer"
},
"memory_limit_mbytes": {
"type": "integer"
},
"profiling": {
"type": "boolean"
}
@@ -3615,7 +3595,11 @@
},
"avstream": {
"description": "avstream",
"$ref": "#/definitions/api.AVstream"
"allOf": [
{
"$ref": "#/definitions/api.AVstream"
}
]
},
"bitrate_kbit": {
"description": "kbit/s",
@@ -4222,6 +4206,9 @@
"force_gc": {
"type": "integer"
},
"memory_limit_mbytes": {
"type": "integer"
},
"profiling": {
"type": "boolean"
}
@@ -4865,6 +4852,29 @@
}
}
},
"github_com_datarhei_core_v16_http_api.Config": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/api.ConfigData"
},
"created_at": {
"type": "string"
},
"loaded_at": {
"type": "string"
},
"overrides": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_at": {
"type": "string"
}
}
},
"value.Auth0Tenant": {
"type": "object",
"properties": {

39
docs/swagger.yaml
View File

@@ -68,21 +68,6 @@ definitions:
required:
- command
type: object
api.Config:
properties:
config:
$ref: '#/definitions/api.ConfigData'
created_at:
type: string
loaded_at:
type: string
overrides:
items:
type: string
type: array
updated_at:
type: string
type: object
api.ConfigData:
properties:
address:
@@ -153,6 +138,8 @@ definitions:
properties:
force_gc:
type: integer
memory_limit_mbytes:
type: integer
profiling:
type: boolean
type: object
@@ -823,7 +810,8 @@ definitions:
address:
type: string
avstream:
$ref: '#/definitions/api.AVstream'
allOf:
- $ref: '#/definitions/api.AVstream'
description: avstream
bitrate_kbit:
description: kbit/s
@@ -1278,6 +1266,8 @@ definitions:
properties:
force_gc:
type: integer
memory_limit_mbytes:
type: integer
profiling:
type: boolean
type: object
@@ -1695,6 +1685,21 @@ definitions:
uptime:
type: integer
type: object
github_com_datarhei_core_v16_http_api.Config:
properties:
config:
$ref: '#/definitions/api.ConfigData'
created_at:
type: string
loaded_at:
type: string
overrides:
items:
type: string
type: array
updated_at:
type: string
type: object
value.Auth0Tenant:
properties:
audience:
@@ -1876,7 +1881,7 @@ paths:
"200":
description: OK
schema:
$ref: '#/definitions/api.Config'
$ref: '#/definitions/github_com_datarhei_core_v16_http_api.Config'
security:
- ApiKeyAuth: []
summary: Retrieve the currently active Restreamer configuration