mirror of
https://github.com/plankanban/planka.git
synced 2025-12-21 01:11:26 +03:00
docs: Add full Swagger JSDoc coverage
This commit is contained in:
@@ -3,6 +3,70 @@
|
||||
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/boards/{boardId}/memberships:
|
||||
* post:
|
||||
* summary: Add user to board
|
||||
* description: Adds a user to a board. Requires project manager permissions.
|
||||
* tags:
|
||||
* - Board Memberships
|
||||
* parameters:
|
||||
* - name: boardId
|
||||
* in: path
|
||||
* required: true
|
||||
* description: ID of the board to add the user to
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - userId
|
||||
* - role
|
||||
* properties:
|
||||
* userId:
|
||||
* type: string
|
||||
* description: ID of the user to add to the board
|
||||
* example: 1357158568008091265
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [editor, viewer]
|
||||
* description: Role of the user in the board
|
||||
* example: editor
|
||||
* canComment:
|
||||
* type: boolean
|
||||
* nullable: true
|
||||
* description: Whether the user can comment on cards (applies only to viewers)
|
||||
* example: true
|
||||
* responses:
|
||||
* 200:
|
||||
* description: User added to board successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - item
|
||||
* properties:
|
||||
* item:
|
||||
* $ref: '#/components/schemas/BoardMembership'
|
||||
* 400:
|
||||
* $ref: '#/components/responses/ValidationError'
|
||||
* 401:
|
||||
* $ref: '#/components/responses/Unauthorized'
|
||||
* 403:
|
||||
* $ref: '#/components/responses/Forbidden'
|
||||
* 404:
|
||||
* $ref: '#/components/responses/NotFound'
|
||||
* 409:
|
||||
* $ref: '#/components/responses/Conflict'
|
||||
*/
|
||||
|
||||
const { idInput } = require('../../../utils/inputs');
|
||||
|
||||
const Errors = {
|
||||
|
||||
Reference in New Issue
Block a user