mirror of
https://github.com/lifegpc/eh-downloader.git
synced 2026-06-06 05:38:44 +08:00
feat: Add websocket tags and real-time log endpoint, update Swagger UI tags sorter
This commit is contained in:
27
api.yml
27
api.yml
@@ -1422,7 +1422,7 @@ paths:
|
|||||||
{ "ok": false, "status": 403, "error": "Permission denied." }
|
{ "ok": false, "status": 403, "error": "Permission denied." }
|
||||||
/config:
|
/config:
|
||||||
get:
|
get:
|
||||||
tags: [config, admin]
|
tags: [config, admin, websocket]
|
||||||
operationId: getConfig
|
operationId: getConfig
|
||||||
summary: Get server's configuration
|
summary: Get server's configuration
|
||||||
parameters:
|
parameters:
|
||||||
@@ -2842,6 +2842,29 @@ paths:
|
|||||||
$ref: "#/components/schemas/ApiResponseError"
|
$ref: "#/components/schemas/ApiResponseError"
|
||||||
example:
|
example:
|
||||||
{ "ok": false, "status": 404, "error": "log not found." }
|
{ "ok": false, "status": 404, "error": "log not found." }
|
||||||
|
/log/realtime:
|
||||||
|
get:
|
||||||
|
tags: [logs, websocket]
|
||||||
|
summary: Create a websocket connection to receive real-time log
|
||||||
|
operationId: getRealtimeLogs
|
||||||
|
responses:
|
||||||
|
"101":
|
||||||
|
description: Switching Protocols to websocket
|
||||||
|
"401":
|
||||||
|
description: Authorization information is missing or invalid
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/ApiResponseError"
|
||||||
|
example: { "ok": false, "status": 401, "error": "Unauthorized" }
|
||||||
|
"403":
|
||||||
|
description: Permission denied
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/ApiResponseError"
|
||||||
|
example:
|
||||||
|
{ "ok": false, "status": 403, "error": "Permission denied." }
|
||||||
/shared_token:
|
/shared_token:
|
||||||
delete:
|
delete:
|
||||||
tags: [token]
|
tags: [token]
|
||||||
@@ -3202,7 +3225,7 @@ paths:
|
|||||||
{ "ok": false, "status": 403, "error": "Permission denied." }
|
{ "ok": false, "status": 403, "error": "Permission denied." }
|
||||||
/task:
|
/task:
|
||||||
get:
|
get:
|
||||||
tags: [task]
|
tags: [task, websocket]
|
||||||
operationId: createTaskConnection
|
operationId: createTaskConnection
|
||||||
summary: Create a websocket connection to receive task event
|
summary: Create a websocket connection to receive task event
|
||||||
responses:
|
responses:
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ window.onload = function() {
|
|||||||
],
|
],
|
||||||
layout: "StandaloneLayout",
|
layout: "StandaloneLayout",
|
||||||
validatorUrl: null,
|
validatorUrl: null,
|
||||||
|
tagsSorter: 'alpha',
|
||||||
});
|
});
|
||||||
|
|
||||||
//</editor-fold>
|
//</editor-fold>
|
||||||
|
|||||||
Reference in New Issue
Block a user