Update swagger API documentation
This commit is contained in:
parent
1bbb7a9c1f
commit
481cd79e6d
3 changed files with 92 additions and 67 deletions
60
docs/docs.go
60
docs/docs.go
|
|
@ -229,7 +229,7 @@ const docTemplate = `{
|
||||||
"200": {
|
"200": {
|
||||||
"description": "OK",
|
"description": "OK",
|
||||||
"schema": {
|
"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": {
|
"api.ConfigData": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|
@ -2602,6 +2579,9 @@ const docTemplate = `{
|
||||||
"force_gc": {
|
"force_gc": {
|
||||||
"type": "integer"
|
"type": "integer"
|
||||||
},
|
},
|
||||||
|
"memory_limit_mbytes": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
"profiling": {
|
"profiling": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
}
|
}
|
||||||
|
|
@ -3623,7 +3603,11 @@ const docTemplate = `{
|
||||||
},
|
},
|
||||||
"avstream": {
|
"avstream": {
|
||||||
"description": "avstream",
|
"description": "avstream",
|
||||||
"$ref": "#/definitions/api.AVstream"
|
"allOf": [
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/api.AVstream"
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"bitrate_kbit": {
|
"bitrate_kbit": {
|
||||||
"description": "kbit/s",
|
"description": "kbit/s",
|
||||||
|
|
@ -4230,6 +4214,9 @@ const docTemplate = `{
|
||||||
"force_gc": {
|
"force_gc": {
|
||||||
"type": "integer"
|
"type": "integer"
|
||||||
},
|
},
|
||||||
|
"memory_limit_mbytes": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
"profiling": {
|
"profiling": {
|
||||||
"type": "boolean"
|
"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": {
|
"value.Auth0Tenant": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|
|
||||||
|
|
@ -221,7 +221,7 @@
|
||||||
"200": {
|
"200": {
|
||||||
"description": "OK",
|
"description": "OK",
|
||||||
"schema": {
|
"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": {
|
"api.ConfigData": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|
@ -2594,6 +2571,9 @@
|
||||||
"force_gc": {
|
"force_gc": {
|
||||||
"type": "integer"
|
"type": "integer"
|
||||||
},
|
},
|
||||||
|
"memory_limit_mbytes": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
"profiling": {
|
"profiling": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
}
|
}
|
||||||
|
|
@ -3615,7 +3595,11 @@
|
||||||
},
|
},
|
||||||
"avstream": {
|
"avstream": {
|
||||||
"description": "avstream",
|
"description": "avstream",
|
||||||
"$ref": "#/definitions/api.AVstream"
|
"allOf": [
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/api.AVstream"
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"bitrate_kbit": {
|
"bitrate_kbit": {
|
||||||
"description": "kbit/s",
|
"description": "kbit/s",
|
||||||
|
|
@ -4222,6 +4206,9 @@
|
||||||
"force_gc": {
|
"force_gc": {
|
||||||
"type": "integer"
|
"type": "integer"
|
||||||
},
|
},
|
||||||
|
"memory_limit_mbytes": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
"profiling": {
|
"profiling": {
|
||||||
"type": "boolean"
|
"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": {
|
"value.Auth0Tenant": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|
|
||||||
|
|
@ -68,21 +68,6 @@ definitions:
|
||||||
required:
|
required:
|
||||||
- command
|
- command
|
||||||
type: object
|
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:
|
api.ConfigData:
|
||||||
properties:
|
properties:
|
||||||
address:
|
address:
|
||||||
|
|
@ -153,6 +138,8 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
force_gc:
|
force_gc:
|
||||||
type: integer
|
type: integer
|
||||||
|
memory_limit_mbytes:
|
||||||
|
type: integer
|
||||||
profiling:
|
profiling:
|
||||||
type: boolean
|
type: boolean
|
||||||
type: object
|
type: object
|
||||||
|
|
@ -823,7 +810,8 @@ definitions:
|
||||||
address:
|
address:
|
||||||
type: string
|
type: string
|
||||||
avstream:
|
avstream:
|
||||||
$ref: '#/definitions/api.AVstream'
|
allOf:
|
||||||
|
- $ref: '#/definitions/api.AVstream'
|
||||||
description: avstream
|
description: avstream
|
||||||
bitrate_kbit:
|
bitrate_kbit:
|
||||||
description: kbit/s
|
description: kbit/s
|
||||||
|
|
@ -1278,6 +1266,8 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
force_gc:
|
force_gc:
|
||||||
type: integer
|
type: integer
|
||||||
|
memory_limit_mbytes:
|
||||||
|
type: integer
|
||||||
profiling:
|
profiling:
|
||||||
type: boolean
|
type: boolean
|
||||||
type: object
|
type: object
|
||||||
|
|
@ -1695,6 +1685,21 @@ definitions:
|
||||||
uptime:
|
uptime:
|
||||||
type: integer
|
type: integer
|
||||||
type: object
|
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:
|
value.Auth0Tenant:
|
||||||
properties:
|
properties:
|
||||||
audience:
|
audience:
|
||||||
|
|
@ -1876,7 +1881,7 @@ paths:
|
||||||
"200":
|
"200":
|
||||||
description: OK
|
description: OK
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/api.Config'
|
$ref: '#/definitions/github_com_datarhei_core_v16_http_api.Config'
|
||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Retrieve the currently active Restreamer configuration
|
summary: Retrieve the currently active Restreamer configuration
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue