К содержанию
Документация
APIСправочник

Редактор

Серверные снимки колоды из редактора: редакция, картинки и экспорт зафиксированной редакции.

Файл сгенерирован командой yarn nx run api:export-openapi из декораторов API и Zod-схем. Вручную не редактируется.

Серверные снимки колоды из редактора: редакция, картинки и экспорт зафиксированной редакции.

GET /editor/decks/{deckId}/exports/{exportId}/{name}

Скачать экспорт редакции

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
namepathда
exportIdpathда
deckIdpathда

Ответы

КодОписаниеСхема
200Файл экспорта.string
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

POST /editor/decks/{deckId}/media

Записать картинку снимка Байты на диске, в базе только ссылка. Повтор тех же байт — та же ссылка.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
deckIdpathда

Ответы

КодОписаниеСхема
201Создано или запущено.EditorMediaPutResponse
400Неверный запрос: тело или параметры не прошли проверку.ApiError
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError
409Конфликт состояния: действие сейчас невозможно.ApiError

GET /editor/decks/{deckId}/media/{mediaPart}

Скачать картинку снимка Один сегмент пути: upload%2F<id>.png. Чужой аккаунт получает 404.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
mediaPartpathда
deckIdpathда

Ответы

КодОписаниеСхема
200Картинка.string
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

POST /editor/decks/{deckId}/revisions/{revision}/export

Экспорт редакции Файл собирается из сохранённой редакции. Правки после этого запроса в него не попадают. Модель не вызывается.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
revisionpathда
deckIdpathда

Тело запроса

Ответы

КодОписаниеСхема
201Создано или запущено.EditorRevisionExportResponse
400Неверный запрос: тело или параметры не прошли проверку.ApiError
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError
409Конфликт состояния: действие сейчас невозможно.ApiError
503Недоступен движок, база данных или хранилище ключей.ApiError

GET /editor/decks/{deckId}/snapshot

Снимок колоды Последняя редакция, сохранённая этим аккаунтом. Чужой колоды нет. Снимка ещё нет — snapshot: null.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
deckIdpathда

Ответы

КодОписаниеСхема
200Успешно.EditorSnapshotLoad
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

POST /editor/decks/{deckId}/snapshot

Сохранить редакцию Публикуется только когда все картинки уже записаны. expectedRevision — редакция, которую клиент видел. Та же редакция у двух клиентов не перезаписывается молча: в ответе конфликт, обе копии сохранены. Повтор с тем же idempotencyKey возвращает первый результат.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
deckIdpathда

Тело запроса

Ответы

КодОписаниеСхема
200Успешно.EditorSnapshotSaveResponse
400Неверный запрос: тело или параметры не прошли проверку.ApiError
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError
409Конфликт состояния: действие сейчас невозможно.ApiError

На этой странице