Skip to content

Remove dummy variable declaration for context.Context from generated go code#11641

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
moznion:remove_context_dummy_var_decl
Feb 18, 2022
Merged

Remove dummy variable declaration for context.Context from generated go code#11641
wing328 merged 1 commit intoOpenAPITools:masterfrom
moznion:remove_context_dummy_var_decl

Conversation

@moznion
Copy link
Copy Markdown
Contributor

@moznion moznion commented Feb 17, 2022

Originally, this dummy declaration was needed because there was the possibility of the generated code doesn't use context.Context and then if it imported that package, go compiler complains that and makes an error.

ref:

func (a *{{{classname}}}Service) {{{nickname}}}({{#hasAuthMethods}}ctx context.Context, {{/hasAuthMethods}}{{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{#hasMore}}, {{/hasMore}}{{/required}}{{/allParams}}{{#hasOptionalParams}}localVarOptionals map[string]interface{}{{/hasOptionalParams}}) ({{#returnType}}{{{returnType}}}, {{/returnType}} *http.Response, error) {

However, now this dummy placement is no longer needed because the generated code always uses context.Context.
So this pull request removes that dummy declaration.

cc. @antihax @grokify @kemokemo @jirikuncar @ph4r5h4d

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.

…go code

Originally, this dummy declaration was needed because there was the
possibility of the generated code doesn't use `context.Context` and then
if it imported that package, go compiler complains that and makes an error.
ref: https://github.com/OpenAPITools/openapi-generator/blob/3ed1aa8e79687bed63dfa064de27317273080471/modules/swagger-codegen/src/main/resources/go/api.mustache#L30

However, now this dummy placement is no longer needed because the
generated code always uses `context.Context`.

Signed-off-by: moznion <[email protected]>
@wing328 wing328 added Client: Go Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc. labels Feb 18, 2022
@wing328 wing328 added this to the 6.0.0 milestone Feb 18, 2022
@wing328
Copy link
Copy Markdown
Member

wing328 commented Feb 18, 2022

LGTM

@wing328 wing328 merged commit d6a97b0 into OpenAPITools:master Feb 18, 2022
@moznion moznion deleted the remove_context_dummy_var_decl branch February 18, 2022 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Client: Go Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants