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

docs: Add full Swagger JSDoc coverage

Browse Source
This commit is contained in:
Maksim Eltyshev
2025-09-08 16:20:27 +02:00
parent e6b4c33542
commit 5ad3134519
128 changed files with 7610 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -10,6 +10,120 @@
* @docs :: https://sailsjs.com/docs/concepts/models-and-orm/models
*/
/**
* @swagger
* components:
* schemas:
* Card:
* type: object
* required:
* - boardId
* - listId
* - type
* - name
* properties:
* id:
* type: string
* description: Unique identifier for the card
* example: 1357158568008091264
* boardId:
* type: string
* description: ID of the board the card belongs to (denormalized)
* example: 1357158568008091265
* listId:
* type: string
* description: ID of the list the card belongs to
* example: 1357158568008091266
* creatorUserId:
* type: string
* nullable: true
* description: ID of the user who created the card
* 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
* coverAttachmentId:
* type: string
* nullable: true
* description: ID of the attachment used as cover
* example: 1357158568008091269
* type:
* type: string
* enum: [project, story]
* description: Type of the card
* example: project
* position:
* type: number
* nullable: true
* description: Position of the card within the list
* example: 65536
* name:
* type: string
* description: Name/title of the card
* example: Implement user authentication
* description:
* type: string
* nullable: true
* description: Detailed description of the card
* example: Add JWT-based authentication system...
* dueDate:
* type: string
* format: date-time
* nullable: true
* description: Due date for the card
* example: 2024-01-01T00:00:00.000Z
* isDueCompleted:
* type: boolean
* nullable: true
* description: Whether the due date is completed
* example: false
* stopwatch:
* type: object
* required:
* - startedAt
* - total
* nullable: true
* description: Stopwatch data for time tracking
* properties:
* startedAt:
* type: string
* format: date-time
* description: When the stopwatch was started
* example: 2024-01-01T00:00:00.000Z
* total:
* type: number
* description: Total time in seconds
* example: 3600
* commentsTotal:
* type: number
* description: Total number of comments on the card
* example: 100
* isClosed:
* type: boolean
* description: Whether the card is closed
* example: false
* listChangedAt:
* type: string
* format: date-time
* nullable: true
* description: When the card was last moved between lists
* example: 2024-01-01T00:00:00.000Z
* createdAt:
* type: string
* format: date-time
* nullable: true
* description: When the card was created
* example: 2024-01-01T00:00:00.000Z
* updatedAt:
* type: string
* format: date-time
* nullable: true
* description: When the card was last updated
* example: 2024-01-01T00:00:00.000Z
*/
const Types = {
PROJECT: 'project',
STORY: 'story',