mirror of
https://github.com/datarhei/core.git
synced 2025-10-04 07:37:33 +08:00
Update API docs
This commit is contained in:
Ingo Oppermann
@@ -1307,6 +1307,14 @@ const docTemplateClusterAPI = `{
|
||||
"description": "percent",
|
||||
"type": "number"
|
||||
},
|
||||
"limitGPU": {
|
||||
"description": "GPU limits",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/app.ConfigLimitGPU"
|
||||
}
|
||||
]
|
||||
},
|
||||
"limitMemory": {
|
||||
"description": "bytes",
|
||||
"type": "integer"
|
||||
@@ -1401,6 +1409,27 @@ const docTemplateClusterAPI = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"app.ConfigLimitGPU": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"decoder": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"encoder": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"memory": {
|
||||
"description": "bytes",
|
||||
"type": "integer"
|
||||
},
|
||||
"usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"client.AddIdentityRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -1669,6 +1698,26 @@ const docTemplateClusterAPI = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"compress": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"encoding": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"mimetypes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"min_length": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"created_at": {
|
||||
"description": "When this config has been persisted",
|
||||
"type": "string"
|
||||
@@ -1861,6 +1910,14 @@ const docTemplateClusterAPI = `{
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
|
||||
@@ -1300,6 +1300,14 @@
|
||||
"description": "percent",
|
||||
"type": "number"
|
||||
},
|
||||
"limitGPU": {
|
||||
"description": "GPU limits",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/app.ConfigLimitGPU"
|
||||
}
|
||||
]
|
||||
},
|
||||
"limitMemory": {
|
||||
"description": "bytes",
|
||||
"type": "integer"
|
||||
@@ -1394,6 +1402,27 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"app.ConfigLimitGPU": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"decoder": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"encoder": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"memory": {
|
||||
"description": "bytes",
|
||||
"type": "integer"
|
||||
},
|
||||
"usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"client.AddIdentityRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -1662,6 +1691,26 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"compress": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"encoding": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"mimetypes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"min_length": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"created_at": {
|
||||
"description": "When this config has been persisted",
|
||||
"type": "string"
|
||||
@@ -1854,6 +1903,14 @@
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
|
||||
@@ -17,6 +17,10 @@ definitions:
|
||||
limitCPU:
|
||||
description: percent
|
||||
type: number
|
||||
limitGPU:
|
||||
allOf:
|
||||
- $ref: '#/definitions/app.ConfigLimitGPU'
|
||||
description: GPU limits
|
||||
limitMemory:
|
||||
description: bytes
|
||||
type: integer
|
||||
@@ -81,6 +85,21 @@ definitions:
|
||||
purgeOnDelete:
|
||||
type: boolean
|
||||
type: object
|
||||
app.ConfigLimitGPU:
|
||||
properties:
|
||||
decoder:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
encoder:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
memory:
|
||||
description: bytes
|
||||
type: integer
|
||||
usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
type: object
|
||||
client.AddIdentityRequest:
|
||||
properties:
|
||||
identity:
|
||||
@@ -256,6 +275,19 @@ definitions:
|
||||
format: int64
|
||||
type: integer
|
||||
type: object
|
||||
compress:
|
||||
properties:
|
||||
encoding:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
mimetypes:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
min_length:
|
||||
type: integer
|
||||
type: object
|
||||
created_at:
|
||||
description: When this config has been persisted
|
||||
type: string
|
||||
@@ -387,6 +419,12 @@ definitions:
|
||||
max_cpu_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
max_gpu_memory_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
max_gpu_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
max_memory_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
|
||||
133
docs/docs.go
133
docs/docs.go
@@ -5726,6 +5726,26 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"compress": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"encoding": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"mimetypes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"min_length": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"created_at": {
|
||||
"description": "When this config has been persisted",
|
||||
"type": "string"
|
||||
@@ -5918,6 +5938,14 @@ const docTemplate = `{
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
@@ -7056,6 +7084,19 @@ const docTemplate = `{
|
||||
"cpu_usage": {
|
||||
"type": "number"
|
||||
},
|
||||
"gpu_decoder": {
|
||||
"type": "number"
|
||||
},
|
||||
"gpu_encoder": {
|
||||
"type": "number"
|
||||
},
|
||||
"gpu_memory_mbytes": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
},
|
||||
"gpu_usage": {
|
||||
"type": "number"
|
||||
},
|
||||
"memory_mbytes": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
@@ -7230,6 +7271,9 @@ const docTemplate = `{
|
||||
"cpu_usage": {
|
||||
"$ref": "#/definitions/api.ProcessUsageCPU"
|
||||
},
|
||||
"gpu": {
|
||||
"$ref": "#/definitions/api.ProcessUsageGPU"
|
||||
},
|
||||
"memory_bytes": {
|
||||
"$ref": "#/definitions/api.ProcessUsageMemory"
|
||||
}
|
||||
@@ -7258,12 +7302,71 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"api.ProcessUsageMemory": {
|
||||
"api.ProcessUsageGPU": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"decoder": {
|
||||
"$ref": "#/definitions/api.ProcessUsageGPUUsage"
|
||||
},
|
||||
"encoder": {
|
||||
"$ref": "#/definitions/api.ProcessUsageGPUUsage"
|
||||
},
|
||||
"index": {
|
||||
"type": "integer"
|
||||
},
|
||||
"memory_bytes": {
|
||||
"$ref": "#/definitions/api.ProcessUsageGPUMemory"
|
||||
},
|
||||
"usage": {
|
||||
"$ref": "#/definitions/api.ProcessUsageGPUUsage"
|
||||
}
|
||||
}
|
||||
},
|
||||
"api.ProcessUsageGPUMemory": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"avg": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
},
|
||||
"cur": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
},
|
||||
"limit": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
},
|
||||
"max": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
}
|
||||
}
|
||||
},
|
||||
"api.ProcessUsageGPUUsage": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"avg": {
|
||||
"type": "number"
|
||||
},
|
||||
"cur": {
|
||||
"type": "number"
|
||||
},
|
||||
"limit": {
|
||||
"type": "number"
|
||||
},
|
||||
"max": {
|
||||
"type": "number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"api.ProcessUsageMemory": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"avg": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
},
|
||||
"cur": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
@@ -8113,6 +8216,26 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"compress": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"encoding": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"mimetypes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"min_length": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"created_at": {
|
||||
"description": "When this config has been persisted",
|
||||
"type": "string"
|
||||
@@ -8305,6 +8428,14 @@ const docTemplate = `{
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
|
||||
@@ -5719,6 +5719,26 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"compress": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"encoding": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"mimetypes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"min_length": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"created_at": {
|
||||
"description": "When this config has been persisted",
|
||||
"type": "string"
|
||||
@@ -5911,6 +5931,14 @@
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
@@ -7049,6 +7077,19 @@
|
||||
"cpu_usage": {
|
||||
"type": "number"
|
||||
},
|
||||
"gpu_decoder": {
|
||||
"type": "number"
|
||||
},
|
||||
"gpu_encoder": {
|
||||
"type": "number"
|
||||
},
|
||||
"gpu_memory_mbytes": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
},
|
||||
"gpu_usage": {
|
||||
"type": "number"
|
||||
},
|
||||
"memory_mbytes": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
@@ -7223,6 +7264,9 @@
|
||||
"cpu_usage": {
|
||||
"$ref": "#/definitions/api.ProcessUsageCPU"
|
||||
},
|
||||
"gpu": {
|
||||
"$ref": "#/definitions/api.ProcessUsageGPU"
|
||||
},
|
||||
"memory_bytes": {
|
||||
"$ref": "#/definitions/api.ProcessUsageMemory"
|
||||
}
|
||||
@@ -7251,12 +7295,71 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"api.ProcessUsageMemory": {
|
||||
"api.ProcessUsageGPU": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"decoder": {
|
||||
"$ref": "#/definitions/api.ProcessUsageGPUUsage"
|
||||
},
|
||||
"encoder": {
|
||||
"$ref": "#/definitions/api.ProcessUsageGPUUsage"
|
||||
},
|
||||
"index": {
|
||||
"type": "integer"
|
||||
},
|
||||
"memory_bytes": {
|
||||
"$ref": "#/definitions/api.ProcessUsageGPUMemory"
|
||||
},
|
||||
"usage": {
|
||||
"$ref": "#/definitions/api.ProcessUsageGPUUsage"
|
||||
}
|
||||
}
|
||||
},
|
||||
"api.ProcessUsageGPUMemory": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"avg": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
},
|
||||
"cur": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
},
|
||||
"limit": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
},
|
||||
"max": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
}
|
||||
}
|
||||
},
|
||||
"api.ProcessUsageGPUUsage": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"avg": {
|
||||
"type": "number"
|
||||
},
|
||||
"cur": {
|
||||
"type": "number"
|
||||
},
|
||||
"limit": {
|
||||
"type": "number"
|
||||
},
|
||||
"max": {
|
||||
"type": "number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"api.ProcessUsageMemory": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"avg": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
},
|
||||
"cur": {
|
||||
"type": "integer",
|
||||
"format": "uint64"
|
||||
@@ -8106,6 +8209,26 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"compress": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"encoding": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"mimetypes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"min_length": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"created_at": {
|
||||
"description": "When this config has been persisted",
|
||||
"type": "string"
|
||||
@@ -8298,6 +8421,14 @@
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_gpu_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
},
|
||||
"max_memory_usage": {
|
||||
"description": "percent 0-100",
|
||||
"type": "number"
|
||||
|
||||
@@ -444,6 +444,19 @@ definitions:
|
||||
format: int64
|
||||
type: integer
|
||||
type: object
|
||||
compress:
|
||||
properties:
|
||||
encoding:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
mimetypes:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
min_length:
|
||||
type: integer
|
||||
type: object
|
||||
created_at:
|
||||
description: When this config has been persisted
|
||||
type: string
|
||||
@@ -575,6 +588,12 @@ definitions:
|
||||
max_cpu_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
max_gpu_memory_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
max_gpu_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
max_memory_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
@@ -1339,6 +1358,15 @@ definitions:
|
||||
properties:
|
||||
cpu_usage:
|
||||
type: number
|
||||
gpu_decoder:
|
||||
type: number
|
||||
gpu_encoder:
|
||||
type: number
|
||||
gpu_memory_mbytes:
|
||||
format: uint64
|
||||
type: integer
|
||||
gpu_usage:
|
||||
type: number
|
||||
memory_mbytes:
|
||||
format: uint64
|
||||
type: integer
|
||||
@@ -1457,6 +1485,8 @@ definitions:
|
||||
properties:
|
||||
cpu_usage:
|
||||
$ref: '#/definitions/api.ProcessUsageCPU'
|
||||
gpu:
|
||||
$ref: '#/definitions/api.ProcessUsageGPU'
|
||||
memory_bytes:
|
||||
$ref: '#/definitions/api.ProcessUsageMemory'
|
||||
type: object
|
||||
@@ -1475,10 +1505,50 @@ definitions:
|
||||
throttling:
|
||||
type: boolean
|
||||
type: object
|
||||
api.ProcessUsageMemory:
|
||||
api.ProcessUsageGPU:
|
||||
properties:
|
||||
decoder:
|
||||
$ref: '#/definitions/api.ProcessUsageGPUUsage'
|
||||
encoder:
|
||||
$ref: '#/definitions/api.ProcessUsageGPUUsage'
|
||||
index:
|
||||
type: integer
|
||||
memory_bytes:
|
||||
$ref: '#/definitions/api.ProcessUsageGPUMemory'
|
||||
usage:
|
||||
$ref: '#/definitions/api.ProcessUsageGPUUsage'
|
||||
type: object
|
||||
api.ProcessUsageGPUMemory:
|
||||
properties:
|
||||
avg:
|
||||
format: uint64
|
||||
type: integer
|
||||
cur:
|
||||
format: uint64
|
||||
type: integer
|
||||
limit:
|
||||
format: uint64
|
||||
type: integer
|
||||
max:
|
||||
format: uint64
|
||||
type: integer
|
||||
type: object
|
||||
api.ProcessUsageGPUUsage:
|
||||
properties:
|
||||
avg:
|
||||
type: number
|
||||
cur:
|
||||
type: number
|
||||
limit:
|
||||
type: number
|
||||
max:
|
||||
type: number
|
||||
type: object
|
||||
api.ProcessUsageMemory:
|
||||
properties:
|
||||
avg:
|
||||
format: uint64
|
||||
type: integer
|
||||
cur:
|
||||
format: uint64
|
||||
type: integer
|
||||
@@ -2122,6 +2192,19 @@ definitions:
|
||||
format: int64
|
||||
type: integer
|
||||
type: object
|
||||
compress:
|
||||
properties:
|
||||
encoding:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
mimetypes:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
min_length:
|
||||
type: integer
|
||||
type: object
|
||||
created_at:
|
||||
description: When this config has been persisted
|
||||
type: string
|
||||
@@ -2253,6 +2336,12 @@ definitions:
|
||||
max_cpu_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
max_gpu_memory_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
max_gpu_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
max_memory_usage:
|
||||
description: percent 0-100
|
||||
type: number
|
||||
|
||||
Reference in New Issue
Block a user