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

Fix #16362 #18808

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fix #16362 #18808

wants to merge 4 commits into from

Conversation

spraot
Copy link
Contributor

@spraot spraot commented May 31, 2024

Build URL again after applying auths so that any necessary query params are added there.

Potentially still issues if there is an auth that changes the query parameters and an auth that hashes the query params and those are run in the wrong order. But those cases are unlikely (two types of auths?) and broken anyways with existing code.

Fix #16362

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.
    @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

@spraot
Copy link
Contributor Author

spraot commented Jun 3, 2024

Is there an issue with sample generation? I ran the script, but it looks like there are white space changes still.

@martin-mfg
Copy link
Contributor

Hi @spraot,
thanks for the PR!
Could you please add a corresponding unit test to your PR?

Is there an issue with sample generation? I ran the script, but it looks like there are white space changes still.

It seems you first updated the samples, and afterwards made additional whitespace changes. So you would need to update the samples files again to fix the problem. But actually I would rather recommend to revert the whitespace changes from the last commit, as they look unnecessary to me.

@spraot
Copy link
Contributor Author

spraot commented Aug 7, 2024

Actually it was the other way around, I generated the samples, then reverted the whitespace changes. It should be resolved now.

@spraot
Copy link
Contributor Author

spraot commented Aug 7, 2024

@martin-mfg Can you give some guidance on making a unit test? I'm starting with the following, but I'm getting a ton of failed tests even without that change, so I'm not able to make any more progress.

    @Test
    public void demoTest() throws ApiException {
        String color = "red";
        api.getApiClient().setApiKey("abcdef");
        api.demo(color);
    }

@martin-mfg
Copy link
Contributor

Hi @spraot, after looking into this some more, I agree that writing a unit test here is not easily possible. So I tested the changes manually instead, and found out that apikey isn't actually being used yet. This is because allQueryParams is being updated, but never used. So I fixed this and created a new PR, #19334, which includes your changes and my changes. Since your original commits are included in the new PR, it should still count as contribution on your GitHub profile. :)

If #19334 gets merged, this PR here can be closed.

@spraot
Copy link
Contributor Author

spraot commented Aug 14, 2024

Thanks @martin-mfg !

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.

[BUG] APIkey as query parameter is not passed in Java client
3 participants