docs: Add full Swagger JSDoc coverage

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

View File

@@ -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 = {