docs: Improve Swagger JSDoc

This commit is contained in:
Maksim Eltyshev
2025-09-12 12:17:01 +02:00
parent 494800d131
commit b4979d214f
129 changed files with 294 additions and 248 deletions

View File

@@ -7,10 +7,11 @@
* @swagger
* /boards/{boardId}/custom-field-groups:
* post:
* summary: Create custom field group in board
* summary: Create board custom field group
* description: Creates a custom field group within a board. Either `baseCustomFieldGroupId` or `name` must be provided. Requires board editor permissions.
* tags:
* - Custom Field Groups
* operationId: createBoardCustomFieldGroup
* parameters:
* - name: boardId
* in: path

View File

@@ -7,10 +7,11 @@
* @swagger
* /cards/{cardId}/custom-field-groups:
* post:
* summary: Create custom field group in card
* summary: Create card custom field group
* description: Creates a custom field group within a card. Either `baseCustomFieldGroupId` or `name` must be provided. Requires board editor permissions.
* tags:
* - Custom Field Groups
* operationId: createCardCustomFieldGroup
* parameters:
* - name: cardId
* in: path

View File

@@ -11,6 +11,7 @@
* description: Deletes a custom field group. Requires board editor permissions.
* tags:
* - Custom Field Groups
* operationId: deleteCustomFieldGroup
* parameters:
* - name: id
* in: path

View File

@@ -11,6 +11,7 @@
* description: Retrieves comprehensive custom field group information, including fields and values. Requires access to the board/card.
* tags:
* - Custom Field Groups
* operationId: getCustomFieldGroup
* parameters:
* - name: id
* in: path
@@ -40,14 +41,14 @@
* properties:
* customFields:
* type: array
* description: Related custom fields
* items:
* $ref: '#/components/schemas/CustomField'
* description: Related custom fields
* customFieldValues:
* type: array
* description: Related custom field values (for card-specific groups)
* items:
* $ref: '#/components/schemas/CustomFieldValue'
* description: Related custom field values (for card-specific groups)
* 400:
* $ref: '#/components/responses/ValidationError'
* 401:

View File

@@ -11,6 +11,7 @@
* description: Updates a custom field group. Supports both board-wide and card-specific groups. Requires board editor permissions.
* tags:
* - Custom Field Groups
* operationId: updateCustomFieldGroup
* parameters:
* - name: id
* in: path