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] Remove NUMBER_ prefix from enum vars if a name is provided, show enum descriptions #19555

Merged
merged 2 commits into from
Sep 16, 2024

Conversation

JulianVennen
Copy link
Contributor

You can provide names for integer enums using x-enum-varnames. When generating a PHP client using this property the enum names are still prefixed by NUMBER_.
If your enum name is ONLINE it will be NUMBER_ONLINE which is quite odd.

This PR fixes that by only adding the NUMBER_ prefix when the name provided starts with a digit.
It also fixes issues with other values of x-enum-varnames containing spaces or other forbidden characters.

Providing a description for each enum value can be done with x-enum-descriptions which is now also supported.

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

@JulianVennen JulianVennen changed the title Remove NUMBER_ prefix from enum vars if a name is provided, show enum descriptions [PHP] Remove NUMBER_ prefix from enum vars if a name is provided, show enum descriptions Sep 11, 2024
@wing328
Copy link
Member

wing328 commented Sep 16, 2024

thanks for the PR

tests passed locally

PHPUnit 9.6.19 by Sebastian Bergmann and contributors.

...............................................................  63 / 222 ( 28%)
............................................................... 126 / 222 ( 56%)
............................................................... 189 / 222 ( 85%)
.................................                               222 / 222 (100%)

Time: 00:01.442, Memory: 12.00 MB

OK (222 tests, 380 assertions)

@wing328 wing328 merged commit a5384d4 into OpenAPITools:master Sep 16, 2024
15 checks passed
@wing328 wing328 added this to the 7.9.0 milestone Sep 16, 2024
@wing328
Copy link
Member

wing328 commented Sep 16, 2024

sorry my tests were not done in the right way

i just re-run the tests but got

Time: 00:01.243, Memory: 12.00 MB

There was 1 error:

1) OpenAPI\Client\EnumTestTest::testPossibleValues
Error: Undefined constant OpenAPI\Client\Model\EnumTest::ENUM_INTEGER_1

/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php/OpenAPIClient-php/tests/EnumTestTest.php:14

can you please update the tests accordingly? thank you

@JulianVennen JulianVennen mentioned this pull request Sep 16, 2024
5 tasks
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