Skip to content
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

[php] fix @implements annotations in PHP client #11908

Merged
merged 1 commit into from
Jun 6, 2022

Conversation

IonBazan
Copy link
Contributor

@IonBazan IonBazan commented Mar 18, 2022

This PR fixes invalid @implements annotations for PHP classes. This is because Model classes should not be generic while current implementation requires users to provide types, which are not known to them (see https://github.com/onfido/api-php-client/issues/26).

This is only reported when using PHPStan with checkGenericClassInNonGenericObjectType: true - https://phpstan.org/blog/generics-in-php-using-phpdocs

image

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@IonBazan IonBazan changed the base branch from master to 6.0.x March 18, 2022 07:21
@IonBazan IonBazan requested a review from jimschubert as a code owner March 18, 2022 07:21
@IonBazan IonBazan changed the base branch from 6.0.x to master March 18, 2022 07:21
@IonBazan
Copy link
Contributor Author

Tagging:

@ybelenko ybelenko changed the title fix @implements annotations in PHP client [php] fix @implements annotations in PHP client Mar 18, 2022
@wing328 wing328 added this to the 6.0.1 milestone Jun 6, 2022
@wing328
Copy link
Member

wing328 commented Jun 6, 2022

@wing328 wing328 merged commit 5bd3694 into OpenAPITools:master Jun 6, 2022
@wing328
Copy link
Member

wing328 commented Jun 6, 2022

@IonBazan thanks for the PR, which has been merged into the master. Do you know if there's any way (e.g. command) to detect these kind of issues in the annotations?

@IonBazan IonBazan deleted the bugfix/php-implements branch June 6, 2022 04:25
@IonBazan
Copy link
Contributor Author

IonBazan commented Jun 6, 2022

Hi @wing328 thanks for merging! The problem was detected using PHPStan with checkGenericClassInNonGenericObjectType: true, when using an API generated with this tool so I'd say it's best to check that during code review as model classes should not be generic.

@wing328
Copy link
Member

wing328 commented Jun 6, 2022

@IonBazan thanks for the info. will try to add it to the CI later to cover issue like this moving forward.

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.

3 participants