Analyst Camp API

200 SuccessResponse

Body

Object

status

string required

Статусное сообщение

Example:

Импорт завершен

200 EmptyResponse

Выполнить валидацию (VALIDATE-DOCUMENTATION)

POST /v1/documentation/{contentId}/_validate

Получить валидацию (GET-VALIDATION)

POST /v1/documentation/{contentId}/validation

POST /v1/documentation/{contentId}/_validate

Выполнить валидацию статей Confluence, которые находятся в родительском разделе contentId

Path variables

contentId

string required

Responses

200 ValidationResponse

400 ValidateError

POST /v1/documentation/{contentId}/validation

Path variables

contentId

string required

Responses

200 ValidationResponse

Object

key

string required

Ключ Jira задачи

Example:

MPSM-4362

link

string required

Ссылка на Jira задачу

Example:

https://jira.app.local/browse/MPSM-4362

summary

string required

Заголовок Jira задачи

Example:

Переход на геозоны. Чекаут

versions

Array of string required

Список версий, в рамках которых задача будет выполнена

Example:

4.48.0 05.02-22.02 3w

Object

string required

ID статьи

Example:

429155581

link

string required

Ссылка на статью

Example:

https://confluence.app.local/pages/viewpage.action?pageId=429155581

title

string required

Заголовок статьи

Example:

Экран корзины

jiras

Array of Jira required

Список Jira задач, связанных с данной статьей

400 ValidateError

Body

Object

error

Object

type

string

Мнемокод ошибки

Enumeration:

VALIDATE_ERROR

detail

string

Описание ошибки

Example:

Ошибка при выполнении валидации

200 ValidationResponse

Body

Object

datetime

string required

Дата и время проведения валидации

Example:

2020-02-13T17:29:10+03:00

contents

Array of Content required

Список статей Confluence