Skip to content

[php] Fix PHP generator validation for nullable required properties#22292

Merged
wing328 merged 2 commits into
OpenAPITools:masterfrom
achton:fix-issue-21497-php-null-nullable
Nov 8, 2025
Merged

[php] Fix PHP generator validation for nullable required properties#22292
wing328 merged 2 commits into
OpenAPITools:masterfrom
achton:fix-issue-21497-php-null-nullable

Conversation

@achton

@achton achton commented Nov 6, 2025

Copy link
Copy Markdown
Contributor

Fix PHP generator bug where nullable-but-required model properties were always flagged as invalid when set to null. Update validation/docblocks so explicit null assignments are honored. Closes #21497.

@jebentier @dkarlovi @mandrean @jfastnacht @ybelenko @renepardon

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.

@achton achton changed the title [php] [php] Fix PHP generator validation for nullable required properties Nov 6, 2025
Comment thread modules/openapi-generator/src/main/resources/php/model_generic.mustache Outdated
@achton achton force-pushed the fix-issue-21497-php-null-nullable branch from ec75a1d to 5e2e7e5 Compare November 7, 2025 12:15
* Sets {{name}}
*
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{name}}{{#description}} {{{.}}}{{/description}}{{^description}} {{{name}}}{{/description}}
* @param {{{dataType}}}{{#isNullable}}|null{{/isNullable}} ${{name}}{{#description}} {{{.}}}{{/description}}{{^description}} {{{name}}}{{/description}}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

can we also apply the same update here to handle both required and optional properties?

{{#vars}}
{{#required}}
if ($this->container['{{name}}'] === null) {
if ($this->container['{{name}}'] === null{{#isNullable}} && !$this->isNullableSetToNull('{{name}}'){{/isNullable}}) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

can we also apply the same update here to handle both required and optional properties?

@wing328

wing328 commented Nov 8, 2025

Copy link
Copy Markdown
Member

I'll address those comments with a separate PR

UPDATE: merged #22307

@wing328 wing328 merged commit fb444bf into OpenAPITools:master Nov 8, 2025
27 checks passed
@wing328 wing328 added this to the 7.18.0 milestone Nov 8, 2025
@wing328

wing328 commented Nov 9, 2025

Copy link
Copy Markdown
Member

FYI. Merged another PR (#22310) to refactor the template a bit

rajvesh pushed a commit to rajvesh/openapi-generator that referenced this pull request Dec 25, 2025
…penAPITools#22292)

* [php] Fix null+required properties to accept null values in generated models. Also fix PHP annotations related to same.

* [php] Update samples.
FreekVR added a commit to myparcelnl/sdk that referenced this pull request Jul 8, 2026
…re not allowing a `null` value

applies an upstream patch to our custom model mustache template. fixes "[name] can't be null" errors when setting a required value to `null` if a null value was allowed (eg presence is required, but can be empty)

see OpenAPITools/openapi-generator#22292
FreekVR added a commit to myparcelnl/sdk that referenced this pull request Jul 8, 2026
Completes the OpenAPITools/openapi-generator#22292 backport started in 3e9953a.
That commit fixed listInvalidProperties() but left the generated getter/setter
PHPDoc showing e.g. `@return int` for required+nullable properties like
RefTypesMoneyNullableAmount::amount, which can legitimately be null. Append the
|null that the upstream fix adds for these properties and regenerate.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
MyParcelBot pushed a commit to myparcelnl/sdk that referenced this pull request Jul 9, 2026
## [11.0.0-beta.29](v11.0.0-beta.28...v11.0.0-beta.29) (2026-07-09)

### ⚠ BREAKING CHANGES

* **openapi:** loosen and apply consistent validation for enum values, fix required nullables (#623)

### ✨ New Features

* **openapi:** loosen and apply consistent validation for enum values, fix required nullables ([#623](#623)) ([2164721](2164721)), closes [OpenAPITools/openapi-generator#22292](OpenAPITools/openapi-generator#22292) [OpenAPITools/openapi-generator#22292](OpenAPITools/openapi-generator#22292)
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.

[BUG] [php] Property is both nullable and non-nullable

2 participants