Add propertyNames and x-propertyNames support by koxudaxi · Pull Request #2789 · koxudaxi/datamodel-code-generator

koxudaxi · 2025-12-24T18:08:48Z

coderabbitai · 2025-12-24T18:08:56Z

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 1 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 f59786f and 5a415f4.

⛔ Files ignored due to path filters (9)

tests/data/jsonschema/property_names_allof_ref.json is excluded by !tests/data/**/*.json and included by none
tests/data/jsonschema/property_names_enum.json is excluded by !tests/data/**/*.json and included by none
tests/data/jsonschema/property_names_enum_integers.json is excluded by !tests/data/**/*.json and included by none
tests/data/jsonschema/property_names_min_max_length.json is excluded by !tests/data/**/*.json and included by none
tests/data/jsonschema/property_names_nested.json is excluded by !tests/data/**/*.json and included by none
tests/data/jsonschema/property_names_no_additional.json is excluded by !tests/data/**/*.json and included by none
tests/data/jsonschema/property_names_pattern.json is excluded by !tests/data/**/*.json and included by none
tests/data/openapi/x_property_names.yaml is excluded by !tests/data/**/*.yaml and included by none
tests/data/openapi/x_property_names_non_dict.yaml is excluded by !tests/data/**/*.yaml and included by none

📒 Files selected for processing (13)

src/datamodel_code_generator/parser/jsonschema.py
tests/data/expected/main/jsonschema/property_names_allof_ref.py
tests/data/expected/main/jsonschema/property_names_enum.py
tests/data/expected/main/jsonschema/property_names_enum_integers.py
tests/data/expected/main/jsonschema/property_names_min_max_length.py
tests/data/expected/main/jsonschema/property_names_nested.py
tests/data/expected/main/jsonschema/property_names_no_additional.py
tests/data/expected/main/jsonschema/property_names_pattern.py
tests/data/expected/main/jsonschema/string_dict.py
tests/data/expected/main/openapi/x_property_names.py
tests/data/expected/main/openapi/x_property_names_non_dict.py
tests/main/jsonschema/test_main_jsonschema.py
tests/main/openapi/test_main_openapi.py

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feature/property-names-support

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.}

codspeed-hq · 2025-12-24T18:15:32Z

CodSpeed Performance Report

Merging #2789 will not alter performance

_{Comparing feature/property-names-support (5a415f4) with main (f59786f)}

Summary

✅ 73 untouched
⏩ 10 skipped¹

10 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 · 2025-12-24T18:32:11Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.48%. Comparing base (a46ceb8) to head (5a415f4).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #2789    +/-   ##
========================================
  Coverage   99.47%   99.48%            
========================================
  Files          88       88            
  Lines       13213    13418   +205     
  Branches     1556     1579    +23     
========================================
+ Hits        13144    13349   +205     
  Misses         36       36            
  Partials       33       33

Flag	Coverage Δ
unittests	`99.48% <100.00%> (+<0.01%)`	⬆️

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.

Use the model_validate utility function from util module instead of calling JsonSchemaObject.model_validate() directly, which only exists in Pydantic v2. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

Test that x-propertyNames with non-dict value (e.g., boolean) is correctly ignored, achieving 100% diff coverage. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

github-actions · 2025-12-24T19:25:45Z

Breaking Change Analysis

Result: No breaking changes detected

Reasoning: This PR adds new functionality (propertyNames and x-propertyNames support) that was previously unsupported. While the expected output for string_dict.py changed, this is because the test schema already contained a propertyNames field that was previously ignored. The generated code now correctly processes this field according to JSON Schema spec. This is a feature addition, not a breaking change because: (1) Users whose schemas don't have propertyNames are unaffected, (2) Users whose schemas have propertyNames were already getting incorrect/incomplete output since the field was silently ignored, (3) The new behavior is the correct interpretation of the JSON Schema spec. The change improves correctness rather than breaking existing correct functionality. No CLI/API changes, no template changes required, no Python version changes, and no error handling changes were made.

This analysis was performed by Claude Code Action

* Add propertyNames and x-propertyNames support * Fix Pydantic v1 compatibility for x-propertyNames Use the model_validate utility function from util module instead of calling JsonSchemaObject.model_validate() directly, which only exists in Pydantic v2. 🤖 Generated with [Claude Code](https://claude.com/claude-code) * Add test for x-propertyNames non-dict branch coverage Test that x-propertyNames with non-dict value (e.g., boolean) is correctly ignored, achieving 100% diff coverage. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

* Add --collapse-root-models-name-strategy option * docs: update CLI reference documentation and prompt data 🤖 Generated by GitHub Actions * Add pragma no cover for defensive edge cases * Achieve 100% diff coverage for collapse-root-models-name-strategy * Use cast instead of type ignore comment * Remove line comments from collapse-root-models implementation * Add complex e2e tests for collapse-root-models-name-strategy * Update reference metadata when renaming in parent strategy * Refactor collapse-root-models tests to use parameterization for v1/v2 * Add schema path context to error messages (#2786) * Return str or dict when output=None in generate() (#2787) * Add --http-timeout CLI option (#2788) * Add --http-timeout CLI option for configurable HTTP request timeout * docs: update CLI reference documentation and prompt data 🤖 Generated by GitHub Actions --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Pass schema extensions to templates (#2790) * Pass schema extensions to templates * Move model_base import to top of file * Add schema extensions documentation Document how x-* schema extensions are passed to custom templates via the extensions variable, with examples for database model configuration and other use cases. 🤖 Generated with [Claude Code](https://claude.com/claude-code) * Add propertyNames and x-propertyNames support (#2789) * Add propertyNames and x-propertyNames support * Fix Pydantic v1 compatibility for x-propertyNames Use the model_validate utility function from util module instead of calling JsonSchemaObject.model_validate() directly, which only exists in Pydantic v2. 🤖 Generated with [Claude Code](https://claude.com/claude-code) * Add test for x-propertyNames non-dict branch coverage Test that x-propertyNames with non-dict value (e.g., boolean) is correctly ignored, achieving 100% diff coverage. 🤖 Generated with [Claude Code](https://claude.com/claude-code) * Add support for additional_imports in extra-template-data JSON (#2793) * Update zensical to 0.0.15 (#2794) * Add --use-field-description-example option (#2792) * Add --use-field-description-example option * docs: update CLI reference documentation and prompt data 🤖 Generated by GitHub Actions * Add tests for complete branch coverage of docstring property --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Fix formatting in test file --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Add propertyNames and x-propertyNames support

2a7a919

koxudaxi force-pushed the feature/property-names-support branch from c3fb29e to 78022ca Compare December 24, 2025 19:08

koxudaxi added 2 commits December 24, 2025 19:10

koxudaxi force-pushed the feature/property-names-support branch from 78022ca to 5a415f4 Compare December 24, 2025 19:10

koxudaxi merged commit 63288b4 into main Dec 24, 2025
38 checks passed

koxudaxi deleted the feature/property-names-support branch December 24, 2025 19:23

github-actions Bot added the breaking-change-analyzed label Dec 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add propertyNames and x-propertyNames support#2789

Add propertyNames and x-propertyNames support#2789
koxudaxi merged 3 commits intomainfrom
feature/property-names-support

koxudaxi commented Dec 24, 2025

Uh oh!

coderabbitai Bot commented Dec 24, 2025 •

edited

Loading

Rate limit exceeded

Uh oh!

codspeed-hq Bot commented Dec 24, 2025 •

edited

Loading

Uh oh!

codecov Bot commented Dec 24, 2025 •

edited

Loading

Uh oh!

Uh oh!

github-actions Bot commented Dec 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

koxudaxi commented Dec 24, 2025

Uh oh!

coderabbitai Bot commented Dec 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Uh oh!

codspeed-hq Bot commented Dec 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #2789 will not alter performance

Summary

Footnotes

Uh oh!

codecov Bot commented Dec 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

github-actions Bot commented Dec 24, 2025

Breaking Change Analysis

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

coderabbitai Bot commented Dec 24, 2025 •

edited

Loading

codspeed-hq Bot commented Dec 24, 2025 •

edited

Loading

codecov Bot commented Dec 24, 2025 •

edited

Loading