docs: Add full Swagger JSDoc coverage

2025-12-20 01:14:12 +03:00 · 2025-09-08 16:20:27 +02:00
parent e6b4c33542
commit 5ad3134519
128 changed files with 7610 additions and 0 deletions
--- a/server/api/controllers/custom-field-groups/create-in-board.js
+++ b/server/api/controllers/custom-field-groups/create-in-board.js
@@ -3,6 +3,70 @@
 * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
 */

+/**
+ * @swagger
+ * /api/boards/{boardId}/custom-field-groups:
+ *   post:
+ *     summary: Create custom field group in board
+ *     description: Creates a custom field group within a board. Either `baseCustomFieldGroupId` or `name` must be provided. Requires board editor permissions.
+ *     tags:
+ *       - Custom Field Groups
+ *     parameters:
+ *       - name: boardId
+ *         in: path
+ *         required: true
+ *         description: ID of the board to create the custom field group in
+ *         schema:
+ *           type: string
+ *           example: 1357158568008091264
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required:
+ *               - position
+ *             properties:
+ *               baseCustomFieldGroupId:
+ *                 type: string
+ *                 description: ID of the base custom field group used as a template
+ *                 example: 1357158568008091265
+ *               position:
+ *                 type: number
+ *                 minimum: 0
+ *                 description: Position of the custom field group within the board
+ *                 example: 65536
+ *               name:
+ *                 type: string
+ *                 maxLength: 128
+ *                 nullable: true
+ *                 description: Name/title of the custom field group (required if `baseCustomFieldGroupId` is not provided)
+ *                 example: Properties
+ *     responses:
+ *       200:
+ *         description: Custom field group created successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/CustomFieldGroup'
+ *       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 = {
--- a/server/api/controllers/custom-field-groups/create-in-card.js
+++ b/server/api/controllers/custom-field-groups/create-in-card.js
@@ -3,6 +3,70 @@
 * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
 */

+/**
+ * @swagger
+ * /api/cards/{cardId}/custom-field-groups:
+ *   post:
+ *     summary: Create custom field group in card
+ *     description: Creates a custom field group within a card. Either `baseCustomFieldGroupId` or `name` must be provided. Requires board editor permissions.
+ *     tags:
+ *       - Custom Field Groups
+ *     parameters:
+ *       - name: cardId
+ *         in: path
+ *         required: true
+ *         description: ID of the card to create the custom field group in
+ *         schema:
+ *           type: string
+ *           example: 1357158568008091264
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required:
+ *               - position
+ *             properties:
+ *               baseCustomFieldGroupId:
+ *                 type: string
+ *                 description: ID of the base custom field group used as a template
+ *                 example: 1357158568008091265
+ *               position:
+ *                 type: number
+ *                 minimum: 0
+ *                 description: Position of the custom field group within the card
+ *                 example: 65536
+ *               name:
+ *                 type: string
+ *                 maxLength: 128
+ *                 nullable: true
+ *                 description: Name/title of the custom field group (required if `baseCustomFieldGroupId` is not provided)
+ *                 example: Properties
+ *     responses:
+ *       200:
+ *         description: Custom field group created successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/CustomFieldGroup'
+ *       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 = {
--- a/server/api/controllers/custom-field-groups/delete.js
+++ b/server/api/controllers/custom-field-groups/delete.js
@@ -3,6 +3,44 @@
 * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
 */

+/**
+ * @swagger
+ * /api/custom-field-groups/{id}:
+ *   delete:
+ *     summary: Delete custom field group
+ *     description: Deletes a custom field group. Requires board editor permissions.
+ *     tags:
+ *       - Custom Field Groups
+ *     parameters:
+ *       - name: id
+ *         in: path
+ *         required: true
+ *         description: ID of the custom field group to delete
+ *         schema:
+ *           type: string
+ *           example: 1357158568008091264
+ *     responses:
+ *       200:
+ *         description: Custom field group deleted successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/CustomFieldGroup'
+ *       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 = {
--- a/server/api/controllers/custom-field-groups/show.js
+++ b/server/api/controllers/custom-field-groups/show.js
@@ -3,6 +3,59 @@
 * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
 */

+/**
+ * @swagger
+ * /api/custom-field-groups/{id}:
+ *   get:
+ *     summary: Get custom field group details
+ *     description: Retrieves comprehensive custom field group information, including fields and values. Requires access to the board/card.
+ *     tags:
+ *       - Custom Field Groups
+ *     parameters:
+ *       - name: id
+ *         in: path
+ *         required: true
+ *         description: ID of the custom field group to retrieve
+ *         schema:
+ *           type: string
+ *           example: 1357158568008091264
+ *     responses:
+ *       200:
+ *         description: Custom field group details retrieved successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *                 - included
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/CustomFieldGroup'
+ *                 included:
+ *                   type: object
+ *                   required:
+ *                     - customFields
+ *                     - customFieldValues
+ *                   properties:
+ *                     customFields:
+ *                       type: array
+ *                       items:
+ *                         $ref: '#/components/schemas/CustomField'
+ *                       description: Related custom fields
+ *                     customFieldValues:
+ *                       type: array
+ *                       items:
+ *                         $ref: '#/components/schemas/CustomFieldValue'
+ *                       description: Related custom field values (for card-specific groups)
+ *       400:
+ *         $ref: '#/components/responses/ValidationError'
+ *       401:
+ *         $ref: '#/components/responses/Unauthorized'
+ *       404:
+ *         $ref: '#/components/responses/NotFound'
+ */
+
 const { idInput } = require('../../../utils/inputs');

 const Errors = {
--- a/server/api/controllers/custom-field-groups/update.js
+++ b/server/api/controllers/custom-field-groups/update.js
@@ -3,6 +3,64 @@
 * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
 */

+/**
+ * @swagger
+ * /api/custom-field-groups/{id}:
+ *   patch:
+ *     summary: Update custom field group
+ *     description: Updates a custom field group. Supports both board-wide and card-specific groups. Requires board editor permissions.
+ *     tags:
+ *       - Custom Field Groups
+ *     parameters:
+ *       - name: id
+ *         in: path
+ *         required: true
+ *         description: ID of the custom field group 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 custom field group within the board/card
+ *                 example: 65536
+ *               name:
+ *                 type: string
+ *                 maxLength: 128
+ *                 nullable: true
+ *                 description: Name/title of the custom field group
+ *                 example: Properties
+ *     responses:
+ *       200:
+ *         description: Custom field group updated successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/CustomFieldGroup'
+ *       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 = {