Skip to content

Add deprecation warning and explicit --output-model-type to docs#2911

Merged
koxudaxi merged 2 commits intomainfrom
docs/add-output-model-type-deprecation-warning
Jan 3, 2026
Merged

Add deprecation warning and explicit --output-model-type to docs#2911
koxudaxi merged 2 commits intomainfrom
docs/add-output-model-type-deprecation-warning

Conversation

@koxudaxi
Copy link
Copy Markdown
Owner

@koxudaxi koxudaxi commented Jan 3, 2026

Related Isses: #2466

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 3, 2026

Warning

Rate limit exceeded

@koxudaxi has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 48 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between f2859a6 and 61cb2c6.

📒 Files selected for processing (6)
  • docs/aliases.md
  • docs/formatting.md
  • docs/graphql.md
  • docs/index.md
  • docs/jsondata.md
  • docs/jsonschema.md

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.

❤️ Share

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 3, 2026

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

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Jan 3, 2026

CodSpeed Performance Report

Merging #2911 will not alter performance

Comparing docs/add-output-model-type-deprecation-warning (61cb2c6) with main (f2859a6)

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

Summary

✅ 11 untouched
⏩ 98 skipped1

Footnotes

  1. 98 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.40%. Comparing base (f2859a6) to head (61cb2c6).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2911   +/-   ##
=======================================
  Coverage   99.40%   99.40%           
=======================================
  Files          95       95           
  Lines       16905    16905           
  Branches     1990     1990           
=======================================
  Hits        16804    16804           
  Misses         52       52           
  Partials       49       49           
Flag Coverage Δ
unittests 99.40% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@koxudaxi
Copy link
Copy Markdown
Owner Author

koxudaxi commented Jan 3, 2026

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 3, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@koxudaxi koxudaxi merged commit e12cd96 into main Jan 3, 2026
36 checks passed
@koxudaxi koxudaxi deleted the docs/add-output-model-type-deprecation-warning branch January 3, 2026 08:45
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 3, 2026

Breaking Change Analysis

Result: No breaking changes detected

Reasoning: PR #2911 only modifies documentation files (docs/aliases.md, docs/formatting.md, docs/graphql.md, docs/index.md, docs/jsondata.md, docs/jsonschema.md). The changes add explicit --output-model-type pydantic_v2.BaseModel to code examples and include warning boxes explaining that omitting --output-model-type is deprecated. This is purely documentation improvement to help users prepare for a future change - no code, CLI behavior, defaults, or generated output is modified. The actual deprecation warning in code was added in PR #2910, not this PR.


This analysis was performed by Claude Code Action

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 3, 2026

🎉 Released in 0.52.1

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant