Pi-Hole/FTL
1
0
Fork 0
mirror of https://github.com/pi-hole/FTL.git synced 2025-12-20 06:58:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2689 from pi-hole/list_doc

Browse Source 
Be more explicit about required path and query parameters for list manipulation
This commit is contained in:
Dominik
2025-11-01 18:54:50 +01:00
committed by GitHub
parent 1f78a7093d 9c3aed725c
commit 75c53eb2ed
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/api/docs/content/specs/lists.yaml
View File

@@ -46,7 +46,7 @@ components:
- "List management" - "List management"
operationId: "replace_lists" operationId: "replace_lists"
description: | description: |
Items may be updated by replacing them. `{list}` is required. Items may be updated by replacing them. `{list}` and `{listtype}` are required.
Ensure to send all the required parameters (such as `comment`) to ensure these properties are retained. Ensure to send all the required parameters (such as `comment`) to ensure these properties are retained.
The read-only fields `id` and `date_added` are preserved, `date_modified` is automatically updated on success. The read-only fields `id` and `date_added` are preserved, `date_modified` is automatically updated on success.
@@ -96,6 +96,7 @@ components:
- "List management" - "List management"
operationId: "delete_lists" operationId: "delete_lists"
description: | description: |
`{list}` and `{listtype}` are required.
*Note:* There will be no content on success. *Note:* There will be no content on success.
responses: responses:
'204': '204':