Update openapi specification

This commit is contained in:
Ingo Oppermann
2024-09-05 13:58:59 +02:00
parent b0e932d77a
commit 0327edcaf3
7 changed files with 699 additions and 153 deletions

View File

@@ -1,5 +1,4 @@
// Code generated by swaggo/swag. DO NOT EDIT.
// Package docs Code generated by swaggo/swag. DO NOT EDIT
package docs
import "github.com/swaggo/swag"
@@ -404,6 +403,46 @@ const docTemplate = `{
}
}
},
"/api/v3/cluster/events": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Stream of events of whats happening on each node in the cluster",
"consumes": [
"application/json"
],
"produces": [
"text/event-stream",
"application/x-json-stream"
],
"tags": [
"v16.?.?"
],
"summary": "Stream of events",
"operationId": "cluster-3-events",
"parameters": [
{
"description": "Event filters",
"name": "filters",
"in": "body",
"schema": {
"$ref": "#/definitions/api.EventFilters"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.Event"
}
}
}
}
},
"/api/v3/cluster/fs/{storage}": {
"get": {
"security": [
@@ -1540,7 +1579,7 @@ const docTemplate = `{
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.Version"
"$ref": "#/definitions/api.AboutVersion"
}
},
"404": {
@@ -5039,6 +5078,14 @@ const docTemplate = `{
"type": "integer",
"format": "uint64"
},
"channels": {
"type": "integer",
"format": "uint64"
},
"codec": {
"description": "Codec parameter",
"type": "string"
},
"drop": {
"type": "integer",
"format": "uint64"
@@ -5057,9 +5104,19 @@ const docTemplate = `{
"gop": {
"type": "string"
},
"height": {
"type": "integer",
"format": "uint64"
},
"input": {
"$ref": "#/definitions/api.AVstreamIO"
},
"layout": {
"type": "string"
},
"level": {
"type": "integer"
},
"looping": {
"type": "boolean"
},
@@ -5073,9 +5130,26 @@ const docTemplate = `{
"output": {
"$ref": "#/definitions/api.AVstreamIO"
},
"pix_fmt": {
"type": "string"
},
"profile": {
"type": "integer"
},
"queue": {
"type": "integer",
"format": "uint64"
},
"sample_fmt": {
"type": "string"
},
"sampling_hz": {
"type": "integer",
"format": "uint64"
},
"width": {
"type": "integer",
"format": "uint64"
}
}
},
@@ -5123,11 +5197,79 @@ const docTemplate = `{
"name": {
"type": "string"
},
"resources": {
"$ref": "#/definitions/api.AboutResources"
},
"uptime_seconds": {
"type": "integer"
},
"version": {
"$ref": "#/definitions/api.Version"
"$ref": "#/definitions/api.AboutVersion"
}
}
},
"api.AboutResources": {
"type": "object",
"properties": {
"cpu_core": {
"description": "Current CPU load of the core itself, 0-100*ncpu",
"type": "number"
},
"cpu_limit": {
"description": "Defined CPU load limit, 0-100*ncpu",
"type": "number"
},
"cpu_used": {
"description": "Current CPU load, 0-100*ncpu",
"type": "number"
},
"is_throttling": {
"description": "Whether this core is currently throttling",
"type": "boolean"
},
"memory_core_bytes": {
"description": "Current used memory of the core itself in bytes",
"type": "integer"
},
"memory_limit_bytes": {
"description": "Defined memory limit in bytes",
"type": "integer"
},
"memory_total_bytes": {
"description": "Total available memory in bytes",
"type": "integer"
},
"memory_used_bytes": {
"description": "Currently used memory in bytes",
"type": "integer"
},
"ncpu": {
"description": "Number of CPU on this node",
"type": "number"
}
}
},
"api.AboutVersion": {
"type": "object",
"properties": {
"arch": {
"type": "string"
},
"build_date": {
"description": "RFC3339",
"type": "string"
},
"compiler": {
"type": "string"
},
"number": {
"type": "string"
},
"repository_branch": {
"type": "string"
},
"repository_commit": {
"type": "string"
}
}
},
@@ -5313,6 +5455,10 @@ const docTemplate = `{
"api.ClusterNodeResources": {
"type": "object",
"properties": {
"cpu_core": {
"description": "percent 0-100*ncpu",
"type": "number"
},
"cpu_limit": {
"description": "percent 0-100*npcu",
"type": "number"
@@ -5327,10 +5473,18 @@ const docTemplate = `{
"is_throttling": {
"type": "boolean"
},
"memory_core_bytes": {
"description": "bytes",
"type": "integer"
},
"memory_limit_bytes": {
"description": "bytes",
"type": "integer"
},
"memory_total_bytes": {
"description": "bytes",
"type": "integer"
},
"memory_used_bytes": {
"description": "bytes",
"type": "integer"
@@ -6089,6 +6243,9 @@ const docTemplate = `{
"caller": {
"type": "string"
},
"core_id": {
"type": "string"
},
"data": {
"type": "object",
"additionalProperties": {
@@ -6116,6 +6273,9 @@ const docTemplate = `{
"caller": {
"type": "string"
},
"core_id": {
"type": "string"
},
"data": {
"type": "object",
"additionalProperties": {
@@ -7243,6 +7403,9 @@ const docTemplate = `{
"layout": {
"type": "string"
},
"level": {
"type": "integer"
},
"packet": {
"type": "integer",
"format": "uint64"
@@ -7254,11 +7417,17 @@ const docTemplate = `{
"pps": {
"type": "number"
},
"profile": {
"type": "integer"
},
"q": {
"type": "number"
},
"sampling_hz": {
"sample_fmt": {
"description": "Audio",
"type": "string"
},
"sampling_hz": {
"type": "integer",
"format": "uint64"
},
@@ -8671,30 +8840,6 @@ const docTemplate = `{
}
}
},
"api.Version": {
"type": "object",
"properties": {
"arch": {
"type": "string"
},
"build_date": {
"description": "RFC3339",
"type": "string"
},
"compiler": {
"type": "string"
},
"number": {
"type": "string"
},
"repository_branch": {
"type": "string"
},
"repository_commit": {
"type": "string"
}
}
},
"api.WidgetProcess": {
"type": "object",
"properties": {