mirror of
https://github.com/plankanban/planka.git
synced 2025-12-19 17:23:27 +03:00
docs: Add full Swagger JSDoc coverage
This commit is contained in:
@@ -10,6 +10,59 @@
|
||||
* @docs :: https://sailsjs.com/docs/concepts/models-and-orm/models
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* components:
|
||||
* schemas:
|
||||
* List:
|
||||
* type: object
|
||||
* required:
|
||||
* - boardId
|
||||
* - type
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the list
|
||||
* example: 1357158568008091264
|
||||
* boardId:
|
||||
* type: string
|
||||
* description: ID of the board the list belongs to
|
||||
* example: 1357158568008091265
|
||||
* type:
|
||||
* type: string
|
||||
* enum: [active, closed, archive, trash]
|
||||
* description: Type/status of the list
|
||||
* example: active
|
||||
* position:
|
||||
* type: number
|
||||
* nullable: true
|
||||
* description: Position of the list within the board
|
||||
* example: 65536
|
||||
* name:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: Name/title of the list
|
||||
* example: To Do
|
||||
* color:
|
||||
* type: string
|
||||
* enum: [berry-red, pumpkin-orange, lagoon-blue, pink-tulip, light-mud, orange-peel, bright-moss, antique-blue, dark-granite, turquoise-sea]
|
||||
* nullable: true
|
||||
* description: Color for the list
|
||||
* example: lagoon-blue
|
||||
* createdAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* nullable: true
|
||||
* description: When the list was created
|
||||
* example: 2024-01-01T00:00:00.000Z
|
||||
* updatedAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* nullable: true
|
||||
* description: When the list was last updated
|
||||
* example: 2024-01-01T00:00:00.000Z
|
||||
*/
|
||||
|
||||
const Types = {
|
||||
ACTIVE: 'active',
|
||||
CLOSED: 'closed',
|
||||
|
||||
Reference in New Issue
Block a user