docs: Add full Swagger JSDoc coverage

server/api/controllers/lists/update.js

@@ -3,6 +3,76 @@
  * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
  */
 
+/**
+ * @swagger
+ * /api/lists/{id}:
+ *   patch:
+ *     summary: Update list
+ *     description: Updates a list. Can move lists between boards. Requires board editor permissions.
+ *     tags:
+ *       - Lists
+ *     parameters:
+ *       - name: id
+ *         in: path
+ *         required: true
+ *         description: ID of the list to update
+ *         schema:
+ *           type: string
+ *           example: 1357158568008091264
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               boardId:
+ *                 type: string
+ *                 description: ID of the board to move list to
+ *                 example: 1357158568008091265
+ *               type:
+ *                 type: string
+ *                 enum: [active, closed]
+ *                 description: Type/status of the list
+ *                 example: active
+ *               position:
+ *                 type: number
+ *                 minimum: 0
+ *                 description: Position of the list within the board
+ *                 example: 65536
+ *               name:
+ *                 type: string
+ *                 maxLength: 128
+ *                 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
+ *     responses:
+ *       200:
+ *         description: List updated successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/List'
+ *       400:
+ *         $ref: '#/components/responses/ValidationError'
+ *       401:
+ *         $ref: '#/components/responses/Unauthorized'
+ *       403:
+ *         $ref: '#/components/responses/Forbidden'
+ *       404:
+ *         $ref: '#/components/responses/NotFound'
+ */
+
 const { idInput } = require('../../../utils/inputs');
 
 const Errors = {