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

[PowerShell] Support ApiKeyPrefix #19133

Merged
merged 2 commits into from
Jul 11, 2024

Conversation

condorcorde
Copy link
Contributor

This PR contains a small change to support ApiKeyPrefix, i.e. an extra string that may be required in the Authorization: header (or in the URL parameter) before the ApiKey. ApiKeyPrefix is already supported in the Configuration, but never used in the API code. Likely, when required the prefix was added to the key as a workaround.

The prefix string is directly concatenated to the ApiKey. Any space separators that may be required must be added to the ApiKeyPrefix.

The change has been tested on a client API requiring such a prefix in the header.

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.

@wing328

@condorcorde condorcorde changed the title Support ApiKeyPrefix [PowerShell] Support ApiKeyPrefix Jul 10, 2024
@wing328 wing328 added this to the 7.8.0 milestone Jul 11, 2024
@wing328 wing328 merged commit 2940d32 into OpenAPITools:master Jul 11, 2024
15 checks passed
@wing328
Copy link
Member

wing328 commented Jul 11, 2024

lgtm. Thanks for the PR

When you've time, can you please PM me via Slack? Thanks

@condorcorde condorcorde deleted the support-apikeyprefix branch July 12, 2024 20:28
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.

None yet

2 participants