Added new option methodNamingConvention to abstract php class
This PR added new additionalProperty "methodNamingConvention" to handle special cases with mutiple properties like "test" and "_test" which will end in the same getter and setter "getTest". (e.g. Rocket.chat GetApiV1ImList200ResponseImsInner.php) By setting methodNamingConvenetion to snake_case the method names will be snake_case like "get__test" and "get_test" which is not the php default but solves the problem and makes the generated classes useable without a duplication error. Also if there are two properties in openapi.yaml like "o_auth_test" and "oauth_test" it will end in a duplicate getter like "getOAuthTest" and "getOauthTest". (e.g. Keycloak RealmRepresentation.php)
This will add a solution for #1633 Its an alternative for #1634 too.
Technical Commitee PHP: @jebentier, @dkarlovi, @mandrean, @jfastnacht, @ybelenko, @renepardon
PR checklist
- [x] Read the contribution guidelines.
- [x] 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.
- [x] Run the following to build the project and update samples:
(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./mvnw clean package ./bin/generate-samples.sh ./bin/configs/*.yaml ./bin/utils/export_docs_generators.sh./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. - [x] File the PR against the correct branch:
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks) - [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.
i like it. @web-mi great job :thumbsup:
This PR added new additionalProperty "methodNamingConvention" to handle special cases with mutiple properties like "test" and "_test" which will end in the same getter and setter "getTest"
thanks for the PR
have you tried the operationId mapping option? Would that meet your requirement?
ref: https://github.com/openapitools/openapi-generator/blob/master/docs/customization.md#name-mapping
(this is not to say we won't accept this PR. it's still a good idea to have the option)
Yes i already have seen that option. But i'm automatically generating multiple api clients directly from their resources and i don't wan't to fix it all the time if they change something. :-) With the snake_case functions i had to fix nothing so i thought it would be a good idea to switch to the snake_case functions. ;-)
2 suggestions:
-
merge the latest master to this branch to fix the build errors
-
instead of adding a new option, copy the
modelPropertyNamingoption from some other generators which already support such use case to customize the property naming, e.g.
https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractScalaCodegen.java#L52
https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractScalaCodegen.java#L171
https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractScalaCodegen.java#L223
https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractScalaCodegen.java#L262
https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractScalaCodegen.java#L298
let me know if you need help