mirror of
https://github.com/plankanban/planka.git
synced 2025-12-22 09:15:37 +03:00
docs: Add base path for API endpoints to Swagger
This commit is contained in:
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/lists/{id}/clear:
|
||||
* /lists/{id}/clear:
|
||||
* post:
|
||||
* summary: Clear list
|
||||
* description: Deletes all cards from a list. Only works with trash-type lists. Requires project manager or board editor permissions.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/boards/{boardId}/lists:
|
||||
* /boards/{boardId}/lists:
|
||||
* post:
|
||||
* summary: Create list
|
||||
* description: Creates a list within a board. Requires board editor permissions.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/lists/{id}:
|
||||
* /lists/{id}:
|
||||
* delete:
|
||||
* summary: Delete list
|
||||
* description: Deletes a list and moves its cards to a trash list. Can only delete finite lists. Requires board editor permissions.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/lists/{id}/move-cards:
|
||||
* /lists/{id}/move-cards:
|
||||
* post:
|
||||
* summary: Move cards
|
||||
* description: Moves all cards from a closed list to an archive list. Requires board editor permissions.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/lists/{id}:
|
||||
* /lists/{id}:
|
||||
* get:
|
||||
* summary: Get list details
|
||||
* description: Retrieves comprehensive list information, including cards, attachments, and other related data. Requires access to the board.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/lists/{id}/sort:
|
||||
* /lists/{id}/sort:
|
||||
* post:
|
||||
* summary: Sort cards in list
|
||||
* description: Sorts all cards within a list. Requires board editor permissions.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/lists/{id}:
|
||||
* /lists/{id}:
|
||||
* patch:
|
||||
* summary: Update list
|
||||
* description: Updates a list. Can move lists between boards. Requires board editor permissions.
|
||||
|
||||
Reference in New Issue
Block a user