starred/planka
1
0
Fork 0
mirror of https://github.com/plankanban/planka.git synced 2025-12-20 09:15:39 +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

38
server/api/controllers/lists/clear.js
View File

@@ -3,6 +3,44 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/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.
* tags:
* - Lists
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the list to clear (must be a trash-type list)
* schema:
* type: string
* example: 1357158568008091264
* responses:
* 200:
* description: List cleared successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* properties:
* item:
* $ref: '#/components/schemas/List'
* 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 = {

64
server/api/controllers/lists/create.js
View File

@@ -3,6 +3,70 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/boards/{boardId}/lists:
* post:
* summary: Create list
* description: Creates a list within a board. Requires board editor permissions.
* tags:
* - Lists
* parameters:
* - name: boardId
* in: path
* required: true
* description: ID of the board to create the list in
* schema:
* type: string
* example: 1357158568008091264
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required:
* - type
* - position
* - name
* properties:
* type:
* type: string
* enum: [active, closed]
* description: Type/status of the list
* example: active
* position:
* type: number
* minimum: 0
* description: Position of the list within the board
* example: 65536
* name:
* type: string
* maxLength: 128
* description: Name/title of the list
* example: To Do
* responses:
* 200:
* description: List created successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* properties:
* item:
* $ref: '#/components/schemas/List'
* 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 = {

49
server/api/controllers/lists/delete.js
View File

@@ -3,6 +3,55 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/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.
* tags:
* - Lists
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the list to delete
* schema:
* type: string
* example: 1357158568008091264
* responses:
* 200:
* description: List deleted successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* - included
* properties:
* item:
* $ref: '#/components/schemas/List'
* included:
* type: object
* required:
* - cards
* properties:
* cards:
* type: array
* description: Related cards
* items:
* $ref: '#/components/schemas/Card'
* 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 = {

68
server/api/controllers/lists/move-cards.js
View File

@@ -3,6 +3,74 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/lists/{id}/move-cards:
* post:
* summary: Move cards
* description: Moves all cards from a closed list to an archive list. Requires board editor permissions.
* tags:
* - Lists
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the source list (must be a closed-type list)
* schema:
* type: string
* example: 1357158568008091264
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required:
* - listId
* properties:
* listId:
* type: string
* description: ID of the target list (must be an archive-type list)
* example: 1357158568008091265
* responses:
* 200:
* description: Cards moved successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* - included
* properties:
* item:
* $ref: '#/components/schemas/List'
* included:
* type: object
* required:
* - cards
* - actions
* properties:
* cards:
* type: array
* description: Related cards
* items:
* $ref: '#/components/schemas/Card'
* actions:
* type: array
* description: Related actions
* items:
* $ref: '#/components/schemas/Action'
* 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 = {

108
server/api/controllers/lists/show.js
View File

@@ -3,6 +3,114 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/lists/{id}:
* get:
* summary: Get list details
* description: Retrieves comprehensive list information, including cards, attachments, and other related data. Requires access to the board.
* tags:
* - Lists
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the list to retrieve
* schema:
* type: string
* example: 1357158568008091264
* responses:
* 200:
* description: List details retrieved successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* - included
* properties:
* item:
* $ref: '#/components/schemas/List'
* included:
* type: object
* required:
* - users
* - cards
* - cardMemberships
* - cardLabels
* - taskLists
* - tasks
* - attachments
* - customFieldGroups
* - customFields
* - customFieldValues
* properties:
* users:
* type: array
* description: Related users
* items:
* $ref: '#/components/schemas/User'
* cards:
* type: array
* description: Related cards
* items:
* allOf:
* - $ref: '#/components/schemas/Card'
* - type: object
* properties:
* isSubscribed:
* type: boolean
* description: Whether the current user is subscribed to the card
* example: true
* cardMemberships:
* type: array
* description: Related card-membership associations
* items:
* $ref: '#/components/schemas/CardMembership'
* cardLabels:
* type: array
* description: Related card-label associations
* items:
* $ref: '#/components/schemas/CardLabel'
* taskLists:
* type: array
* description: Related task lists
* items:
* $ref: '#/components/schemas/TaskList'
* tasks:
* type: array
* description: Related tasks
* items:
* $ref: '#/components/schemas/Task'
* attachments:
* type: array
* description: Related attachments
* items:
* $ref: '#/components/schemas/Attachment'
* customFieldGroups:
* type: array
* description: Related custom field groups
* items:
* $ref: '#/components/schemas/CustomFieldGroup'
* customFields:
* type: array
* description: Related custom fields
* items:
* $ref: '#/components/schemas/CustomField'
* customFieldValues:
* type: array
* description: Related custom field values
* items:
* $ref: '#/components/schemas/CustomFieldValue'
* 400:
* $ref: '#/components/responses/ValidationError'
* 401:
* $ref: '#/components/responses/Unauthorized'
* 404:
* $ref: '#/components/responses/NotFound'
*/
const { idInput } = require('../../../utils/inputs');
const Errors = {

67
server/api/controllers/lists/sort.js
View File

@@ -3,6 +3,73 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/lists/{id}/sort:
* post:
* summary: Sort cards in list
* description: Sorts all cards within a list. Requires board editor permissions.
* tags:
* - Lists
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the list to sort
* schema:
* type: string
* example: 1357158568008091264
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required:
* - fieldName
* properties:
* fieldName:
* type: string
* enum: [name, dueDate, createdAt]
* description: Field to sort cards by
* example: name
* order:
* type: string
* enum: [asc, desc]
* description: Sorting order
* example: asc
* responses:
* 200:
* description: List sorted successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* properties:
* item:
* $ref: '#/components/schemas/List'
* included:
* type: object
* properties:
* cards:
* type: array
* description: Related cards
* items:
* $ref: '#/components/schemas/Card'
* 400:
* $ref: '#/components/responses/ValidationError'
* 401:
* $ref: '#/components/responses/Unauthorized'
* 403:
* $ref: '#/components/responses/Forbidden'
* 404:
* $ref: '#/components/responses/NotFound'
* 422:
* $ref: '#/components/responses/UnprocessableEntity'
*/
const { idInput } = require('../../../utils/inputs');
const Errors = {

70
server/api/controllers/lists/update.js
View File

@@ -3,6 +3,76 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/lists/{id}:
* patch:
* summary: Update list
* description: Updates a list. Can move lists between boards. Requires board editor permissions.
* tags:
* - Lists
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the list to update
* schema:
* type: string
* example: 1357158568008091264
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* boardId:
* type: string
* description: ID of the board to move list to
* example: 1357158568008091265
* type:
* type: string
* enum: [active, closed]
* description: Type/status of the list
* example: active
* position:
* type: number
* minimum: 0
* description: Position of the list within the board
* example: 65536
* name:
* type: string
* maxLength: 128
* description: Name/title of the list
* example: To Do
* color:
* type: string
* enum: [berry-red, pumpkin-orange, lagoon-blue, pink-tulip, light-mud, orange-peel, bright-moss, antique-blue, dark-granite, turquoise-sea]
* nullable: true
* description: Color for the list
* example: lagoon-blue
* responses:
* 200:
* description: List updated successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* properties:
* item:
* $ref: '#/components/schemas/List'
* 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 = {