mirror of
https://github.com/plankanban/planka.git
synced 2025-12-20 01:14:12 +03:00
docs: Add full Swagger JSDoc coverage
This commit is contained in:
@@ -3,6 +3,68 @@
|
||||
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/cards/{cardId}/custom-field-values:
|
||||
* post:
|
||||
* summary: Create or update custom field value
|
||||
* description: Creates or updates a custom field value for a card. Requires board editor permissions.
|
||||
* tags:
|
||||
* - Custom Field Values
|
||||
* parameters:
|
||||
* - name: cardId
|
||||
* in: path
|
||||
* required: true
|
||||
* description: ID of the card to set the custom field value for
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - customFieldGroupId
|
||||
* - customFieldId
|
||||
* - content
|
||||
* properties:
|
||||
* customFieldGroupId:
|
||||
* type: string
|
||||
* description: ID of the custom field group the value belongs to
|
||||
* example: 1357158568008091265
|
||||
* customFieldId:
|
||||
* type: string
|
||||
* description: ID of the custom field the value belongs to
|
||||
* example: 1357158568008091266
|
||||
* content:
|
||||
* type: string
|
||||
* maxLength: 512
|
||||
* description: Content/value of the custom field
|
||||
* example: High Priority
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Custom field value created or updated successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - item
|
||||
* properties:
|
||||
* item:
|
||||
* $ref: '#/components/schemas/CustomFieldValue'
|
||||
* 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 = {
|
||||
|
||||
Reference in New Issue
Block a user