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

Дискуссия к запросу на слияние

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

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

class Note {...}
Название Тип данных Описание
id string UUID дискуссии
mergeRequestId string UUID запроса на слияние
discussionId string UUID обновленной дискуссии
baseCommit string Последний коммит целевой ветки запроса на слияние
targetCommit string Последний коммит целевой ветки запроса на слияние
startCommit string Последний коммит исходной ветки запроса на слияние
newLine number Новый номер строки, для которой создана дискуссия
oldLine number Старый номер строки, для которой создана дискуссия
newPath string Новый путь файла, для которого создана дискуссия
oldPath string Старый путь файла, для которого создана дискуссия
resolvable boolean Можно ли закрыть дискуссию true или нет false
resolved boolean Дискуссия закрыта true или открыта false
type string Тип дискуссии. Поле всегда принимает значение MERGE_REQUEST_COMMENT
message string Содержание дискуссии
authorId string UUID автора дискуссии
diff string Изменения, к которым сделана дискуссия
highlightLanguage string Язык программирования для подсветки кода

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

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

Создание дискуссии к запросу на слияние

noteService.create(toCreate: Note) => Note

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

Название Тип данных Описание
mergeRequestId string UUID запроса на слияние
message string Содержание дискуссии
resolved boolean Дискуссия закрыта true или открыта false
highlightLanguage string Язык программирования для подсветки кода

Изменение дискуссии к запросу на слияние

noteService.edit(toEdit: Note) => Note

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

Название Тип данных Описание
noteId string UUID дискуссии
message string Содержание дискуссии
resolved boolean Дискуссия закрыта true или открыта false
highlightLanguage string Язык программирования для подсветки кода

Создание ответа в дискуссии к запросу на слияние

noteService.reply({noteId}, {message}) => Note

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

Название Тип данных Описание
noteId string UUID дискуссии
message string Содержание ответа в дискуссии

Закрытие дискуссии к запросу на слияние

noteService.resolve({noteId}) => void

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

Название Тип данных Описание
noteId string UUID дискуссии

Открытие дискуссии к запросу на слияние

noteService.unresolve({noteId}) => void

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

Название Тип данных Описание
noteId string UUID дискуссии

Получение списка всех дискуссий к запросу на слияние

noteService.findAllInMergeRequest({mergeRequestId}, {startPage}, {pageSize}) => Page<Note>

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

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

Получение дискуссии к запросу на слияние по UUID

noteService.findById({noteId}) => Note

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

Название Тип данных Описание
noteId string UUID дискуссии