starred/planka
1
0
Fork 0
mirror of https://github.com/plankanban/planka.git synced 2025-12-19 17:23:27 +03:00
Code Issues 418 Packages Projects Releases 12 Wiki Activity

docs: Improve Swagger JSDoc

Browse Source
This commit is contained in:
Maksim Eltyshev
2025-09-12 12:17:01 +02:00
parent 494800d131
commit b4979d214f
129 changed files with 294 additions and 248 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
server/api/controllers/boards/create.js
View File

@@ -11,6 +11,7 @@
* description: Creates a board within a project. Supports importing from Trello. Requires project manager permissions.
* tags:
* - Boards
* operationId: createBoard
* parameters:
* - name: projectId
* in: path
@@ -22,50 +23,6 @@
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required:
* - position
* - name
* properties:
* position:
* type: number
* minimum: 0
* description: Position of the board within the project
* example: 65536
* name:
* type: string
* maxLength: 128
* description: Name/title of the board
* example: Development Board
* defaultView:
* type: string
* enum: [kanban, grid, list]
* default: kanban
* description: Default view for the board
* example: kanban
* defaultCardType:
* type: string
* enum: [project, story]
* default: project
* description: Default card type for new cards
* example: project
* limitCardTypesToDefaultOne:
* type: boolean
* default: false
* description: Whether to limit card types to default one
* example: false
* alwaysDisplayCardCreator:
* type: boolean
* default: false
* description: Whether to always display the card creator
* example: false
* expandTaskListsByDefault:
* type: boolean
* default: false
* description: Whether to expand task lists by default
* example: false
* multipart/form-data:
* schema:
* type: object
@@ -83,33 +40,6 @@
* maxLength: 128
* description: Name/title of the board
* example: Development Board
* defaultView:
* type: string
* enum: [kanban, grid, list]
* default: kanban
* description: Default view for the board
* example: kanban
* defaultCardType:
* type: string
* enum: [project, story]
* default: project
* description: Default card type for new cards
* example: project
* limitCardTypesToDefaultOne:
* type: boolean
* default: false
* description: Whether to limit card types to default one
* example: false
* alwaysDisplayCardCreator:
* type: boolean
* default: false
* description: Whether to always display the card creator
* example: false
* expandTaskListsByDefault:
* type: boolean
* default: false
* description: Whether to expand task lists by default
* example: false
* importType:
* type: string
* enum: [trello]