[PHP] Add missing qualifier for enum parameters #19567
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If you have an endpoint that takes a single instance of an enum as a parameter, its Qualifier (e.g. \OpenAPI\Client\Model) is missing in both the PHPDoc and the function parameter types. This PR fixes that. (See this method in the echo_api for an example).
This PR fixes that by adding an override for getParameterDataType in the AbstractPHPGenerator.
For some documentation files this causes a duplicated qualifier, but I am pretty sure this happens because these classes do not have a baseType (that is used in the generator when setting the example value). This can also be seen because the link to the documentation file for these models (in the table following it) is just
../Model/.md
which is generated from../Model/{{baseType}}.md
.For enum arrays and maps, this duplicated qualifier already exists before the changes I made.
I was not able to figure out what would cause this to be null/empty, but it seems unrelated to this PR.
PR checklist
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.
master
(upcoming 7.6.0 minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)@jebentier, @dkarlovi, @mandrean, @jfastnacht, @ybelenko, @renepardon