Pydantic Migration Guides

How to replace schema_extra with json_schema_extra in Pydantic v2

Migrate schema_extra in Config to json_schema_extra in model_config.

Start here

The safe first move

Replace schema_extra with json_schema_extra in your model_config.

Stop before automation when: schema_extra as a callable that needs signature changes. Files with other unsupported Config keys.

Target shape

class User(BaseModel):
    model_config = ConfigDict(
        json_schema_extra={"examples": [{"name": "Alice"}]}
    )

Repo fit check

Want to know if your repo has this pattern?

Run the matching scanner locally first. Read the free findings and manual alternatives; consider paid cleanup only if supported patterns repeat enough to justify the price.

  • Local scan; no repository upload.
  • Supported findings are separated from manual-review findings.
  • Buy only when the repeated pattern is worth automating.
Run the Pydantic scan first View example report See when to buy
Example scan summary
supported_findings: 38
manual_review_findings: 6
files_uploaded: 0
confidence: reviewable

Why this page exists

How to replace schema_extra with json_schema_extra in Pydantic v2

schema_extra was renamed to json_schema_extra in Pydantic v2.

Direct answer

What changes

Replace schema_extra with json_schema_extra in your model_config.

Example

Before and after

Before

class User(BaseModel):
    class Config:
        schema_extra = {"examples": [{"name": "Alice"}]}

After

class User(BaseModel):
    model_config = ConfigDict(
        json_schema_extra={"examples": [{"name": "Alice"}]}
    )

Decision path

If this repeats across the repo, open the evaluation pages next.

The cleanup pack is strongest when the repo still uses direct pydantic imports and a clean validator/settings/config subset.

  • The repo has direct pydantic or pydantic.v1 imports, BaseSettings usage, safe Config blocks, or simple validators.
  • The migration pain is repetitive v1-to-v2 cleanup, not a custom semantic rewrite.
  • If the scan output is ambiguous, review its findings and upstream guidance. Do not buy expecting unsupported cases to be resolved.

Typical symptoms

  • Schema generation ignores the old schema_extra key.
  • Config migration needs to rename this alongside other keys.
  • Teams want all Config key renames handled consistently.

What the product covers

  • schema_extra to json_schema_extra rename.
  • Integration with Config to model_config migration.
  • Reporting for where the old key appears.

Manual-review boundary

  • schema_extra as a callable that needs signature changes.
  • Files with other unsupported Config keys.
  • Dynamic schema_extra generation.

FAQ

Fast answers before you decide

What is the safest fix for schema_extra json_schema_extra pydantic v2?

Replace schema_extra with json_schema_extra in your model_config.

Can schema_extra json_schema_extra pydantic v2 be automated?

Automate only the supported subset: schema_extra to json_schema_extra rename. Integration with Config to model_config migration. Reporting for where the old key appears. Keep these cases in manual review: schema_extra as a callable that needs signature changes. Files with other unsupported Config keys. Dynamic schema_extra generation.

When should I buy Pydantic v1 to v2 Migration Cleanup Pack?

Use Pydantic v1 to v2 Migration Cleanup Pack only when this pattern repeats across enough files that manual cleanup is still costly. Use the free report and upstream guide to evaluate fit. Buy only if repeated supported edits justify the price; no paid assessment is required.

Purchase fit

Choose the lowest-risk next step.

One matching page is not enough by itself. Run the local scan, then buy only when the same supported pattern appears often enough to matter.

Buy if

  • The repo has direct pydantic or pydantic.v1 imports, BaseSettings usage, safe Config blocks, or simple validators.
  • The migration pain is repetitive v1-to-v2 cleanup, not a custom semantic rewrite.
  • The team accepts manual-review findings for alias-heavy imports and signature-heavy validators.

What the workflow includes

  • Installable local CLI workflow, not a hosted black box.
  • Supported validator, settings, import, and config rewrites.
  • Demo report, public proof, coverage notes, rollback checklist, and buyer terms.

Before checkout

  • Stripe Checkout handles secure payment and receipts.
  • Download your purchased ZIP after payment.
  • Runs locally; no hosted API, repo upload, or production credentials needed.
  • The free report includes the evidence needed to evaluate fit. Paid summary and template add-ons are optional.
  • 14-day refund review for published-scope or delivery mismatches.