starred/planka
1
0
Fork 0
mirror of https://github.com/plankanban/planka.git synced 2025-12-27 01:11:50 +03:00
Code Issues 418 Packages Projects Releases 12 Wiki Activity

docs: Improve Swagger JSDoc

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

4
server/api/models/Action.js
View File

@@ -18,9 +18,13 @@
* type: object
* required:
* - id
* - boardId
* - cardId
* - userId
* - type
* - data
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

5
server/api/models/Attachment.js
View File

@@ -19,9 +19,12 @@
* required:
* - id
* - cardId
* - creatorUserId
* - type
* - data
* - name
* - createdAt
* - updatedAt
* properties:
* id:
* type: string
@@ -48,7 +51,7 @@
* name:
* type: string
* description: Name/title of the attachment
* example: Google Link
* example: Important Attachment
* createdAt:
* type: string
* format: date-time

2
server/api/models/BackgroundImage.js
View File

@@ -22,6 +22,8 @@
* - size
* - url
* - thumbnailUrls
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

2
server/api/models/BaseCustomFieldGroup.js
View File

@@ -20,6 +20,8 @@
* - id
* - projectId
* - name
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

12
server/api/models/Board.js
View File

@@ -21,6 +21,13 @@
* - projectId
* - position
* - name
* - defaultView
* - defaultCardType
* - limitCardTypesToDefaultOne
* - alwaysDisplayCardCreator
* - expandTaskListsByDefault
* - createdAt
* - updatedAt
* properties:
* id:
* type: string
@@ -41,23 +48,28 @@
* defaultView:
* type: string
* enum: [kanban, grid, list]
* default: kanban
* description: Default view for the board
* example: kanban
* defaultCardType:
* type: string
* enum: [project, story]
* default: project
* description: Default card type for new cards
* example: project
* limitCardTypesToDefaultOne:
* type: boolean
* default: false
* description: Whether to limit card types to default one
* example: false
* alwaysDisplayCardCreator:
* type: boolean
* default: false
* description: Whether to always display the card creator
* example: false
* expandTaskListsByDefault:
* type: boolean
* default: false
* description: Whether to expand task lists by default
* example: false
* createdAt:

3
server/api/models/BoardMembership.js
View File

@@ -22,6 +22,9 @@
* - boardId
* - userId
* - role
* - canComment
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

15
server/api/models/Card.js
View File

@@ -20,8 +20,21 @@
* - id
* - boardId
* - listId
* - creatorUserId
* - prevListId
* - coverAttachmentId
* - type
* - position
* - name
* - description
* - dueDate
* - isDueCompleted
* - stopwatch
* - commentsTotal
* - isClosed
* - listChangedAt
* - createdAt
* - updatedAt
* properties:
* id:
* type: string
@@ -99,10 +112,12 @@
* example: 3600
* commentsTotal:
* type: number
* default: 0
* description: Total number of comments on the card
* example: 100
* isClosed:
* type: boolean
* default: false
* description: Whether the card is closed
* example: false
* listChangedAt:

2
server/api/models/CardLabel.js
View File

@@ -20,6 +20,8 @@
* - id
* - cardId
* - labelId
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

2
server/api/models/CardMembership.js
View File

@@ -20,6 +20,8 @@
* - id
* - cardId
* - userId
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

3
server/api/models/Comment.js
View File

@@ -19,7 +19,10 @@
* required:
* - id
* - cardId
* - userId
* - text
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

1
server/api/models/Config.js
View File

@@ -18,6 +18,7 @@
* type: object
* required:
* - version
* - oidc
* properties:
* version:
* type: string

4
server/api/models/CustomField.js
View File

@@ -18,9 +18,13 @@
* type: object
* required:
* - id
* - baseCustomFieldGroupId
* - customFieldGroupId
* - position
* - name
* - showOnFrontOfCard
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

6
server/api/models/CustomFieldGroup.js
View File

@@ -18,7 +18,13 @@
* type: object
* required:
* - id
* - boardId
* - cardId
* - baseCustomFieldGroupId
* - position
* - name
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

2
server/api/models/CustomFieldValue.js
View File

@@ -22,6 +22,8 @@
* - customFieldGroupId
* - customFieldId
* - content
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

3
server/api/models/Label.js
View File

@@ -20,7 +20,10 @@
* - id
* - boardId
* - position
* - name
* - color
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

5
server/api/models/List.js
View File

@@ -20,6 +20,11 @@
* - id
* - boardId
* - type
* - position
* - name
* - color
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

8
server/api/models/Notification.js
View File

@@ -19,11 +19,16 @@
* required:
* - id
* - userId
* - creatorUserId
* - boardId
* - cardId
* - commentId
* - actionId
* - type
* - data
* - isRead
* - createdAt
* - updatedAt
* properties:
* id:
* type: string
@@ -63,10 +68,11 @@
* example: commentCard
* data:
* type: object
* description: Notification payload specific to the type
* description: Notification specific data (varies by type)
* example: {"card": {"name": "Implement user authentication"}, "text": "This task is almost complete..."}
* isRead:
* type: boolean
* default: false
* description: Whether the notification has been read
* example: false
* createdAt:

4
server/api/models/NotificationService.js
View File

@@ -18,8 +18,12 @@
* type: object
* required:
* - id
* - userId
* - boardId
* - url
* - format
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

8
server/api/models/Project.js
View File

@@ -18,7 +18,15 @@
* type: object
* required:
* - id
* - ownerProjectManagerId
* - backgroundImageId
* - name
* - description
* - backgroundType
* - backgroundGradient
* - isHidden
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

2
server/api/models/ProjectManager.js
View File

@@ -20,6 +20,8 @@
* - id
* - projectId
* - userId
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

5
server/api/models/Task.js
View File

@@ -19,8 +19,13 @@
* required:
* - id
* - taskListId
* - linkedCardId
* - assigneeUserId
* - position
* - name
* - isCompleted
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

4
server/api/models/TaskList.js
View File

@@ -21,6 +21,10 @@
* - cardId
* - position
* - name
* - showOnFrontOfCard
* - hideCompletedTasks
* - createdAt
* - updatedAt
* properties:
* id:
* type: string

15
server/api/models/User.js
View File

@@ -18,10 +18,16 @@
* type: object
* required:
* - id
* - email
* - role
* - name
* - username
* - avatar
* - phone
* - organization
* - termsType
* - isDeactivated
* - createdAt
* - updatedAt
* properties:
* id:
* type: string
@@ -76,7 +82,6 @@
* gravatarUrl:
* type: string
* format: uri
* nullable: true
* description: Gravatar URL for the user (conditionally added if configured)
* example: https://www.gravatar.com/avatar/abc123
* phone:
@@ -149,24 +154,24 @@
* example: false
* isDefaultAdmin:
* type: boolean
* nullable: true
* description: Whether the user is the default admin (visible only to current user or admin)
* example: false
* lockedFieldNames:
* type: array
* description: List of fields locked from editing (visible only to current user or admin)
* items:
* type: string
* nullable: true
* description: List of fields locked from editing (visible only to current user or admin)
* example: [email, password, name]
* createdAt:
* type: string
* format: date-time
* nullable: true
* description: When the user was created
* example: 2024-01-01T00:00:00.000Z
* updatedAt:
* type: string
* format: date-time
* nullable: true
* description: When the user was last updated
* example: 2024-01-01T00:00:00.000Z
*/

13
server/api/models/Webhook.js
View File

@@ -20,6 +20,11 @@
* - id
* - name
* - url
* - accessToken
* - events
* - excludedEvents
* - createdAt
* - updatedAt
* properties:
* id:
* type: string
@@ -40,24 +45,28 @@
* example: secret_token_123
* events:
* type: array
* nullable: true
* description: List of events that trigger the webhook
* items:
* type: string
* description: List of events that trigger the webhook
* example: [cardCreate, cardUpdate, cardDelete]
* excludedEvents:
* type: array
* nullable: true
* description: List of events excluded from the webhook
* items:
* type: string
* description: List of events excluded from the webhook
* example: [userCreate, userUpdate, userDelete]
* createdAt:
* type: string
* format: date-time
* nullable: true
* description: When the webhook was created
* example: 2024-01-01T00:00:00.000Z
* updatedAt:
* type: string
* format: date-time
* nullable: true
* description: When the webhook was last updated
* example: 2024-01-01T00:00:00.000Z
*/