Skip to content

[PHP][php-nextgen] List all possible return types (fix #17113) #20335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

JulianVennen
Copy link
Contributor

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:

    /**
     * ...
     * @return \OpenAPI\Client\Model\A|\OpenAPI\Client\Model\B|\OpenAPI\Client\Model\C
     */
    public function testGet(
        string $contentType = self::contentTypes['testGet'][0]
    ): \OpenAPI\Client\Model\A

After:

    /**
     * ...
     * @return \OpenAPI\Client\Model\A|\OpenAPI\Client\Model\B|\OpenAPI\Client\Model\C
     */
    public function testGet(
        string $contentType = self::contentTypes['testGet'][0]
    ): \OpenAPI\Client\Model\A|\OpenAPI\Client\Model\B|\OpenAPI\Client\Model\C

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

  • 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 Git BASH)
    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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

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

@JulianVennen JulianVennen requested a review from wing328 December 20, 2024 12:37
@wing328 wing328 merged commit 806b99e into OpenAPITools:master Dec 21, 2024
15 checks passed
@wing328
Copy link
Member

wing328 commented Dec 21, 2024

thanks for the PR, which has been merged.

timon-sbr pushed a commit to timon-sbr/openapi-generator that referenced this pull request Mar 13, 2025
…7113) (OpenAPITools#20335)

* [PHP][php-nextgen] List all possible return types (fix OpenAPITools#17113)

* Switch to LinkedHashSet
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.

2 participants