Состояние заказа архива
const url = 'https://app.photo-otchet.ru/api/v2/salons/1/photos/archive/7f3a9c1e';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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» не бывает.
Параметры
Заголовок раздела « Parameters »Параметры пути
Заголовок раздела « Path Parameters »Заказ архива
Заказ архива
Салон
Салон
Состояние заказа
Заказ архива глазами клиента.
Одна и та же форма во всех ответах — и на заказ, и на вопрос о состоянии, и в списке своих: клиент рисует её одним кодом, а расхождение «что в ответе» и «что в записи» было бы враньём о состоянии.
Две разные потери: skipped — отброшенные на входе (ещё обрабатываются или удалены),
а total - done при ready — не прочитавшиеся во время сборки. Из-за одного битого кадра
архив на пятьсот фото не теряется.
object
Заказ: с ним идти за состоянием и за файлом
queued, building, ready или failed
Формат файлов внутри архива
Сколько фото попадёт в архив
Сколько уже уложено; при ready — сколько уложилось
Сколько выбранных отброшено на входе
Когда заказан
Когда исчезнет
Пример
{ "state": "queued", "format": "webp"}Нет действующего входа: нет куки или токена, сессия истекла, токен отозван
Отказ приложения: текст человеку и причина программе.
Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен.
Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» —
в docs/api/1.0.md, раздел «Формат ошибки».
object
Текст для человека — показывается как есть
Причина отказа: по ней ветвится клиент
Пример
{ "reason": "unauthenticated"}Срок салона кончился: reason: salon_expired, в теле state и paid_until
Отказ приложения: текст человеку и причина программе.
Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен.
Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» —
в docs/api/1.0.md, раздел «Формат ошибки».
object
Текст для человека — показывается как есть
Причина отказа: по ней ветвится клиент
Пример
{ "reason": "unauthenticated"}Прав на это действие нет: не хватает политики или запрещён способ входа
Отказ приложения: текст человеку и причина программе.
Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен.
Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» —
в docs/api/1.0.md, раздел «Формат ошибки».
object
Текст для человека — показывается как есть
Причина отказа: по ней ветвится клиент
Пример
{ "reason": "unauthenticated"}Архива нет
Отказ приложения: текст человеку и причина программе.
Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен.
Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» —
в docs/api/1.0.md, раздел «Формат ошибки».
object
Текст для человека — показывается как есть
Причина отказа: по ней ветвится клиент
Пример
{ "detail": "Архива нет: он истёк, удалён или заказан другим человеком"}Запрос не прошёл проверку схемы
Запрос не прошёл проверку схемы: единственный отказ, у которого detail — массив.
У доменных отказов detail строкой и reason: invalid (ErrorResponse), так что различать формы
можно по reason, а не по типу detail.
object
Одна ошибка схемы запроса.
object
Где именно: body, имя поля, индекс в списке
Вид ошибки от pydantic: value_error, int_parsing, missing…
Текст ошибки
Текст написан для человека и готов к показу (value_error — наш валидатор). false — встроенный текст pydantic на английском: показывайте свою формулировку
Пример
{ "reason": "validation"}Салон заблокирован оператором: reason: salon_blocked, причина в blocked_reason
Отказ приложения: текст человеку и причина программе.
Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен.
Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» —
в docs/api/1.0.md, раздел «Формат ошибки».
object
Текст для человека — показывается как есть
Причина отказа: по ней ветвится клиент
Пример
{ "reason": "unauthenticated"}