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,62 @@
|
||||
* @docs :: https://sailsjs.com/docs/concepts/models-and-orm/models
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* components:
|
||||
* schemas:
|
||||
* Task:
|
||||
* type: object
|
||||
* required:
|
||||
* - taskListId
|
||||
* - position
|
||||
* - name
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the task
|
||||
* example: 1357158568008091264
|
||||
* taskListId:
|
||||
* type: string
|
||||
* description: ID of the task list the task belongs to
|
||||
* example: 1357158568008091265
|
||||
* linkedCardId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the card linked to the task
|
||||
* example: 1357158568008091266
|
||||
* assigneeUserId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the user assigned to the task
|
||||
* example: 1357158568008091267
|
||||
* position:
|
||||
* type: number
|
||||
* description: Position of the task within the task list
|
||||
* example: 65536
|
||||
* name:
|
||||
* type: string
|
||||
* description: Name/title of the task
|
||||
* example: Write unit tests
|
||||
* isCompleted:
|
||||
* type: boolean
|
||||
* default: false
|
||||
* description: Whether the task is completed
|
||||
* example: false
|
||||
* createdAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* nullable: true
|
||||
* description: When the task was created
|
||||
* example: 2024-01-01T00:00:00.000Z
|
||||
* updatedAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* nullable: true
|
||||
* description: When the task was last updated
|
||||
* example: 2024-01-01T00:00:00.000Z
|
||||
*/
|
||||
|
||||
module.exports = {
|
||||
attributes: {
|
||||
// ╔═╗╦═╗╦╔╦╗╦╔╦╗╦╦ ╦╔═╗╔═╗
|
||||
|
||||
Reference in New Issue
Block a user