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

Bug Tracker

GET /api/v1/bugs

List Bugs

Авторизация: Bearer Token

Query параметры:

Параметр Тип По умолчанию Описание
status Status Фильтр по статусу
section Section Фильтр по разделу
priority Priority Фильтр по приоритету
search Search Поиск по заголовку и описанию
my_only My Only False Только мои заявки
page Page 1 Номер страницы
per_page Per Page 20 Записей на странице

Response 200: Successful Response

Поле Тип Обязательное Описание
items array[object] нет
total Total нет
page Page нет
per_page Per Page нет
pages Pages нет

Ошибки:

Код Описание
422 Validation Error

POST /api/v1/bugs

Create Bug

Авторизация: Bearer Token

Request Body:

Поле Тип Обязательное Описание
title Title да Заголовок (кратко о проблеме)
description Description да Подробное описание
section any нет Раздел системы
priority any нет Приоритет
screenshot_path Screenshot Path нет Путь к скриншоту

Response 201: Successful Response

Поле Тип Обязательное Описание
title Title нет Заголовок (кратко о проблеме)
description Description нет Подробное описание
section any нет Раздел системы
priority any нет Приоритет
id Id нет
status BugStatus нет Статус заявки
screenshot_path Screenshot Path нет
created_by Created By нет
assigned_to Assigned To нет
created_at Created At нет
updated_at Updated At нет
author any нет
comments_count Comments Count нет

Ошибки:

Код Описание
422 Validation Error

GET /api/v1/bugs/stats

Get Stats

Авторизация: Bearer Token

Response 200: Successful Response

Поле Тип Обязательное Описание
total Total нет
new New нет
in_progress In Progress нет
fixed Fixed нет
closed Closed нет
rejected Rejected нет
reopened Reopened нет

GET /api/v1/bugs/{bug_id}

Get Bug

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
bug_id Bug Id

Response 200: Successful Response

Поле Тип Обязательное Описание
title Title нет Заголовок (кратко о проблеме)
description Description нет Подробное описание
section any нет Раздел системы
priority any нет Приоритет
id Id нет
status BugStatus нет Статус заявки
screenshot_path Screenshot Path нет
created_by Created By нет
assigned_to Assigned To нет
created_at Created At нет
updated_at Updated At нет
author any нет
comments_count Comments Count нет
comments array[object] нет

Ошибки:

Код Описание
422 Validation Error

PATCH /api/v1/bugs/{bug_id}

Update Bug

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
bug_id Bug Id

Request Body:

Поле Тип Обязательное Описание
title Title нет
description Description нет
section any нет
priority any нет
screenshot_path Screenshot Path нет

Response 200: Successful Response

Поле Тип Обязательное Описание
title Title нет Заголовок (кратко о проблеме)
description Description нет Подробное описание
section any нет Раздел системы
priority any нет Приоритет
id Id нет
status BugStatus нет Статус заявки
screenshot_path Screenshot Path нет
created_by Created By нет
assigned_to Assigned To нет
created_at Created At нет
updated_at Updated At нет
author any нет
comments_count Comments Count нет

Ошибки:

Код Описание
422 Validation Error

DELETE /api/v1/bugs/{bug_id}

Delete Bug

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
bug_id Bug Id

Ошибки:

Код Описание
422 Validation Error

PATCH /api/v1/bugs/{bug_id}/status

Update Bug Status

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
bug_id Bug Id

Request Body:

Поле Тип Обязательное Описание
status any да Новый статус
assigned_to Assigned To нет Кто взял в работу
comment Comment нет Комментарий к изменению статуса

Response 200: Successful Response

Поле Тип Обязательное Описание
title Title нет Заголовок (кратко о проблеме)
description Description нет Подробное описание
section any нет Раздел системы
priority any нет Приоритет
id Id нет
status BugStatus нет Статус заявки
screenshot_path Screenshot Path нет
created_by Created By нет
assigned_to Assigned To нет
created_at Created At нет
updated_at Updated At нет
author any нет
comments_count Comments Count нет

Ошибки:

Код Описание
422 Validation Error

POST /api/v1/bugs/{bug_id}/comments

Add Comment

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
bug_id Bug Id

Request Body:

Поле Тип Обязательное Описание
comment Comment да Текст комментария
author Author да Автор комментария

Response 201: Successful Response

Поле Тип Обязательное Описание
comment Comment нет Текст комментария
id Id нет
bug_id Bug Id нет
author Author нет
created_at Created At нет

Ошибки:

Код Описание
422 Validation Error

GET /api/v1/bugs/{bug_id}/comments

List Comments

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
bug_id Bug Id

Response 200: Successful Response

array[BugCommentResponse]

Поле Тип Обязательное Описание
comment Comment нет Текст комментария
id Id нет
bug_id Bug Id нет
author Author нет
created_at Created At нет

Ошибки:

Код Описание
422 Validation Error

POST /api/v1/bugs/{bug_id}/screenshot

Upload Screenshot

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
bug_id Bug Id

Response 200: Successful Response

Поле Тип Обязательное Описание
title Title нет Заголовок (кратко о проблеме)
description Description нет Подробное описание
section any нет Раздел системы
priority any нет Приоритет
id Id нет
status BugStatus нет Статус заявки
screenshot_path Screenshot Path нет
created_by Created By нет
assigned_to Assigned To нет
created_at Created At нет
updated_at Updated At нет
author any нет
comments_count Comments Count нет

Ошибки:

Код Описание
422 Validation Error

GET /api/v1/bugs/{bug_id}/screenshot

Get Screenshot

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
bug_id Bug Id

Response 200: Successful Response

Нет данных

Ошибки:

Код Описание
422 Validation Error