Проблемы проектов

Описание структуры JSON-объекта, описывающего проблему
Поле Тип Описание
id String Уникальный ID проблемы
localId String Локальный ID проблемы
description String Описание проблемы
title String Псевдоним проблемы
status IssueStatus Статус проблемы
assigneUsers Set Информация о прикрепленных к проблеме пользователях
labels Set Лейблы проблемы
projectAlias String Псевдоним проекта
userAlias String Имя пользователя
updatedAt LocalDateTime Время последнего обновления проблемы
createdAt LocalDateTime Время создания проблемы
updatedBy User Информация о последнем пользователе, обновившем проблему

Получение информации о проблеме

GET /project/{userAlias}/{projectAlias}/issue/{localId}

Получить информацию о проблеме проекта

Запрос Описание
GET /project/{userAlias}/{projectAlias}/issue/{localId} получить информацию о проблеме проекта по localId проблемы
Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId Long ID проблемы

Responses

STATUS 200 пример JSON:

Пример JSON тела 
    
{
    "id": "2739de5e-9ec0-4bac-86d2-0b639b46a875",
    "localId": 1,
    "description": "Пример комментария",
    "title": "Пример комментария",
    "status": {
        "id": "OPEN",
        "title": "Новая",
        "hash": null,
        "alias": null,
        "ownerAlias": null,
        "color": "info",
        "hexColor": "17A2B8",
        "icon": null,
        "isDeleted": false
    },
    "assignedUsers": [
        {
            "id": "6736240a-139d-4e62-be4f-cab026562172",
            "username": "exampleuser",
            "name": "ExampleName",
            "surname": "ExampleSurname",
            "fullName": "ExampleName ExampleSurname",
            "avatar": "https://gitflic.ru/upload/img/d6fef627-adb2-43b2-95ad-88f4fb54c6d2.jpg"
        }
    ],
    "labels": [
        {
            "id": "676c2a50-46d4-4d20-b612-49332baddc79",
            "hexColor": "F58A07",
            "title": "ошибка",
            "description": "Ошибка в новой фиче",
            "isTextLight": false
        }
    ],
    "projectAlias": "example-project",
    "userAlias": "exampleuser",
    "updatedAt": "19 часов назад",
    "createdAt": "5 дней назад",
    "updatedBy": {
            "id": "6736240a-139d-4e62-be4f-cab026562172",
            "username": "exampleuser",
            "name": "ExampleName",
            "surname": "ExampleSurname",
            "fullName": "ExampleName ExampleSurname",
            "avatar": "https://gitflic.ru/upload/img/d6fef627-adb2-43b2-95ad-88f4fb54c6d2.jpg"
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

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

GET /project/{userAlias}/{projectAlias}/issue

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

Запрос Описание
GET /project/{userAlias}/{projectAlias}/issue получить информацию о всех проблемах проекта
Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта

Responses

STATUS 200 пример JSON:

Пример JSON тела 
    
{
    "_embedded": {
        "issueModelList": [
            {
                "id": "2739de5e-9ec0-4bac-86d2-0b639b46a875",
                "localId": 1,
                "description": "Пример описания",
                "title": "Пример названия",
                "status": {
                    "id": "OPEN",
                    "title": "Новая",
                    "hash": null,
                    "alias": null,
                    "ownerAlias": null,
                    "color": "info",
                    "hexColor": "17A2B8",
                    "icon": null,
                    "isDeleted": false
                },
                "assignedUsers": [
                    {
                        "id": "6736240a-139d-4e62-be4f-cab026562172",
                        "username": "exampleuser",
                        "name": "ExampleName",
                        "surname": "ExampleSurname",
                        "fullName": "ExampleName ExampleSurname",
                        "avatar": "https://gitflic.ru/upload/img/d6fef627-adb2-43b2-95ad-88f4fb54c6d2.jpg"
                    }
                ],
                "labels": [
                    {
                        "id": "676c2a50-46d4-4d20-b612-49332baddc79",
                        "hexColor": "F58A07",
                        "title": "ошибка",
                        "description": "Ошибка в новой фиче",
                        "isTextLight": false
                    }
                ],
                "projectAlias": "example-project",
                "userAlias": "exampleuser",
                "updatedAt": "19 часов назад",
                "createdAt": "5 дней назад",
                "updatedBy": {
                        "id": "6736240a-139d-4e62-be4f-cab026562172",
                        "username": "exampleuser",
                        "name": "ExampleName",
                        "surname": "ExampleSurname",
                        "fullName": "ExampleName ExampleSurname",
                        "avatar": "https://gitflic.ru/upload/img/d6fef627-adb2-43b2-95ad-88f4fb54c6d2.jpg"
                }
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Создание проблемы

POST /project/{userAlias}/{projectAlias}/issue

Запрос создает проблему по параметрам

Запрос Описание
GET /project/{userAlias}/{projectAlias}/issue Создать проблему
Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта

Пример JSON объекта

Пример JSON тела 
    
        {
            "title": "Пример названия",
            "description": "Пример описания"
        }


Responses

STATUS 200 пример JSON:

Пример JSON тела 
    
{
    "id": "3aa39bdc-7bdc-4ba0-a8b9-e604cfc7ed95",
    "localId": 2,
    "description": "Пример описания",
    "title": "Пример названия",
    "status": {
        "id": "OPEN",
        "title": "Новая",
        "hash": null,
        "alias": null,
        "ownerAlias": null,
        "color": "info",
        "hexColor": "17A2B8",
        "icon": null,
        "isDeleted": false
    },
    "assignedUsers": null,
    "labels": null,
    "projectAlias": "example-project",
    "userAlias": "example-alias",
    "updatedAt": " только что",
    "createdAt": " только что",
    "updatedBy": {
        "id": "6736240a-139d-4e62-be4f-cab026562172",
        "username": "exampleuser",
        "name": "ExampleName",
        "surname": "ExampleSurname",
        "fullName": "ExampleName ExampleSurname",
        "avatar": "https://gitflic.ru/upload/img/d6fef627-adb2-43b2-95ad-88f4fb54c6d2.jpg"
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Редактирование проблемы

PUT /project/{userAlias}/{projectAlias}/issue/{localId}/edit

Запрос редактирует проблему проекта по параметрам

Запрос Описание
GET /project/{userAlias}/{projectAlias}/issue/{localId}/edit Редактировать проблему
Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId Long ID проблемы

Параметры, которые можно передавать в теле запроса (JSON объекте), при редактировании

Переменная пути запроса Тип Описание
title String Название проблемы (обязательный параметр)
description String Описание проблемы (обязательный параметр)
status IssueStatus Статус проблемы
assignedUsers Set Информация о прикрепленных к проблеме пользователях
labels Set Лейблы проблемы

Пример JSON объекта

Пример JSON тела 
    
        {
            "title": "Пример названия",
            "description": "Пример описания"
        }


Responses

STATUS 200 пример JSON:

Пример JSON тела 
    
        {
    "id": "2739de5e-9ec0-4bac-86d2-0b639b46a875",
    "localId": 1,
    "description": "Пример описания",
    "title": "Пример названия",
    "status": {
        "id": "OPEN",
        "title": "Новая",
        "hash": null,
        "alias": null,
        "ownerAlias": null,
        "color": "info",
        "hexColor": "17A2B8",
        "icon": null,
        "isDeleted": false
    },
    "assignedUsers": [
        {
        "id": "6736240a-139d-4e62-be4f-cab026562172",
        "username": "exampleuser",
        "name": "ExampleName",
        "surname": "ExampleSurname",
        "fullName": "ExampleName ExampleSurname",
        "avatar": "https://gitflic.ru/upload/img/d6fef627-adb2-43b2-95ad-88f4fb54c6d2.jpg"
        }
    ],
    "labels": [
        {
            "id": "676c2a50-46d4-4d20-b612-49332baddc79",
            "hexColor": "F58A07",
            "title": "ошибка",
            "description": "Ошибка в новой фиче",
            "isTextLight": false
        }
    ],
    "projectAlias": "for-test-merge-request",
    "userAlias": "exampleuser",
    "updatedAt": "2 минуты назад",
    "createdAt": "5 дней назад",
    "updatedBy": {
        "id": "6736240a-139d-4e62-be4f-cab026562172",
        "username": "exampleuser",
        "name": "ExampleName",
        "surname": "ExampleSurname",
        "fullName": "ExampleName ExampleSurname",
        "avatar": "https://gitflic.ru/upload/img/d6fef627-adb2-43b2-95ad-88f4fb54c6d2.jpg"
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Удаление проблемы

DELETE /project/{userAlias}/{projectAlias}/issue/{localId}/delete

Удаление проблемы

Запрос Описание
DELETE /project/{userAlias}/{projectAlias}/issue/{localId}/delete Удалить проблему
Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId Long ID проблемы

Responses

STATUS 200 - Успешное удаление проблемы.

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Навигация