docs: Add full Swagger JSDoc coverage

2025-09-08 16:20:27 +02:00
parent e6b4c33542
commit 5ad3134519
128 changed files with 7610 additions and 0 deletions
@@ -10,6 +10,69 @@
 * @docs        :: https://sailsjs.com/docs/concepts/models-and-orm/models
 */

+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Board:
+ *       type: object
+ *       required:
+ *         - projectId
+ *         - position
+ *         - name
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: Unique identifier for the board
+ *           example: 1357158568008091264
+ *         projectId:
+ *           type: string
+ *           description: ID of the project the board belongs to
+ *           example: 1357158568008091265
+ *         position:
+ *           type: number
+ *           description: Position of the board within the project
+ *           example: 65536
+ *         name:
+ *           type: string
+ *           description: Name/title of the board
+ *           example: Development Board
+ *         defaultView:
+ *           type: string
+ *           enum: [kanban, grid, list]
+ *           description: Default view for the board
+ *           example: kanban
+ *         defaultCardType:
+ *           type: string
+ *           enum: [project, story]
+ *           description: Default card type for new cards
+ *           example: project
+ *         limitCardTypesToDefaultOne:
+ *           type: boolean
+ *           description: Whether to limit card types to default one
+ *           example: false
+ *         alwaysDisplayCardCreator:
+ *           type: boolean
+ *           description: Whether to always display the card creator
+ *           example: false
+ *         expandTaskListsByDefault:
+ *           type: boolean
+ *           description: Whether to expand task lists by default
+ *           example: false
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *           nullable: true
+ *           description: When the board was created
+ *           example: 2024-01-01T00:00:00.000Z
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *           nullable: true
+ *           description: When the board was last updated
+ *           example: 2024-01-01T00:00:00.000Z
+ */
+
 const Card = require('./Card');

 const Views = {