mirror of
https://github.com/plankanban/planka.git
synced 2025-12-20 01:14:12 +03:00
docs: Add full Swagger JSDoc coverage
This commit is contained in:
@@ -10,6 +10,53 @@
|
||||
* @docs :: https://sailsjs.com/docs/concepts/models-and-orm/models
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* components:
|
||||
* schemas:
|
||||
* Label:
|
||||
* type: object
|
||||
* required:
|
||||
* - boardId
|
||||
* - position
|
||||
* - color
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the label
|
||||
* example: 1357158568008091264
|
||||
* boardId:
|
||||
* type: string
|
||||
* description: ID of the board the label belongs to
|
||||
* example: 1357158568008091265
|
||||
* position:
|
||||
* type: number
|
||||
* description: Position of the label within the board
|
||||
* example: 65536
|
||||
* name:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: Name/title of the label
|
||||
* example: Bug
|
||||
* color:
|
||||
* type: string
|
||||
* enum: [muddy-grey, autumn-leafs, morning-sky, antique-blue, egg-yellow, desert-sand, dark-granite, fresh-salad, lagoon-blue, midnight-blue, light-orange, pumpkin-orange, light-concrete, sunny-grass, navy-blue, lilac-eyes, apricot-red, orange-peel, silver-glint, bright-moss, deep-ocean, summer-sky, berry-red, light-cocoa, grey-stone, tank-green, coral-green, sugar-plum, pink-tulip, shady-rust, wet-rock, wet-moss, turquoise-sea, lavender-fields, piggy-red, light-mud, gun-metal, modern-green, french-coast, sweet-lilac, red-burgundy, pirate-gold]
|
||||
* description: Color of the label
|
||||
* example: berry-red
|
||||
* createdAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* nullable: true
|
||||
* description: When the label was created
|
||||
* example: 2024-01-01T00:00:00.000Z
|
||||
* updatedAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* nullable: true
|
||||
* description: When the label was last updated
|
||||
* example: 2024-01-01T00:00:00.000Z
|
||||
*/
|
||||
|
||||
const COLORS = [
|
||||
'muddy-grey',
|
||||
'autumn-leafs',
|
||||
|
||||
Reference in New Issue
Block a user