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] Add missing qualifier for enum parameters #19567

Merged
merged 1 commit into from
Sep 23, 2024

Conversation

JulianVennen
Copy link
Contributor

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

  • 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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (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.6.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

@wing328
Copy link
Member

wing328 commented Sep 23, 2024

I was not able to figure out what would cause this to be null/empty, but it seems unrelated to this PR.

can you please open a separate issue to track it when you've time?

@wing328
Copy link
Member

wing328 commented Sep 23, 2024

tested locally and the result is good

@wing328 wing328 merged commit 78f2f70 into OpenAPITools:master Sep 23, 2024
15 checks passed
@wing328 wing328 added this to the 7.9.0 milestone Sep 23, 2024
@JulianVennen JulianVennen deleted the php-nextgen-imports branch September 24, 2024 08:20
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