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,58 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/projects/{projectId}/base-custom-field-groups:
* post:
* summary: Create base custom field group
* description: Creates a base custom field group within a project. Requires project manager permissions.
* tags:
* - Base Custom Field Groups
* parameters:
* - name: projectId
* in: path
* required: true
* description: ID of the project to create the base custom field group in
* schema:
* type: string
* example: 1357158568008091264
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required:
* - name
* properties:
* name:
* type: string
* maxLength: 128
* description: Name/title of the base custom field group
* example: Base Properties
* responses:
* 200:
* description: Base custom field group created successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* properties:
* item:
* $ref: '#/components/schemas/BaseCustomFieldGroup'
* 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 = {

View File

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

View File

@@ -3,6 +3,56 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/base-custom-field-groups/{id}:
* patch:
* summary: Update base custom field group
* description: Updates a base custom field group. Requires project manager permissions.
* tags:
* - Base Custom Field Groups
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the base custom field group to update
* schema:
* type: string
* example: 1357158568008091264
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* name:
* type: string
* maxLength: 128
* description: Name/title of the base custom field group
* example: Base Properties
* responses:
* 200:
* description: Base custom field group updated successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* properties:
* item:
* $ref: '#/components/schemas/BaseCustomFieldGroup'
* 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 = {