mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-10-29 14:45:24 +00:00
chore: openapi docs for undocumented routes and fix two broken doc blocks
This commit is contained in:
1 parent
5ecf8156e6
commit
de9b4a064c
9 files changed
+420
-5
No files matched your search
@@ -572,7 +572,6 @@ router.post(
|
||||
* authType:
|
||||
* type: string
|
||||
* description: Any registered SSH auth type that works for an unsaved host (password, key, credential, agent, none, or one a plugin marks for Quick Connect).
|
||||
* description: Authentication method
|
||||
* password:
|
||||
* type: string
|
||||
* description: Password (required if authType is password)
|
||||
@@ -1490,9 +1489,26 @@ router.get(
|
||||
);
|
||||
|
||||
/**
|
||||
* Returns the minimum authentication material needed by the desktop app to
|
||||
* connect to a shared host from the recipient's own network. The response is
|
||||
* deliberately transient: callers must not persist it or include it in logs.
|
||||
* @openapi
|
||||
* /host/db/host/{id}/local-connection-auth:
|
||||
* get:
|
||||
* summary: Get the login a desktop needs to reach a shared host itself
|
||||
* description: The minimum authentication material for connecting to a shared host from the recipient's own network. Transient; callers must not store or log it.
|
||||
* tags:
|
||||
* - SSH
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 200:
|
||||
* description: The connection auth.
|
||||
* 400:
|
||||
* description: Invalid id.
|
||||
* 404:
|
||||
* description: Shared host not found.
|
||||
*/
|
||||
router.get(
|
||||
"/db/host/:id/local-connection-auth",
|
||||
|
||||
@@ -671,6 +671,49 @@ router.delete(
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /rbac/host/{id}/access/{accessId}:
|
||||
* patch:
|
||||
* summary: Change a host access rule
|
||||
* description: Updates the permission level or the expiry of one share. Requires the right to manage sharing on the host.
|
||||
* tags:
|
||||
* - RBAC
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* - in: path
|
||||
* name: accessId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* permissionLevel:
|
||||
* type: string
|
||||
* enum: [connect, view, edit, manage]
|
||||
* durationHours:
|
||||
* type: number
|
||||
* nullable: true
|
||||
* description: Hours from now until the share expires. Null removes the expiry.
|
||||
* responses:
|
||||
* 200:
|
||||
* description: The updated rule.
|
||||
* 400:
|
||||
* description: Invalid id or nothing to change.
|
||||
* 403:
|
||||
* description: Not allowed to manage sharing on this host.
|
||||
* 404:
|
||||
* description: No such rule.
|
||||
*/
|
||||
router.patch(
|
||||
"/host/:id/access/:accessId",
|
||||
authenticateJWT,
|
||||
|
||||
Reference in new issue
Block a user