No actionable comments were generated in the recent review. 🎉

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

📚 Docs Preview: https://pr-3072.datamodel-code-generator.pages.dev

Merging this PR will degrade performance by 18.79%

❌ 11 regressed benchmarks
⏩ 98 skipped benchmarks¹

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

_{Comparing codex/update-project-usage-list (45e46d9) with main (7d41fef)}

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (7d41fef) to head (45e46d9).
⚠️ Report is 1 commits behind head on main.

@@            Coverage Diff            @@
##              main     #3072   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           87        87           
  Lines        18237     18237           
  Branches      2087      2087           
=========================================
  Hits         18237     18237           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Breaking Change Analysis

Result: Breaking changes detected

Reasoning: Despite the PR title suggesting only documentation changes, this PR contains substantial code changes: (1) Generated code output changes significantly - default values for model-referencing fields switch from default_factory=lambda: Model.model_validate(...) and TypeAdapter(...).validate_python(...) patterns to raw defaults with validate_default=True, which changes the exact generated code output; (2) Six Jinja2 templates are modified with new branching logic for empty fields lists, requiring custom template updates; (3) New CLI option --allow-remote-refs with deprecation warning for current default behavior; (4) New SchemaFetchError exception replaces raw httpx exceptions for HTTP failures; (5) Discriminator values expanded from str to str | int | bool, changing generated Literal types; (6) Removed ValidatedDefault, WrappedDefault classes and SUPPORTS_VALIDATED_DEFAULT, SUPPORTS_WRAPPED_DEFAULT class variables from the internal API.

Content for Release Notes

Code Generation Changes

• Default values for fields referencing models now use validate_default=True instead of default_factory=lambda: - Fields with structured defaults (dicts/lists) that reference Pydantic models previously generated default_factory=lambda: Model.model_validate(...) or default_factory=lambda: TypeAdapter(Type).validate_python(...) patterns. They now generate the raw default value directly with validate_default=True (e.g., Field({'key': 'val'}, validate_default=True) instead of Field(default_factory=lambda: Model.model_validate({'key': 'val'}))). This changes the generated code output and may affect users who depend on the exact generated code structure, pin generated output in tests, or use custom post-processing. The runtime behavior should be equivalent for Pydantic v2 users. (Refresh project usage list #3072)

• TypeAdapter import removed from generated code - Generated code no longer imports pydantic.TypeAdapter for default value handling. Code that previously used TypeAdapter(...).validate_python(...) in default factories now uses inline defaults with validate_default=True. (Refresh project usage list #3072)

• Integer and boolean discriminator values now supported in generated Literal types - Discriminator fields previously only generated string literal values. They now support int and bool discriminator values (e.g., Literal[1] instead of Literal['1']), which changes generated code for schemas using integer discriminator mappings. (Refresh project usage list #3072)

Custom Template Update Required

• Type alias templates (TypeAliasAnnotation.jinja2, TypeAliasType.jinja2, TypeStatement.jinja2, and their Union variants) now handle an empty fields list with a fallback to base_class - If you have custom copies of these templates, they need to be updated to include the new {%- if fields %}...{%- else %}...{%- endif %} branching logic. Without this update, custom templates may error when fields is empty. (Refresh project usage list #3072)

API/CLI Changes

• New --allow-remote-refs / --no-allow-remote-refs CLI option and allow_remote_refs config field - Remote $ref fetching over HTTP/HTTPS now emits a deprecation warning by default. Pass --allow-remote-refs to suppress the warning, or --no-allow-remote-refs to block remote fetching entirely. In a future version, remote fetching will be disabled by default. Users relying on remote $ref resolution should add --allow-remote-refs to their invocations to avoid the deprecation warning and prepare for the future default change. (Refresh project usage list #3072)

• New SchemaFetchError exception for HTTP fetch failures - Remote schema fetching now raises SchemaFetchError (instead of propagating raw httpx exceptions) on HTTP errors, non-2xx status codes, or unexpected HTML responses. Users catching specific httpx exceptions from remote ref resolution will need to catch SchemaFetchError instead. (Refresh project usage list #3072)

Error Handling Changes

• HTTP fetch errors now raise SchemaFetchError with validation of response content type - Previously, fetching a remote $ref that returned an HTML error page would silently pass the HTML through as schema content. Now it raises SchemaFetchError if the response has text/html content type or a 4xx/5xx status code. This may cause previously-silent failures to become loud errors. (Refresh project usage list #3072)

This analysis was performed by Claude Code Action

🎉 Released in 0.56.0

This PR is now available in the latest release. See the release notes for details.