apps/core
1
0
Fork 0
mirror of https://github.com/datarhei/core.git synced 2025-12-24 13:07:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update API documentation

Browse Source
This commit is contained in:
Ingo Oppermann
2025-12-09 17:30:13 +01:00
parent b9639b90a1
commit 64dfd1c314
3 changed files with 202 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
docs/docs.go
View File

@@ -570,7 +570,7 @@ const docTemplate = `{
"v16.?.?"
],
"summary": "Stream of log events",
"operationId": "cluster-3-events",
"operationId": "cluster-3-events-log",
"parameters": [
{
"description": "Event filters",
@@ -591,6 +591,45 @@ const docTemplate = `{
}
}
},
"/api/v3/cluster/events/process": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Stream of process events of whats happening on each node in the cluster",
"consumes": [
"application/json"
],
"produces": [
"application/x-json-stream"
],
"tags": [
"v16.?.?"
],
"summary": "Stream of process events",
"operationId": "cluster-3-events-process",
"parameters": [
{
"description": "Event filters",
"name": "filters",
"in": "body",
"schema": {
"$ref": "#/definitions/api.ProcessEventFilters"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.ProcessEvent"
}
}
}
}
},
"/api/v3/cluster/fs/{storage}": {
"get": {
"security": [
@@ -7161,7 +7200,7 @@ const docTemplate = `{
"type": "string"
},
"level": {
"type": "integer"
"type": "string"
},
"message": {
"type": "string"
@@ -7732,6 +7771,9 @@ const docTemplate = `{
"api.ProcessEvent": {
"type": "object",
"properties": {
"core_id": {
"type": "string"
},
"domain": {
"type": "string"
},
@@ -7755,6 +7797,9 @@ const docTemplate = `{
"api.ProcessEventFilter": {
"type": "object",
"properties": {
"core_id": {
"type": "string"
},
"domain": {
"type": "string"
},
@@ -7811,23 +7856,43 @@ const docTemplate = `{
"api.ProcessProgressInput": {
"type": "object",
"properties": {
"avstream": {
"$ref": "#/definitions/api.ProcessProgressInputAVstream"
},
"bitrate": {
"type": "number"
},
"fps": {
"type": "number"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"api.ProcessProgressInputAVstream": {
"type": "object",
"properties": {
"drop": {
"type": "integer"
},
"dup": {
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"enc": {
"type": "integer"
},
"fps": {
"type": "number"
},
"looping": {
"type": "boolean"
},
"time": {
"type": "integer"
}
}
},
@@ -7839,6 +7904,12 @@ const docTemplate = `{
},
"fps": {
"type": "number"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
},

81
docs/swagger.json
View File

@@ -563,7 +563,7 @@
"v16.?.?"
],
"summary": "Stream of log events",
"operationId": "cluster-3-events",
"operationId": "cluster-3-events-log",
"parameters": [
{
"description": "Event filters",
@@ -584,6 +584,45 @@
}
}
},
"/api/v3/cluster/events/process": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Stream of process events of whats happening on each node in the cluster",
"consumes": [
"application/json"
],
"produces": [
"application/x-json-stream"
],
"tags": [
"v16.?.?"
],
"summary": "Stream of process events",
"operationId": "cluster-3-events-process",
"parameters": [
{
"description": "Event filters",
"name": "filters",
"in": "body",
"schema": {
"$ref": "#/definitions/api.ProcessEventFilters"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.ProcessEvent"
}
}
}
}
},
"/api/v3/cluster/fs/{storage}": {
"get": {
"security": [
@@ -7154,7 +7193,7 @@
"type": "string"
},
"level": {
"type": "integer"
"type": "string"
},
"message": {
"type": "string"
@@ -7725,6 +7764,9 @@
"api.ProcessEvent": {
"type": "object",
"properties": {
"core_id": {
"type": "string"
},
"domain": {
"type": "string"
},
@@ -7748,6 +7790,9 @@
"api.ProcessEventFilter": {
"type": "object",
"properties": {
"core_id": {
"type": "string"
},
"domain": {
"type": "string"
},
@@ -7804,23 +7849,43 @@
"api.ProcessProgressInput": {
"type": "object",
"properties": {
"avstream": {
"$ref": "#/definitions/api.ProcessProgressInputAVstream"
},
"bitrate": {
"type": "number"
},
"fps": {
"type": "number"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"api.ProcessProgressInputAVstream": {
"type": "object",
"properties": {
"drop": {
"type": "integer"
},
"dup": {
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"enc": {
"type": "integer"
},
"fps": {
"type": "number"
},
"looping": {
"type": "boolean"
},
"time": {
"type": "integer"
}
}
},
@@ -7832,6 +7897,12 @@
},
"fps": {
"type": "number"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
},

54
docs/swagger.yaml
View File

@@ -1141,7 +1141,7 @@ definitions:
event:
type: string
level:
type: integer
type: string
message:
type: string
ts:
@@ -1530,6 +1530,8 @@ definitions:
type: object
api.ProcessEvent:
properties:
core_id:
type: string
domain:
type: string
line:
@@ -1545,6 +1547,8 @@ definitions:
type: object
api.ProcessEventFilter:
properties:
core_id:
type: string
domain:
type: string
pid:
@@ -1581,18 +1585,31 @@ definitions:
type: object
api.ProcessProgressInput:
properties:
avstream:
$ref: '#/definitions/api.ProcessProgressInputAVstream'
bitrate:
type: number
fps:
type: number
id:
type: string
type:
type: string
type: object
api.ProcessProgressInputAVstream:
properties:
drop:
type: integer
dup:
type: integer
enabled:
type: boolean
enc:
type: integer
fps:
type: number
looping:
type: boolean
time:
type: integer
type: object
api.ProcessProgressOutput:
properties:
@@ -1600,6 +1617,10 @@ definitions:
type: number
fps:
type: number
id:
type: string
type:
type: string
type: object
api.ProcessReport:
properties:
@@ -3356,7 +3377,7 @@ paths:
consumes:
- application/json
description: Stream of log events of whats happening on each node in the cluster
operationId: cluster-3-events
operationId: cluster-3-events-log
parameters:
- description: Event filters
in: body
@@ -3376,6 +3397,31 @@ paths:
summary: Stream of log events
tags:
- v16.?.?
/api/v3/cluster/events/process:
post:
consumes:
- application/json
description: Stream of process events of whats happening on each node in the
cluster
operationId: cluster-3-events-process
parameters:
- description: Event filters
in: body
name: filters
schema:
$ref: '#/definitions/api.ProcessEventFilters'
produces:
- application/x-json-stream
responses:
"200":
description: OK
schema:
$ref: '#/definitions/api.ProcessEvent'
security:
- ApiKeyAuth: []
summary: Stream of process events
tags:
- v16.?.?
/api/v3/cluster/fs/{storage}:
get:
description: List all files on a filesystem. The listing can be ordered by name,