mirror of
https://github.com/plankanban/planka.git
synced 2025-12-22 09:15:37 +03:00
docs: Improve Swagger JSDoc
This commit is contained in:
@@ -11,6 +11,7 @@
|
||||
* description: Deletes all cards from a list. Only works with trash-type lists. Requires project manager or board editor permissions.
|
||||
* tags:
|
||||
* - Lists
|
||||
* operationId: clearList
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Creates a list within a board. Requires board editor permissions.
|
||||
* tags:
|
||||
* - Lists
|
||||
* operationId: createList
|
||||
* parameters:
|
||||
* - name: boardId
|
||||
* in: path
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Deletes a list and moves its cards to a trash list. Can only delete finite lists. Requires board editor permissions.
|
||||
* tags:
|
||||
* - Lists
|
||||
* operationId: deleteList
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Moves all cards from a closed list to an archive list. Requires board editor permissions.
|
||||
* tags:
|
||||
* - Lists
|
||||
* operationId: moveListCards
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Retrieves comprehensive list information, including cards, attachments, and other related data. Requires access to the board.
|
||||
* tags:
|
||||
* - Lists
|
||||
* operationId: getList
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Sorts all cards within a list. Requires board editor permissions.
|
||||
* tags:
|
||||
* - Lists
|
||||
* operationId: sortList
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Updates a list. Can move lists between boards. Requires board editor permissions.
|
||||
* tags:
|
||||
* - Lists
|
||||
* operationId: updateList
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
|
||||
Reference in New Issue
Block a user