Skip to content

[BUG] Fix Patch operations reset fields to default if not specified #23650#23676

Closed
swapneswarsundarray wants to merge 3 commits intoOpenAPITools:masterfrom
swapneswarsundarray:fix/python-patch-exclude-unset
Closed

[BUG] Fix Patch operations reset fields to default if not specified #23650#23676
swapneswarsundarray wants to merge 3 commits intoOpenAPITools:masterfrom
swapneswarsundarray:fix/python-patch-exclude-unset

Conversation

@swapneswarsundarray
Copy link
Copy Markdown

@swapneswarsundarray swapneswarsundarray commented May 2, 2026

Fixes #23650

Problem

In the Python generator, PATCH models were sending default values even when fields were not explicitly set by the client. This caused unintended updates where fields were reset to defaults.

Root Cause

The generated to_dict() method uses exclude_none=True, which only skips None values but still includes fields with default values.

Solution

Use exclude_unset=True for PATCH models so that only explicitly set fields are included in the payload. Non-PATCH models continue using exclude_none=True to avoid breaking existing behavior.

Changes

  • Updated model_generic.mustache to conditionally use exclude_unset=True for PATCH models
  • Added logic in PythonClientCodegen to detect PATCH models (based on naming convention) and set a flag

Impact

PATCH requests now send only modified fields, preventing unintended resets. Behavior for non-PATCH models remains unchanged.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Fixes #23650. Python PATCH models now send only explicitly set fields for classes prefixed with Patched, preventing defaults from overwriting existing data; non-PATCH behavior is unchanged. Also fixes template formatting to avoid broken Python output.

  • Bug Fixes
    • In model_generic.mustache, use inline conditional args in model_dump(...): exclude_unset=True for vendorExtensions.isPatchedModel, otherwise exclude_none=True.
    • In PythonClientCodegen#postProcessModels, mark Patched* models with isPatchedModel for template handling.

Written for commit 2d3bd2e. Summary will update on new commits.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

swapneswarsundarray added a commit to swapneswarsundarray/openapi-generator that referenced this pull request May 2, 2026
Prevents sending default values in PATCH requests when fields are not
explicitly set by the client. Only affects models starting with 'Patched'. Fixes OpenAPITools#23676
@swapneswarsundarray swapneswarsundarray force-pushed the fix/python-patch-exclude-unset branch from 1d633da to 0a71bbb Compare May 2, 2026 13:58
Prevents sending default values in PATCH requests when fields are not
explicitly set by the client. Only affects models starting with 'Patched'. Fixes OpenAPITools#23650
@swapneswarsundarray swapneswarsundarray force-pushed the fix/python-patch-exclude-unset branch from 0a71bbb to a3ec44e Compare May 2, 2026 14:01
…n to prevent broken output

Fixed improper indentation in Mustache template that could cause broken
Python code generation. Now uses inline conditions within method call
instead of duplicated method blocks.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Patch operations reset fields to default if not specified

1 participant