docs: Quote example ids in Swagger

This commit is contained in:
Maksim Eltyshev
2025-09-08 19:14:31 +02:00
parent 5636cf27c0
commit 2c716a53c9
107 changed files with 181 additions and 180 deletions
@@ -34,7 +34,8 @@
* type: object
* properties:
* item:
* type: null
* type: object
* nullable: true
* description: No data returned
* example: null
* 400:
@@ -18,14 +18,14 @@
* description: ID of the board to get actions for
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* - name: beforeId
* in: query
* required: false
* description: ID to get actions before (for pagination)
* schema:
* type: string
* example: 1357158568008091265
* example: "1357158568008091265"
* responses:
* 200:
* description: Board actions retrieved successfully
@@ -18,14 +18,14 @@
* description: ID of the card to get actions for
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* - name: beforeId
* in: query
* required: false
* description: ID to get actions before (for pagination)
* schema:
* type: string
* example: 1357158568008091265
* example: "1357158568008091265"
* responses:
* 200:
* description: Card actions retrieved successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the card to create the attachment on
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the attachment to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Attachment deleted successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the attachment to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the project to upload background image for
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the background image to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Background image deleted successfully
@@ -18,7 +18,7 @@
* description: ID of the project to create the base custom field group in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the base custom field group to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Base custom field group deleted successfully
@@ -18,7 +18,7 @@
* description: ID of the base custom field group to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the board to add the user to
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -32,7 +32,7 @@
* userId:
* type: string
* description: ID of the user to add to the board
* example: 1357158568008091265
* example: "1357158568008091265"
* role:
* type: string
* enum: [editor, viewer]
@@ -18,7 +18,7 @@
* description: ID of the board membership to remove
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: User removed from board successfully
@@ -18,7 +18,7 @@
* description: ID of the board membership to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the project to create the board in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the board to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Board deleted successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the board to retrieve
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* - name: subscribe
* in: query
* required: false
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the board to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+2 -2
View File
@@ -18,7 +18,7 @@
* description: ID of the card to add the label to
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -31,7 +31,7 @@
* labelId:
* type: string
* description: ID of the label to add to the card
* example: 1357158568008091265
* example: "1357158568008091265"
* responses:
* 200:
* description: Label added to card successfully
+2 -2
View File
@@ -18,14 +18,14 @@
* description: ID of the card to remove the label from
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* - name: labelId
* in: path
* required: true
* description: ID of the label to remove from the card
* schema:
* type: string
* example: 1357158568008091265
* example: "1357158568008091265"
* responses:
* 200:
* description: Label removed from card successfully
@@ -18,7 +18,7 @@
* description: ID of the card to add the user to
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -31,7 +31,7 @@
* userId:
* type: string
* description: ID of the card to add the user to
* example: 1357158568008091265
* example: "1357158568008091265"
* responses:
* 200:
* description: User added to card successfully
@@ -18,14 +18,14 @@
* description: ID of the card to remove the user from
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* - name: userId
* in: path
* required: true
* description: ID of the user to remove from the card
* schema:
* type: string
* example: 1357158568008091265
* example: "1357158568008091265"
* responses:
* 200:
* description: User removed from card successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the list to create the card in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the card to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Card deleted successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the card to duplicate
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the list to get cards from (must be an endless list)
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* - name: before
* in: query
* required: false
@@ -18,7 +18,7 @@
* description: ID of the card to mark notifications as read for
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Notifications marked as read successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the card to retrieve
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Card details retrieved successfully
+4 -4
View File
@@ -18,7 +18,7 @@
* description: ID of the card to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -29,16 +29,16 @@
* boardId:
* type: string
* description: ID of the board to move the card to
* example: 1357158568008091265
* example: "1357158568008091265"
* listId:
* type: string
* description: ID of the list to move the card to
* example: 1357158568008091266
* example: "1357158568008091266"
* coverAttachmentId:
* type: string
* nullable: true
* description: ID of the attachment used as cover
* example: 1357158568008091267
* example: "1357158568008091267"
* type:
* type: string
* enum: [project, story]
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the card to create the comment on
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the comment to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Comment deleted successfully
+2 -2
View File
@@ -18,14 +18,14 @@
* description: ID of the card to retrieve comments for
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* - name: beforeId
* in: query
* required: false
* description: ID to get comments before (for pagination)
* schema:
* type: string
* example: 1357158568008091265
* example: "1357158568008091265"
* responses:
* 200:
* description: Comments retrieved successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the comment to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the board to create the custom field group in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -31,7 +31,7 @@
* baseCustomFieldGroupId:
* type: string
* description: ID of the base custom field group used as a template
* example: 1357158568008091265
* example: "1357158568008091265"
* position:
* type: number
* minimum: 0
@@ -18,7 +18,7 @@
* description: ID of the card to create the custom field group in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -31,7 +31,7 @@
* baseCustomFieldGroupId:
* type: string
* description: ID of the base custom field group used as a template
* example: 1357158568008091265
* example: "1357158568008091265"
* position:
* type: number
* minimum: 0
@@ -18,7 +18,7 @@
* description: ID of the custom field group to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Custom field group deleted successfully
@@ -18,7 +18,7 @@
* description: ID of the custom field group to retrieve
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Custom field group details retrieved successfully
@@ -18,7 +18,7 @@
* description: ID of the custom field group to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the card to set the custom field value for
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -33,11 +33,11 @@
* customFieldGroupId:
* type: string
* description: ID of the custom field group the value belongs to
* example: 1357158568008091265
* example: "1357158568008091265"
* customFieldId:
* type: string
* description: ID of the custom field the value belongs to
* example: 1357158568008091266
* example: "1357158568008091266"
* content:
* type: string
* maxLength: 512
@@ -18,21 +18,21 @@
* description: ID of the card to delete the custom field value from
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* - name: customFieldGroupId
* in: path
* required: true
* description: ID of the custom field group the value belongs to
* schema:
* type: string
* example: 1357158568008091265
* example: "1357158568008091265"
* - name: customFieldId
* in: path
* required: true
* description: ID of the custom field the value belongs to
* schema:
* type: string
* example: 1357158568008091266
* example: "1357158568008091266"
* responses:
* 200:
* description: Custom field value deleted successfully
@@ -18,7 +18,7 @@
* description: ID of the base custom field group to create the custom field in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the custom field group to create the custom field in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the custom field to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Custom field deleted successfully
@@ -18,7 +18,7 @@
* description: ID of the custom field to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the file attachment to download the thumbnail for
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* - name: fileName
* in: path
* required: true
@@ -18,7 +18,7 @@
* description: ID of the file attachment to download
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: File attachment content returned successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the board to create the label in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the label to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Label deleted successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the label to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the list to clear (must be a trash-type list)
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: List cleared successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the board to create the list in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the list to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: List deleted successfully
+2 -2
View File
@@ -18,7 +18,7 @@
* description: ID of the source list (must be a closed-type list)
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -31,7 +31,7 @@
* listId:
* type: string
* description: ID of the target list (must be an archive-type list)
* example: 1357158568008091265
* example: "1357158568008091265"
* responses:
* 200:
* description: Cards moved successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the list to retrieve
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: List details retrieved successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the list to sort
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+2 -2
View File
@@ -18,7 +18,7 @@
* description: ID of the list to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -29,7 +29,7 @@
* boardId:
* type: string
* description: ID of the board to move list to
* example: 1357158568008091265
* example: "1357158568008091265"
* type:
* type: string
* enum: [active, closed]
@@ -18,7 +18,7 @@
* description: ID of the board to create notification service for
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the user to create notification service for (must be the current user)
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the notification service to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Notification service deleted successfully
@@ -18,7 +18,7 @@
* description: ID of the notification service to test
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Test notification sent successfully
@@ -18,7 +18,7 @@
* description: ID of the notification service to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the notification to retrieve
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Notification details retrieved successfully
@@ -18,7 +18,7 @@
* description: ID of the notification to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the project to add the manager to
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -31,7 +31,7 @@
* userId:
* type: string
* description: ID of the user who is assigned as project manager
* example: 1357158568008091265
* example: "1357158568008091265"
* responses:
* 200:
* description: Project manager added successfully
@@ -18,7 +18,7 @@
* description: ID of the project manager to remove
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Project manager removed successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the project to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Project deleted successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the project to retrieve
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Project details retrieved successfully
+3 -3
View File
@@ -18,7 +18,7 @@
* description: ID of the project to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -30,12 +30,12 @@
* type: string
* nullable: true
* description: ID of the project manager who owns the project
* example: 1357158568008091265
* example: "1357158568008091265"
* backgroundImageId:
* type: string
* nullable: true
* description: ID of the background image used as background
* example: 1357158568008091266
* example: "1357158568008091266"
* name:
* type: string
* maxLength: 128
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the card to create task list in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the task list to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Task list deleted successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the task list to retrieve
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Task list details retrieved successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the task list to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+2 -2
View File
@@ -18,7 +18,7 @@
* description: ID of the task list to create task in
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -31,7 +31,7 @@
* linkedCardId:
* type: string
* description: ID of the card linked to the task
* example: 1357158568008091265
* example: "1357158568008091265"
* position:
* type: number
* minimum: 0
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the task to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Task deleted successfully
+3 -3
View File
@@ -18,7 +18,7 @@
* description: ID of the task to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -29,12 +29,12 @@
* taskListId:
* type: string
* description: ID of the task list to move the task to
* example: 1357158568008091265
* example: "1357158568008091265"
* assigneeUserId:
* type: string
* nullable: true
* description: ID of the user assigned to the task (null to unassign)
* example: 1357158568008091266
* example: "1357158568008091266"
* position:
* type: number
* minimum: 0
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the user to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: User deleted successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the user or 'me' for current user
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* - name: subscribe
* in: query
* required: false
@@ -18,7 +18,7 @@
* description: ID of the user whose avatar to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the user whose email to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the user whose password to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
@@ -18,7 +18,7 @@
* description: ID of the user whose username to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the user to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content:
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the webhook to delete
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* responses:
* 200:
* description: Webhook deleted successfully
+1 -1
View File
@@ -18,7 +18,7 @@
* description: ID of the webhook to update
* schema:
* type: string
* example: 1357158568008091264
* example: "1357158568008091264"
* requestBody:
* required: true
* content: