AhmedTawfik/planka
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Quote example ids in Swagger

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
server/api/models/Action.js
+4 -4
View File
@@ -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]
server/api/models/Attachment.js
+3 -3
View File
@@ -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]
server/api/models/BackgroundImage.js
+2 -2
View File
@@ -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
server/api/models/BaseCustomFieldGroup.js
+2 -2
View File
@@ -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
server/api/models/Board.js
+2 -2
View File
@@ -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
server/api/models/BoardMembership.js
+4 -4
View File
@@ -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]
server/api/models/Card.js
+6 -6
View File
@@ -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]
server/api/models/CardLabel.js
+3 -3
View File
@@ -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
server/api/models/CardMembership.js
+3 -3
View File
@@ -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
server/api/models/Comment.js
+3 -3
View File
@@ -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
server/api/models/CustomField.js
+3 -3
View File
@@ -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
server/api/models/CustomFieldGroup.js
+4 -4
View File
@@ -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
server/api/models/CustomFieldValue.js
+4 -4
View File
@@ -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
server/api/models/Label.js
+2 -2
View File
@@ -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
server/api/models/List.js
+2 -2
View File
@@ -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]
server/api/models/Notification.js
+7 -7
View File
@@ -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]
server/api/models/NotificationService.js
+3 -3
View File
@@ -23,17 +23,17 @@
* id:
* type: string
* description: Unique identifier for the notification service
* example: 1357158568008091264
* example: "1357158568008091264"
* userId:
* type: string
* nullable: true
* description: ID of the user the service is associated with
* example: 1357158568008091265
* example: "1357158568008091265"
* boardId:
* type: string
* nullable: true
* description: ID of the board the service is associated with
* example: 1357158568008091266
* example: "1357158568008091266"
* url:
* type: string
* description: URL endpoint for notifications
server/api/models/Project.js
+3 -3
View File
@@ -22,17 +22,17 @@
* id:
* type: string
* description: Unique identifier for the project
* example: 1357158568008091264
* example: "1357158568008091264"
* ownerProjectManagerId:
* 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
* description: Name/title of the project
server/api/models/ProjectManager.js
+3 -3
View File
@@ -23,15 +23,15 @@
* id:
* type: string
* description: Unique identifier for the project manager
* example: 1357158568008091264
* example: "1357158568008091264"
* projectId:
* type: string
* description: ID of the project the manager is associated with
* example: 1357158568008091265
* example: "1357158568008091265"
* userId:
* type: string
* description: ID of the user who is assigned as project manager
* example: 1357158568008091266
* example: "1357158568008091266"
* createdAt:
* type: string
* format: date-time
server/api/models/Task.js
+4 -4
View File
@@ -24,21 +24,21 @@
* id:
* type: string
* description: Unique identifier for the task
* example: 1357158568008091264
* example: "1357158568008091264"
* taskListId:
* type: string
* description: ID of the task list the task belongs to
* example: 1357158568008091265
* example: "1357158568008091265"
* linkedCardId:
* type: string
* nullable: true
* description: ID of the card linked to the task
* example: 1357158568008091266
* example: "1357158568008091266"
* assigneeUserId:
* type: string
* nullable: true
* description: ID of the user assigned to the task
* example: 1357158568008091267
* example: "1357158568008091267"
* position:
* type: number
* description: Position of the task within the task list
server/api/models/TaskList.js
+2 -2
View File
@@ -24,11 +24,11 @@
* id:
* type: string
* description: Unique identifier for the task list
* example: 1357158568008091264
* example: "1357158568008091264"
* cardId:
* type: string
* description: ID of the card the task list belongs to
* example: 1357158568008091265
* example: "1357158568008091265"
* position:
* type: number
* description: Position of the task list within the card
server/api/models/User.js
+1 -1
View File
@@ -26,7 +26,7 @@
* id:
* type: string
* description: Unique identifier for the user
* example: 1357158568008091264
* example: "1357158568008091264"
* email:
* type: string
* format: email
server/api/models/Webhook.js
+1 -1
View File
@@ -23,7 +23,7 @@
* id:
* type: string
* description: Unique identifier for the webhook
* example: 1357158568008091264
* example: "1357158568008091264"
* name:
* type: string
* description: Name/title of the webhook