mirror of
https://github.com/plankanban/planka.git
synced 2025-12-20 01:14:12 +03:00
133 lines
3.1 KiB
JavaScript
Executable File
133 lines
3.1 KiB
JavaScript
Executable File
/*!
|
|
* Copyright (c) 2024 PLANKA Software GmbH
|
|
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
|
*/
|
|
|
|
/**
|
|
* @swagger
|
|
* /cards/{cardId}/comments:
|
|
* post:
|
|
* summary: Create comment
|
|
* description: Creates a new comment on a card. Requires board editor permissions or comment permissions.
|
|
* tags:
|
|
* - Comments
|
|
* operationId: createComment
|
|
* parameters:
|
|
* - name: cardId
|
|
* in: path
|
|
* required: true
|
|
* description: ID of the card to create the comment on
|
|
* schema:
|
|
* type: string
|
|
* example: "1357158568008091264"
|
|
* requestBody:
|
|
* required: true
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* required:
|
|
* - text
|
|
* properties:
|
|
* text:
|
|
* type: string
|
|
* maxLength: 1048576
|
|
* description: Content of the comment
|
|
* example: This task is almost complete...
|
|
* responses:
|
|
* 200:
|
|
* description: Comment created successfully
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* required:
|
|
* - item
|
|
* properties:
|
|
* item:
|
|
* $ref: '#/components/schemas/Comment'
|
|
* 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 = {
|
|
NOT_ENOUGH_RIGHTS: {
|
|
notEnoughRights: 'Not enough rights',
|
|
},
|
|
CARD_NOT_FOUND: {
|
|
cardNotFound: 'Card not found',
|
|
},
|
|
};
|
|
|
|
module.exports = {
|
|
inputs: {
|
|
cardId: {
|
|
...idInput,
|
|
required: true,
|
|
},
|
|
text: {
|
|
type: 'string',
|
|
maxLength: 1048576,
|
|
required: true,
|
|
},
|
|
},
|
|
|
|
exits: {
|
|
notEnoughRights: {
|
|
responseType: 'forbidden',
|
|
},
|
|
cardNotFound: {
|
|
responseType: 'notFound',
|
|
},
|
|
},
|
|
|
|
async fn(inputs) {
|
|
const { currentUser } = this.req;
|
|
|
|
const { card, list, board, project } = await sails.helpers.cards
|
|
.getPathToProjectById(inputs.cardId)
|
|
.intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
|
|
|
|
const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
|
|
board.id,
|
|
currentUser.id,
|
|
);
|
|
|
|
if (!boardMembership) {
|
|
throw Errors.CARD_NOT_FOUND; // Forbidden
|
|
}
|
|
|
|
if (boardMembership.role !== BoardMembership.Roles.EDITOR) {
|
|
if (!boardMembership.canComment) {
|
|
throw Errors.NOT_ENOUGH_RIGHTS;
|
|
}
|
|
}
|
|
|
|
const values = _.pick(inputs, ['text']);
|
|
|
|
const comment = await sails.helpers.comments.createOne.with({
|
|
project,
|
|
board,
|
|
list,
|
|
values: {
|
|
...values,
|
|
card,
|
|
user: currentUser,
|
|
},
|
|
request: this.req,
|
|
});
|
|
|
|
return {
|
|
item: comment,
|
|
};
|
|
},
|
|
};
|