Skip to main content

Schema Migrations

This catalog lists every field rename registered via the @schema_migration decorator on a Pydantic request schema. When a client sends a deprecated field name, the API responds with the validation_deprecated_field error code plus a migration hint pointing at the current field name and the version in which the rename took effect.

The catalog below is auto-generated from the backend runtime registry (SCHEMA_MIGRATION_REGISTRY in app/api/v1/schema_migrations.py). Adding @schema_migration to a new schema and running node docs/scripts/generate-all.mjs will populate the table.

No migrations registered yet

No Pydantic request schema currently declares a rename via @schema_migration. The first time a field is deprecated in favour of a new name, this page will list it here with a direct link to the per-rename migration guide.