GitFlic API
Комментарии к проблеме
Описание структуры JSON-объекта, описывающего комментарий к проблеме
Поле | Тип | Описание |
---|---|---|
id |
String | Уникальный ID комментария к проблеме |
message |
String | Текст комментария |
author |
Object | Информация о пользователе, оставившего коментарий |
createdAt |
LocalDateTime | Дата и время создания комментария |
createTimeDifference |
String | Время, прошедшее с момента отправки комментария |
GET /project/{userAlias}/{projectAlias}/issue-discussion/{localId}
Запрос возвращает массив комментариев к проблеме, есть возможность настройки количества отображаемых объектов на странице
Запрос | Описание |
---|---|
GET /project/{userAlias}/{projectAlias}/issue-discussion/{localId} |
Список комментариев к проблеме |
Переменная пути запроса | Тип | Описание |
---|---|---|
userAlias |
String | Псевдоним пользователя |
projectAlias |
String | Псевдоним проекта |
localId |
Long | ID проблемы |
Responses
STATUS 200
пример JSON:
{
"_embedded": {
"issueDiscussionList": [
{
"id": "3b8b4350-6186-499f-8437-f5c171c350ca",
"message": "Текст комментария
",
"author": {
"id": "6736240a-139d-4e62-be4f-cab026562172",
"username": "user1",
"name": "name",
"surname": "surname",
"fullName": "name surname",
"avatar": "https://gitflic.ru/static/image/avatar.jpg"
},
"createdAt": "2022-04-22T14:30:35.063583",
"createTimeDifference": "2 дня назад"
},
{
"id": "323f79d9-91f6-48b6-a445-df772358ad9e",
"message": "Ответ к комментарию
\nкомментарий с пробелом
",
"author": {
"id": "6736240a-139d-4e62-be4f-cab026562172",
"username": "user2",
"name": "name",
"surname": "surname",
"fullName": "name surname",
"avatar": "https://gitflic.ru/static/image/avatar.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/{userAlias}/{projectAlias}/issue-discussion/{localId}/create
Запрос создает комментарий к проблеме.
Запрос | Описание |
---|---|
POST /project/{userAlias}/{projectAlias}/issue-discussion/{localId}/create |
Оставить комментарий к проблеме |
Переменная пути запроса | Тип | Описание |
---|---|---|
userAlias |
String | Псевдоним пользователя |
projectAlias |
String | Псевдоним проекта |
localId |
Long | ID проблемы |
Request
Поддерживаемый формат Content-type заголовок: application/json
Структура тела POST-запроса:
Переменная JSON тела | Тип | Описание |
---|---|---|
note |
String | Текст комментария к проблеме |
Пример JSON тела
{
"note": "Пример комментария"
}
Responses
STATUS 200
Пример JSON:
{
"id": "03194139-ccc6-40b0-af07-4dbd3179ba91",
"message": "Пример комментария
",
"author": {
"id": "6736240a-139d-4e62-be4f-cab026562172",
"username": "user",
"name": "name",
"surname": "surname",
"fullName": "name surname",
"avatar": "https://gitflic.ru/static/image/avatar.jpg"
},
"createdAt": "2022-04-25T13:17:26.4990249",
"createTimeDifference": "2 минуты назад"
}
STATUS 403
- Нет прав для доступа.
STATUS 404
- Данные по запросу не найдены.
DELETE /project/{userAlias}/{projectAlias}/issue-discussion/{localId}/{commentId}/delete
Удаление комментария к проблеме
Запрос | Описание |
---|---|
DELETE /project/{userAlias}/{projectAlias}/issue-discussion/{localId}/{commentId}/delete |
Удалить комментарий |
Переменная пути запроса | Тип | Описание |
---|---|---|
userAlias |
String | Псевдоним пользователя |
projectAlias |
String | Псевдоним проекта |
localId |
Long | ID проблемы |
commentId |
Long | ID комментария |
Responses
STATUS 200
Пример JSON:
STATUS 403
- Нет прав для доступа.
STATUS 404
- Данные по запросу не найдены.
PUT /project/{userAlias}/{projectAlias}/issue-discussion/{localId}/{commentId}/edit
Запрос меняет текст комментария к проблеме.
Запрос | Описание |
---|---|
PUT /project/{userAlias}/{projectAlias}/issue-discussion/{localId}/{commentId}/edit |
Изменить текст комментария к проблеме |
Переменная пути запроса | Тип | Описание |
---|---|---|
userAlias |
String | Псевдоним пользователя |
projectAlias |
String | Псевдоним проекта |
localId |
Long | ID проблемы |
commentId |
Long | ID комментария |
Request
Поддерживаемый формат Content-type заголовок: application/json
Структура тела PUT-запроса:
Переменная JSON тела | Тип | Описание |
---|---|---|
note |
String | Текст комментария к проблеме |
Пример JSON тела
{
"note": "Пример комментария"
}
Responses
STATUS 200
Пример JSON:
{
"id": "03194139-ccc6-40b0-af07-4dbd3179ba91",
"message": "Пример комментария
",
"author": {
"id": "6736240a-139d-4e62-be4f-cab026562172",
"username": "user",
"name": "name",
"surname": "surname",
"fullName": "name surname",
"avatar": "https://gitflic.ru/static/image/avatar.jpg"
},
"createdAt": "2022-04-25T13:17:26.4990249",
"createTimeDifference": "2 минуты назад"
}
STATUS 403
- Нет прав для доступа.
STATUS 404
- Данные по запросу не найдены.
В данной статье
Документация
- Общая информация
- Основные настройки
- Авторизация и регистрация
- Уведомления
- Создание README для профиля
- Введение
- Получение Access Token
- Пагинация
- Методы для проектов
- Методы для пользователей
- Методы для команд
- Методы для компаний
- Методы для проблем
- Методы для комментариев к проблемам
- Методы для коммитов
- Методы для релизов
- Методы для запросов на слияние
- Методы для веток
- Методы для вебхуков
- Методы для тегов