Перейти к содержимому

Состояние заказа архива

GET
/api/v2/salons/{salon_id}/photos/archive/{job_id}
curl --request GET \
--url https://app.photo-otchet.ru/api/v2/salons/1/photos/archive/7f3a9c1e \
--header 'Authorization: Bearer <token>'

Спрашивать раз в две секунды, пока state не станет ready или failed.

Потока событий у сборки нет намеренно: он не отвечает ровно там, где это нужнее всего — после перезагрузки страницы и после закрытия вкладки, — а сборка идёт секунды, редко минуты.

Сборка, не уложившаяся в отведённое время, становится failed здесь, при чтении: воркера могли убить на середине, и переписать запись было бы некому. Поэтому «вечного queued» не бывает.

job_id
required
Job Id

Заказ архива

string
>= 8 characters <= 64 characters

Заказ архива

salon_id
required
Salon Id

Салон

integer
>= 1

Салон

Состояние заказа

Media type application/json
ArchiveView

Заказ архива глазами клиента.

Одна и та же форма во всех ответах — и на заказ, и на вопрос о состоянии, и в списке своих: клиент рисует её одним кодом, а расхождение «что в ответе» и «что в записи» было бы враньём о состоянии.

Две разные потери: skipped — отброшенные на входе (ещё обрабатываются или удалены), а total - done при ready — не прочитавшиеся во время сборки. Из-за одного битого кадра архив на пятьсот фото не теряется.

object
id
required
Id

Заказ: с ним идти за состоянием и за файлом

string
state
required
ArchiveState

queued, building, ready или failed

string
Allowed values: queued building ready failed
format
required
ImageFormat

Формат файлов внутри архива

string
Allowed values: webp jpeg
max_size
Any of:
integer
total
required
Total

Сколько фото попадёт в архив

integer
done
required
Done

Сколько уже уложено; при ready — сколько уложилось

integer
skipped
required
Skipped

Сколько выбранных отброшено на входе

integer
bytes
Any of:
integer
created_at
required
Created At

Когда заказан

string format: date-time
expires_at
required
Expires At

Когда исчезнет

string format: date-time
reason
Any of:
string

Пример

{
"state": "queued",
"format": "webp"
}

Нет действующего входа: нет куки или токена, сессия истекла, токен отозван

Media type application/json
ErrorResponse

Отказ приложения: текст человеку и причина программе.

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}

Срок салона кончился: reason: salon_expired, в теле state и paid_until

Media type application/json
ErrorResponse

Отказ приложения: текст человеку и причина программе.

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}

Прав на это действие нет: не хватает политики или запрещён способ входа

Media type application/json
ErrorResponse

Отказ приложения: текст человеку и причина программе.

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}

Архива нет

Media type application/json
ErrorResponse

Отказ приложения: текст человеку и причина программе.

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"detail": "Архива нет: он истёк, удалён или заказан другим человеком"
}

Запрос не прошёл проверку схемы

Media type application/json
ValidationErrorResponse

Запрос не прошёл проверку схемы: единственный отказ, у которого detail — массив.

У доменных отказов detail строкой и reason: invalid (ErrorResponse), так что различать формы можно по reason, а не по типу detail.

object
detail
required
Detail
Array<object>
ValidationItem

Одна ошибка схемы запроса.

object
loc
required
Loc

Где именно: body, имя поля, индекс в списке

Array<string>
type
required
Type

Вид ошибки от pydantic: value_error, int_parsing, missing…

string
msg
required
Msg

Текст ошибки

string
for_user
required
For User

Текст написан для человека и готов к показу (value_error — наш валидатор). false — встроенный текст pydantic на английском: показывайте свою формулировку

boolean
reason
Reason
string
default: validation
Allowed value: validation

Пример

{
"reason": "validation"
}

Салон заблокирован оператором: reason: salon_blocked, причина в blocked_reason

Media type application/json
ErrorResponse

Отказ приложения: текст человеку и причина программе.

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}