Skip to content

Add support for ApiKey auth to rust-server#22950

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
dsteeley:rust-server-client-ApiKey
Feb 12, 2026
Merged

Add support for ApiKey auth to rust-server#22950
wing328 merged 1 commit intoOpenAPITools:masterfrom
dsteeley:rust-server-client-ApiKey

Conversation

@dsteeley
Copy link
Contributor

@dsteeley dsteeley commented Feb 12, 2026

Add ApiKey auth support to rust-server. This adds support to the client side and fixes the broken server side ApiKey support.

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Add ApiKey authentication to the rust-server and its generated client. The CLI can pass an API key, the client sends it in the header, and the server now reads it correctly.

  • New Features

    • CLI support: --api-key and ENV VAR <CRATE_NAME>_API_KEY.
    • Client adds the ApiKey as a header using the security scheme’s keyParamName.
  • Bug Fixes

    • Server extracts the ApiKey from request headers using the security scheme’s keyParamName (lowercased), restoring header-based ApiKey auth.
    • Removed reliance on a vendor extension for the header name.

Written for commit ff7f5d1. Summary will update on new commits.

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 7 files

@wing328 wing328 merged commit a53ebb3 into OpenAPITools:master Feb 12, 2026
19 checks passed
@wing328 wing328 added this to the 7.20.0 milestone Feb 12, 2026
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