mirror of
https://github.com/plankanban/planka.git
synced 2025-12-20 17:25:39 +03:00
docs: Quote example ids in Swagger
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the attachment to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Attachment deleted successfully
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the board to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Board deleted successfully
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the board to retrieve
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* - name: subscribe
|
||||
* in: query
|
||||
* required: false
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the board to update
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the card to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Card deleted successfully
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the card to duplicate
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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]
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the comment to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Comment deleted successfully
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the label to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Label deleted successfully
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the label to update
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the list to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List deleted successfully
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the list to sort
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the project to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Project deleted successfully
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the task list to update
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the task to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Task deleted successfully
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the user to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: User deleted successfully
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the user to update
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the webhook to delete
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Webhook deleted successfully
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* description: ID of the webhook to update
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
|
||||
@@ -24,21 +24,21 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the action
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* boardId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the board where the action occurred
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* cardId:
|
||||
* type: string
|
||||
* description: ID of the card where the action occurred
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* userId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the user who performed the action
|
||||
* example: 1357158568008091267
|
||||
* example: "1357158568008091267"
|
||||
* type:
|
||||
* type: string
|
||||
* enum: [createCard, moveCard, addMemberToCard, removeMemberFromCard, completeTask, uncompleteTask]
|
||||
|
||||
@@ -25,16 +25,16 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the attachment
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* cardId:
|
||||
* type: string
|
||||
* description: ID of the card the attachment belongs to
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* creatorUserId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the user who created the attachment
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* type:
|
||||
* type: string
|
||||
* enum: [file, link]
|
||||
|
||||
@@ -25,11 +25,11 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the background image
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* projectId:
|
||||
* type: string
|
||||
* description: ID of the project the background image belongs to
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* size:
|
||||
* type: string
|
||||
* description: File size of the background image in bytes
|
||||
|
||||
@@ -23,11 +23,11 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the base custom field group
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* projectId:
|
||||
* type: string
|
||||
* description: ID of the project the base custom field group belongs to
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* name:
|
||||
* type: string
|
||||
* description: Name/title of the base custom field group
|
||||
|
||||
@@ -24,11 +24,11 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the board
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* projectId:
|
||||
* type: string
|
||||
* description: ID of the project the board belongs to
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* position:
|
||||
* type: number
|
||||
* description: Position of the board within the project
|
||||
|
||||
@@ -25,19 +25,19 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the board membership
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* projectId:
|
||||
* type: string
|
||||
* description: ID of the project the board membership belongs to (denormalized)
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* boardId:
|
||||
* type: string
|
||||
* description: ID of the board the membership is associated with
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* userId:
|
||||
* type: string
|
||||
* description: ID of the user who is a member of the board
|
||||
* example: 1357158568008091267
|
||||
* example: "1357158568008091267"
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [editor, viewer]
|
||||
|
||||
@@ -25,30 +25,30 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the card
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* boardId:
|
||||
* type: string
|
||||
* description: ID of the board the card belongs to (denormalized)
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* listId:
|
||||
* type: string
|
||||
* description: ID of the list the card belongs to
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* creatorUserId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the user who created the card
|
||||
* example: 1357158568008091267
|
||||
* example: "1357158568008091267"
|
||||
* prevListId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the previous list the card was in (available when in archive or trash)
|
||||
* example: 1357158568008091268
|
||||
* example: "1357158568008091268"
|
||||
* coverAttachmentId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the attachment used as cover
|
||||
* example: 1357158568008091269
|
||||
* example: "1357158568008091269"
|
||||
* type:
|
||||
* type: string
|
||||
* enum: [project, story]
|
||||
|
||||
@@ -23,15 +23,15 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the card-label association
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* cardId:
|
||||
* type: string
|
||||
* description: ID of the card the label is associated with
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* labelId:
|
||||
* type: string
|
||||
* description: ID of the label associated with the card
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* createdAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
|
||||
@@ -23,15 +23,15 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the card membership
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* cardId:
|
||||
* type: string
|
||||
* description: ID of the card the user is a member of
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* userId:
|
||||
* type: string
|
||||
* description: ID of the user who is a member of the card
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* createdAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
|
||||
@@ -23,16 +23,16 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the comment
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* cardId:
|
||||
* type: string
|
||||
* description: ID of the card the comment belongs to
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* userId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the user who created the comment
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* text:
|
||||
* type: string
|
||||
* description: Content of the comment
|
||||
|
||||
@@ -24,17 +24,17 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the custom field
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* baseCustomFieldGroupId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the base custom field group the custom field belongs to
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* customFieldGroupId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the custom field group the custom field belongs to
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* position:
|
||||
* type: number
|
||||
* description: Position of the custom field within the group
|
||||
|
||||
@@ -22,22 +22,22 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the custom field group
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* boardId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the board the custom field group belongs to
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* cardId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the card the custom field group belongs to
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* baseCustomFieldGroupId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the base custom field group used as a template
|
||||
* example: 1357158568008091267
|
||||
* example: "1357158568008091267"
|
||||
* position:
|
||||
* type: number
|
||||
* description: Position of the custom field group within the board/card
|
||||
|
||||
@@ -25,19 +25,19 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the custom field value
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* cardId:
|
||||
* type: string
|
||||
* description: ID of the card the value belongs to
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* customFieldGroupId:
|
||||
* type: string
|
||||
* description: ID of the custom field group the value belongs to
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* customFieldId:
|
||||
* type: string
|
||||
* description: ID of the custom field the value belongs to
|
||||
* example: 1357158568008091267
|
||||
* example: "1357158568008091267"
|
||||
* content:
|
||||
* type: string
|
||||
* description: Content/value of the custom field
|
||||
|
||||
@@ -24,11 +24,11 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the label
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* boardId:
|
||||
* type: string
|
||||
* description: ID of the board the label belongs to
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* position:
|
||||
* type: number
|
||||
* description: Position of the label within the board
|
||||
|
||||
@@ -23,11 +23,11 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the list
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* boardId:
|
||||
* type: string
|
||||
* description: ID of the board the list belongs to
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* type:
|
||||
* type: string
|
||||
* enum: [active, closed, archive, trash]
|
||||
|
||||
@@ -28,34 +28,34 @@
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the notification
|
||||
* example: 1357158568008091264
|
||||
* example: "1357158568008091264"
|
||||
* userId:
|
||||
* type: string
|
||||
* description: ID of the user who receives the notification
|
||||
* example: 1357158568008091265
|
||||
* example: "1357158568008091265"
|
||||
* creatorUserId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the user who created the notification
|
||||
* example: 1357158568008091266
|
||||
* example: "1357158568008091266"
|
||||
* boardId:
|
||||
* type: string
|
||||
* description: ID of the board associated with the notification (denormalized)
|
||||
* example: 1357158568008091267
|
||||
* example: "1357158568008091267"
|
||||
* cardId:
|
||||
* type: string
|
||||
* description: ID of the card associated with the notification
|
||||
* example: 1357158568008091268
|
||||
* example: "1357158568008091268"
|
||||
* commentId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the comment associated with the notification
|
||||
* example: 1357158568008091269
|
||||
* example: "1357158568008091269"
|
||||
* actionId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the action associated with the notification
|
||||
* example: 1357158568008091270
|
||||
* example: "1357158568008091270"
|
||||
* type:
|
||||
* type: string
|
||||
* enum: [moveCard, commentCard, addMemberToCard, mentionInComment]
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user