[PHP][php-nextgen] List all possible return types (fix #17113) #20335
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.
API Endpoints sometimes return different datatypes with different status codes. In the php-nextgen generator on the first such type was used as the return type which would cause fatal errors if any other type was returned.
This PR fixes that by returning an intersection type with all possible return types.
For a minimal spec example the change looks like this.
Before:
After:
As @individual-it described in #17113 intersection types may not have the same type repeated.
This is prevented by checking if the list of known types already contains the type, before it is added.
Using a Set for this would cause the types to be ordered by the hash function instead of the order in the openapi spec.
Java 21 would make this easier using SequencedSet, but the current solution works as well.
The deduplication of return types is also applied to phpdoc comments. Since they support type hints for the contents of arrays, they are calculated independently.
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
(upcoming7.x.0
minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)@jebentier @dkarlovi @mandrean @jfastnacht @ybelenko @renepardon