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

[Go] properly set header parameters on api clients #14637

Merged
merged 3 commits into from
Feb 7, 2023

Conversation

wing328
Copy link
Member

@wing328 wing328 commented Feb 7, 2023

Based on #14586

Context

This PR addresses #14578. Request headers were being improperly added as query params for Go clients. This PR:

  1. Updates the name of the function parameterAddToQuery (added in [Go] report correctly the parameters with the deep object specification #13909) to parameterAddToHeaderOrQuery to indicate that a header or query interface arg can be passed
  2. Correctly passes localVarHeaderParams (instead of localVarQueryParams) to the above function for header params
  3. Regenerates Go samples based on the above. Note that there are some automatic formatting/indentation changes to the samples - I can update those if necessary.

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.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date.sh
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.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.

cc @antihax (2017/11) @grokify (2018/07) @kemokemo (2018/09) @jirikuncar (2021/01) @ph4r5h4d (2021/04)

@wing328
Copy link
Member Author

wing328 commented Feb 7, 2023

Tested locally and the result is good

21:41:58.036932 IP localhost.58054 > localhost.http: Flags [P.], seq 10037:10230, ack 6855, win 6272, options [nop,nop,TS val 3285172852 ecr 842741402], length 193: HTTP: GET /v2/pet/12830 HTTP/1.1
E.....@[email protected].............
...t2;6.GET /v2/pet/12830 HTTP/1.1
Host: petstore.swagger.io:80
User-Agent: OpenAPI-Generator/1.0.0/go
Accept: application/json
Testheader: testvalue
test_header: ZZZZZZ
Accept-Encoding: gzip

@wing328 wing328 marked this pull request as ready for review February 7, 2023 13:43
@wing328 wing328 added this to the 6.4.0 milestone Feb 7, 2023
@wing328 wing328 merged commit cda3517 into master Feb 7, 2023
@wing328 wing328 deleted the sokolikp-sokolik/go-template-fix branch February 7, 2023 13:45
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