Комментарии к проблеме
Описание структуры JSON-объекта, описывающего комментарий к проблеме
Поле | Тип | Описание |
---|---|---|
id |
String | Уникальный ID комментария к проблеме |
message |
String | Текст комментария |
author |
Object | Информация о пользователе, оставившего комментарий |
createdAt |
LocalDateTime | Дата и время создания комментария |
createTimeDifference |
String | Время, прошедшее с момента отправки комментария |
Ознакомиться со структурой JSON-объекта, описывающего пользователя можно здесь
Метод для получения всех комментариев к проблеме
GET /project/{ownerAlias}/{projectAlias}/issue-discussion/{localId}
Запрос возвращает массив комментариев к проблеме, есть возможность настройки количества отображаемых объектов на странице
Переменная пути запроса | Тип | Описание |
---|---|---|
ownerAlias |
String | Псевдоним владельца проекта |
projectAlias |
String | Псевдоним проекта |
localId |
Long | ID проблемы |
Responses
STATUS 200
пример JSON:
Пример ответа
{
"_embedded": {
"issueDiscussionList": [
{
"id": "3b8b4350-aaaa-aaaa-aaaa-f5c171c350ca",
"message": "Текст комментария",
"author": {
"id": "6736240a-aaaa-aaaa-aaaa-cab026562172",
"username": "user1",
"name": "name",
"surname": "surname",
"fullName": "name surname",
"avatar": "https://gitflic.ru/static/image/avatar.jpg",
"cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
},
"createdAt": "2022-04-22T14:30:35.063583",
"createTimeDifference": "2 дня назад"
},
{
"id": "323f79d9-aaaa-aaaa-aaaa-df772358ad9e",
"message": "Ответ к комментарию",
"author": {
"id": "6736240a-aaaa-aaaa-aaaa-cab026562172",
"username": "user2",
"name": "name",
"surname": "surname",
"fullName": "name surname",
"avatar": "https://gitflic.ru/static/image/avatar.jpg",
"cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
},
"createdAt": "2022-04-25T11:50:01.815651",
"createTimeDifference": "2 минуты назад"
}
]
},
"page": {
"size": 10,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}
STATUS 403
- Нет прав для доступа.
STATUS 404
- Данные по запросу не найдены.
Метод для создания нового комментария в проблеме
POST /project/{ownerAlias}/{projectAlias}/issue-discussion/{localId}/create
Запрос создает комментарий к проблеме
Переменная пути запроса | Тип | Описание |
---|---|---|
ownerAlias |
String | Псевдоним владельца проекта |
projectAlias |
String | Псевдоним проекта |
localId |
Long | ID проблемы |
Request
Поддерживаемый формат JSON
Структура тела POST-запроса:
Параметр | Описание |
---|---|
note |
Текст комментария |
Пример JSON объекта
{
"note": "Пример комментария"
}
Responses
STATUS 200
Пример JSON:
Пример ответа
{
"id": "03194139-aaaa-aaaa-aaaa-4dbd3179ba91",
"message": "Пример комментария",
"author": {
"id": "6736240a-aaaa-aaaa-aaaa-cab026562172",
"username": "user",
"name": "name",
"surname": "surname",
"fullName": "name surname",
"avatar": "https://gitflic.ru/static/image/avatar.jpg",
"cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
},
"createdAt": "2022-04-25T13:17:26.4990249",
"createTimeDifference": "2 минуты назад"
}
STATUS 403
- Нет прав для доступа.
STATUS 404
- Данные по запросу не найдены.
Метод для удаления комментария в проблеме
DELETE /project/{ownerAlias}/{projectAlias}/issue-discussion/{localId}/{commentId}/delete
Запрос удаляет комментарий к проблеме
Переменная пути запроса | Тип | Описание |
---|---|---|
ownerAlias |
String | Псевдоним владельца проекта |
projectAlias |
String | Псевдоним проекта |
localId |
Long | ID проблемы |
commentId |
Long | ID комментария |
Responses
STATUS 200
Пример JSON:
STATUS 403
- Нет прав для доступа.
STATUS 404
- Данные по запросу не найдены.
Метод для изменения комментария к проблеме
PUT /project/{ownerAlias}/{projectAlias}/issue-discussion/{localId}/{commentId}/edit
Запрос изменяет текст комментария к проблеме
Переменная пути запроса | Тип | Описание |
---|---|---|
ownerAlias |
String | Псевдоним владельца проекта |
projectAlias |
String | Псевдоним проекта |
localId |
Long | ID проблемы |
commentlId |
Long | ID комментария |
Request
Поддерживаемый формат JSON
Структура тела POST-запроса:
Параметр | Описание |
---|---|
note |
Текст комментария |
Пример JSON объекта
{
"note": "Пример комментария"
}
Responses
STATUS 200
Пример JSON:
Пример ответа
{
"id": "03194139-aaaa-aaaa-aaaa-4dbd3179ba91",
"message": "Пример комментария",
"author": {
"id": "6736240a-aaaa-aaaa-aaaa-cab026562172",
"username": "user",
"name": "name",
"surname": "surname",
"fullName": "name surname",
"avatar": "https://gitflic.ru/static/image/avatar.jpg",
"cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
},
"createdAt": "2022-04-25T13:17:26.4990249",
"createTimeDifference": "2 минуты назад"
}
STATUS 403
- Нет прав для доступа.
STATUS 404
- Данные по запросу не найдены.