From 01697669ac9c99ffc8faa3c55d36f2c4bc0de0e2 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Fri, 3 May 2024 20:05:00 +0200 Subject: [PATCH] API /clients: Add note that {client} needs to be URI-encoded (if specified) and add documentation of read-only optional {name0} field Signed-off-by: DL6ER --- src/api/docs/content/specs/clients.yaml | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/src/api/docs/content/specs/clients.yaml b/src/api/docs/content/specs/clients.yaml index 72f0a471..687cb2cb 100644 --- a/src/api/docs/content/specs/clients.yaml +++ b/src/api/docs/content/specs/clients.yaml @@ -11,7 +11,7 @@ components: - "Client management" operationId: "get_clients" description: | - `{client}` is optional. Specifying it will result in only the requested client being returned. + `{client}` is optional. If it is specified, it will result in only the requested client being returned. This parameter needs to be URI-encoded. Valid combinations are: - `/api/clients` (all clients) @@ -42,7 +42,7 @@ components: - "Client management" operationId: "replace_client" description: | - Items may be updated by replacing them. `{client}` is required. + Items may be updated by replacing them. `{client}` is required and needs to be URI-encoded. Ensure to send all the required parameters (such as `comment` or `groups`) to ensure these properties are retained. The read-only fields `id` and `date_added` are preserved, `date_modified` is automatically updated on success. @@ -91,7 +91,7 @@ components: - "Client management" operationId: "delete_client" description: | - *Note:* There will be no content on success. + *Note:* There will be no content on success. `{client}` is required and needs to be URI-encoded. responses: '204': description: Item deleted @@ -383,6 +383,12 @@ components: type: integer readOnly: true example: 1611239099 + name: + description: hostname (only if available) + type: string + readOnly: true + nullable: true + example: localhost lists_processed: type: object properties: