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

Контракты API и актуальность документации

Обновите контракт и его потребителей

После изменения операции API установите зависимости по Работа с локальной копией и выполните из корня репозитория.

poetry run python scripts/check_openapi_snapshot.py --write
npm --prefix frontend run api:gen
uv --directory sdk/python run --frozen scripts/sdk.py gen
npm --prefix sdk/typescript run gen

Скрипт выгружает снимок OpenAPI с настройками Django для продакшена. В diff сверьте идентификатор операции, типы запроса и ответа, правила доступа и коды ошибок. Затем проверьте затронутые вызовы из браузера и SDK. Клиенты обновляйте генераторами, ручные обёртки SDK меняйте в исходниках соответствующего пакета. Python SDK · TypeScript SDK

Актуализируйте обе языковые версии

  1. Обновите страницы на русском и английском в одной правке с кодом. Укажите входные данные, ожидаемый результат и ошибки. Назовите профиль развёртывания, если от него зависит порядок действий.

  2. Подключайте готовые примеры через literalinclude. Роль :source: ссылается на файл или символ той версии, из которой собран сайт. Для новой страницы задайте одинаковый путь и добавьте его в оба оглавления.

  3. При изменении ноды или хранилища сверьте параметры и требования с каталогом и API. Соберите обе языковые версии и проверьте примеры, ссылки и переключение языка. Сборка документации

ContextBase0.1.0

Поиск в документации