starred/planka
1
0
Fork 0
mirror of https://github.com/plankanban/planka.git synced 2025-12-19 17:23:27 +03:00
Code Issues 418 Packages Projects Releases 12 Wiki Activity

docs: Add full Swagger JSDoc coverage

Browse Source
This commit is contained in:
Maksim Eltyshev
2025-09-08 16:20:27 +02:00
parent e6b4c33542
commit 5ad3134519
128 changed files with 7610 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
server/api/controllers/task-lists/create.js
View File

@@ -3,6 +3,72 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/cards/{cardId}/task-lists:
* post:
* summary: Create task list
* description: Creates a task list within a card. Requires board editor permissions.
* tags:
* - Task Lists
* parameters:
* - name: cardId
* in: path
* required: true
* description: ID of the card to create task list in
* schema:
* type: string
* example: 1357158568008091264
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required:
* - position
* - name
* properties:
* position:
* type: number
* minimum: 0
* description: Position of the task list within the card
* example: 65536
* name:
* type: string
* maxLength: 128
* description: Name/title of the task list
* example: Development Tasks
* showOnFrontOfCard:
* type: boolean
* description: Whether to show the task list on the front of the card
* example: true
* hideCompletedTasks:
* type: boolean
* description: Whether to hide completed tasks
* example: false
* responses:
* 200:
* description: Task list created successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* properties:
* item:
* $ref: '#/components/schemas/TaskList'
* 400:
* $ref: '#/components/responses/ValidationError'
* 401:
* $ref: '#/components/responses/Unauthorized'
* 403:
* $ref: '#/components/responses/Forbidden'
* 404:
* $ref: '#/components/responses/NotFound'
*/
const { idInput } = require('../../../utils/inputs');
const Errors = {

38
server/api/controllers/task-lists/delete.js
View File

@@ -3,6 +3,44 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/task-lists/{id}:
* delete:
* summary: Delete task list
* description: Deletes a task list and all its tasks. Requires board editor permissions.
* tags:
* - Task Lists
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the task list to delete
* schema:
* type: string
* example: 1357158568008091264
* responses:
* 200:
* description: Task list deleted successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* properties:
* item:
* $ref: '#/components/schemas/TaskList'
* 400:
* $ref: '#/components/responses/ValidationError'
* 401:
* $ref: '#/components/responses/Unauthorized'
* 403:
* $ref: '#/components/responses/Forbidden'
* 404:
* $ref: '#/components/responses/NotFound'
*/
const { idInput } = require('../../../utils/inputs');
const Errors = {

47
server/api/controllers/task-lists/show.js
View File

@@ -3,6 +3,53 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/task-lists/{id}:
* get:
* summary: Get task list details
* description: Retrieves task list information, including tasks. Requires access to the card.
* tags:
* - Task Lists
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the task list to retrieve
* schema:
* type: string
* example: 1357158568008091264
* responses:
* 200:
* description: Task list details retrieved successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* - included
* properties:
* item:
* $ref: '#/components/schemas/TaskList'
* included:
* type: object
* required:
* - tasks
* properties:
* tasks:
* type: array
* description: Related tasks
* items:
* $ref: '#/components/schemas/Task'
* 400:
* $ref: '#/components/responses/ValidationError'
* 401:
* $ref: '#/components/responses/Unauthorized'
* 404:
* $ref: '#/components/responses/NotFound'
*/
const { idInput } = require('../../../utils/inputs');
const Errors = {

63
server/api/controllers/task-lists/update.js
View File

@@ -3,6 +3,69 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/task-lists/{id}:
* patch:
* summary: Update task list
* description: Updates a task list. Requires board editor permissions.
* tags:
* - Task Lists
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the task list to update
* schema:
* type: string
* example: 1357158568008091264
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* position:
* type: number
* minimum: 0
* description: Position of the task list within the card
* example: 65536
* name:
* type: string
* maxLength: 128
* description: Name/title of the task list
* example: Development Tasks
* showOnFrontOfCard:
* type: boolean
* description: Whether to show the task list on the front of the card
* example: true
* hideCompletedTasks:
* type: boolean
* description: Whether to hide completed tasks
* example: false
* responses:
* 200:
* description: Task list updated successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* properties:
* item:
* $ref: '#/components/schemas/TaskList'
* 400:
* $ref: '#/components/responses/ValidationError'
* 401:
* $ref: '#/components/responses/Unauthorized'
* 403:
* $ref: '#/components/responses/Forbidden'
* 404:
* $ref: '#/components/responses/NotFound'
*/
const { idInput } = require('../../../utils/inputs');
const Errors = {