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

Add process report API

Browse Source
This commit is contained in:
Ingo Oppermann
2023-03-02 11:15:57 +01:00
parent cceb39192a
commit 0dedcddece
10 changed files with 499 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
docs/docs.go
View File

@@ -1664,14 +1664,14 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "Get the logs and the log history of a process.",
"description": "Get the log history entry of a process at a certain time.",
"produces": [
"application/json"
],
"tags": [
"v16.?.?"
],
"summary": "Get the logs of a process",
"summary": "Get the log history entry of a process",
"operationId": "process-3-get-report-at",
"parameters": [
{
@@ -1680,13 +1680,20 @@ const docTemplate = `{
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Unix timestamp",
"name": "at",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.ProcessReport"
"$ref": "#/definitions/api.ProcessReportHistoryEntry"
}
},
"400": {
@@ -1751,6 +1758,73 @@ const docTemplate = `{
}
}
},
"/api/v3/report/process": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Search log history of all processes by providing patterns for process IDs and references, a state and a time range. All are optional.",
"produces": [
"application/json"
],
"tags": [
"v16.?.?"
],
"summary": "Search log history of all processes",
"operationId": "process-3-search-report-history",
"parameters": [
{
"type": "string",
"description": "Glob pattern for process IDs. If empty all IDs will be returned. Intersected with results from refpattern.",
"name": "idpattern",
"in": "query"
},
{
"type": "string",
"description": "Glob pattern for process references. If empty all IDs will be returned. Intersected with results from idpattern.",
"name": "refpattern",
"in": "query"
},
{
"type": "string",
"description": "State of a process, leave empty for any",
"name": "state",
"in": "query"
},
{
"type": "integer",
"description": "Search range of when the report has been created, older than this value. Unix timestamp, leave empty for any",
"name": "from",
"in": "query"
},
{
"type": "integer",
"description": "Search range of when the report has been created, younger than this value. Unix timestamp, leave empty for any",
"name": "to",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/api.ProcessReportSearchResult"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/api/v3/rtmp": {
"get": {
"security": [
@@ -3254,6 +3328,24 @@ const docTemplate = `{
}
}
},
"api.ProcessReportSearchResult": {
"type": "object",
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"exit_state": {
"type": "string"
},
"id": {
"type": "string"
},
"reference": {
"type": "string"
}
}
},
"api.ProcessState": {
"type": "object",
"properties": {