Skip to content

[Python] Fix incorrectly capitalized mustache identifier in apis template#12045

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
harmony7:ruby-apis-template-fix
Apr 5, 2022
Merged

[Python] Fix incorrectly capitalized mustache identifier in apis template#12045
wing328 merged 1 commit intoOpenAPITools:masterfrom
harmony7:ruby-apis-template-fix

Conversation

@harmony7
Copy link
Contributor

@harmony7 harmony7 commented Apr 5, 2022

This tiny PR fixes the spelling of an identifier that was incorrectly cased in a mustache template. The fix only affects a comment in the output, so it will make no runtime difference when consuming a generated client.

In the Python generator, the package name is available as {{packageName}}, but in src/main/resources/python/__init__apis.mustache, it was being referenced as {{packagename}}.
This produced incorrect output such as:

# In order to avoid this, import only the API that you directly need like:
#
#   from .api.my_api import MyApi

(note the missing package name)

The corrected output:

# In order to avoid this, import only the API that you directly need like:
#
#   from my_package.api.my_api import MyApi

cc @cliffano @zlx @autopp

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

@harmony7 harmony7 marked this pull request as ready for review April 5, 2022 03:18
@harmony7
Copy link
Contributor Author

harmony7 commented Apr 5, 2022

Hi, the CI is giving problems in the "samples up-to-date" step.

The details reveal a problem with a completely unrelated file, so I don't think this is a problem on my end. Can someone check the status of this for me? thanks.

@wing328 wing328 changed the title [Ruby] Fix incorrectly capitalized mustache identifier in apis template [Python] Fix incorrectly capitalized mustache identifier in apis template Apr 5, 2022
@wing328
Copy link
Member

wing328 commented Apr 5, 2022

Hi, the CI is giving problems in the "samples up-to-date" step.

I've fixed that in the master.

Your PR looks good. Thanks for that.

@wing328 wing328 merged commit efc1a66 into OpenAPITools:master Apr 5, 2022
@wing328
Copy link
Member

wing328 commented Apr 5, 2022

cc @taxpon (2017/07) @frol (2017/07) @mbohlool (2017/07) @cbornet (2017/09) @kenjones-cisco (2017/11) @tomplus (2018/10) @arun-nalla (2019/11) @spacether (2019/11) ❤️

@harmony7
Copy link
Contributor Author

harmony7 commented Apr 5, 2022

Yes of course this is Python. I got confused I guess, have been using different generators one after the other.

Thanks for the approval and merge, cheers =)

@harmony7 harmony7 deleted the ruby-apis-template-fix branch April 5, 2022 11:04
cachescrubber pushed a commit to cachescrubber/openapi-generator that referenced this pull request Apr 9, 2022
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