Перейти к содержанию

Комментарий к проблеме

Для взаимодействия с комментариями к проблеме определен объект issueNoteService

Сущность комментарий к проблеме содержит в себе следующие данные:

class IssueNote {...}
Название Тип данных Описание
id string UUID комментария
message string Содержимое комментария
authorId string UUID автора комментария
issueId string UUID проблемы, содержащей комментарий

Методы для работы с комментариями к проблемам

Для работы с сущностью комментарий к проблеме существуют следующие методы:

Создание комментария к проблеме

issueNoteService.create(toCreate: IssueNote) => IssueNote

Метод создает комментарий к проблеме и возвращает ее. Необходимо передать следующие значения в методе

Название Тип данных Описание
issueId string UUID проблемы, в котором будет создан комментарий
message string Содержимое комментария

Изменение комментария к проблеме

issueNoteService.edit(toEdit IssueNote) => IssueNote

Метод изменяет комментарий к проблеме и возвращает ее. Необходимо передать следующие значения в методе

Название Тип данных Описание
id string UUID комментария проблемы
message string Содержимое комментария

Получение списка всех комментариев к проблеме

issueNoteService.findAll({issueId}, {startPage}, {pageSize}) => Page<IssueNote>

Метод возвращает объект со всеми комментариями к проблеме. Необходимо передать следующие значения в методе

Название Тип данных Описание
issueId string UUID проблемы, в которой будет осуществлен поиск
startPage number Номер запрашиваемой страницы
pageSize number Размер страницы

Получение комментария к проблеме по UUID

issueNoteService.findById({issueNoteId}) => IssueNote

Метод возвращает комментарий к проблеме с указанным UUID. Необходимо передать следующие значения в методе

Название Тип данных Описание
issueNoteId string UUID комментария проблемы

Получение количества комментариев в проблеме

issueNoteService.countAll({issueId}) => number

Метод возвращает число комментариев к проблеме. Необходимо передать следующие значения в методе

Название Тип данных Описание
issueId string UUID проблемы, в которой будет произведен подсчет комментариев