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

Document credential refreshing behaviour #366

Open
ShaddyDC opened this issue Oct 31, 2023 · 0 comments
Open

Document credential refreshing behaviour #366

ShaddyDC opened this issue Oct 31, 2023 · 0 comments
Assignees

Comments

@ShaddyDC
Copy link

Is your feature request related to a problem? Please describe.
When using this library and playing around with the credentials, I noticed the expiration field on the Credentials struct. Together with the public refresh function and no further documentation, I figured that was something I'd have to take care of myself. Only when checking the issues here again just to be sure did I find #163 and saw that it's being done automatically.

Describe the solution you'd like
Just a simple note on Bucket::credentials_refresh, Credentials::refresh or Credentials::expiration that the refresh is being done automatically and needs not be considered by the user excepting special circumstances.

Describe alternatives you've considered

  • Mention automatic credential renewals as a feature in the readme
  • Make the refresh methods and expiration private
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants