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

[rust][client][auth] token source option #19647

Conversation

nicolas-vivot
Copy link
Contributor

@nicolas-vivot nicolas-vivot commented Sep 23, 2024

This PR includes changes to improve the integration with token source / token source provider for the authentication part.
It addresses the following feature request.

The changes includes:

  • the addition of a new option supportTokenSource
  • the use of google-cloud-token as it already provides simple trait definition for TokenSource
  • the new option replace any other similar auth configuration (ApiToken, OAuth, Bearer, Basic) since it does not make sense to have all together. (please let me know if this assumption is incorrect)

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.x.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.

@nicolas-vivot nicolas-vivot changed the title [rust][client] Auth token source support [rust][client][auth] token source option Sep 23, 2024
@nicolas-vivot
Copy link
Contributor Author

cc committee: @frol @farcaller @richardwhiuk @paladinzh @jacob-pro

@nicolas-vivot nicolas-vivot marked this pull request as ready for review September 23, 2024 07:57
Comment on lines +18 to +19
# TODO: propose to Yoshidan to externalize this as non google related crate, so that it can easily be extended for other cloud providers.
google-cloud-token = "^0.1"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now i think it's fine to depends on this crate. It is lightweight and have just a few trait definition, including the one we are interested in: TokenSource.
I plan to ask the actual maintainer of this crate to make it vendor agnostic with a new create and then depends on it.
That way, people will be free to use google-cloud-auth with the TokenProvider they need, or another cloud vendor if such crate is made / integrate with the same definition in the future.

@wing328 wing328 added this to the 7.9.0 milestone Sep 26, 2024
@wing328
Copy link
Member

wing328 commented Oct 1, 2024

thanks for the PR. let's give it a try

@wing328 wing328 merged commit 8ef3118 into OpenAPITools:master Oct 1, 2024
19 checks passed
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