Документация

Проверка схемы

Версия v2.3.1 · Обновлено

Проверка схемы#

Поддерживайте согласованность схем запросов, документации OpenAPI и форм UI.

Типовые проверки:

  • если поле присутствует в теле запроса Swagger, оно должно присутствовать в соответствующей схеме запроса;
  • если схема отклоняет поле из-за extra="forbid", Swagger не должен объявлять это поле;
  • значения enum должны использовать те же константы, что и валидация на бэкенде;
  • старые значения ролей, такие как read_only и rw, не должны появляться в схемах запросов после миграции;
  • каналы email не должны документировать получателей на уровне канала или поля транспорта SMTP.

Рекомендуемые локальные проверки:

pytest tests
python3 -m compileall -q app tests