-
Notifications
You must be signed in to change notification settings - Fork 399
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
Add token rotation section to docs #1009
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1009 +/- ##
=======================================
Coverage 66.41% 66.41%
=======================================
Files 13 13
Lines 1212 1212
Branches 357 357
=======================================
Hits 805 805
Misses 338 338
Partials 69 69 Continue to review full report at Codecov.
|
Once the copy/content is agreed upon, need to introduce it into the Japanese docs, as well. |
Looks great! It would be nice to point out the minimum version of bolt that ships with token rotation support. |
docs/_advanced/token_rotation.md
Outdated
|
||
Instead of an access token representing an existing installation of your Slack app indefinitely, with token rotation enabled, access tokens expire. A refresh token acts as a long-lived way to refresh your access tokens. | ||
|
||
Bolt for JavaScript supports token rotation automatically once enabled in your app's configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As one of the prerequisites on the Bolt app side, we can mention the necessity to use @slack/oauth
package's default authorize
function along with InstallationStore
. This sounds obvious to us but it's not the same particularly for the developers who are new to Bolt.
Also, we may want to update the OAuth package's document as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left one more comment on the link but this looks almost ready
docs/_advanced/token_rotation.md
Outdated
|
||
Instead of an access token representing an existing installation of your Slack app indefinitely, with token rotation enabled, access tokens expire. A refresh token acts as a long-lived way to refresh your access tokens. | ||
|
||
Bolt for JavaScript supports and will handle token rotation automatically so long as the [built-in OAuth](https://slack.dev/node-slack-sdk/oauth) functionality is used. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Directly linking to the underlying OAuth package may confuse readers. How about navigating to bolt-js's OAuth document instead?
Bolt for JavaScript supports and will handle token rotation automatically so long as the [built-in OAuth](https://slack.dev/node-slack-sdk/oauth) functionality is used. | |
Bolt for JavaScript supports and will handle token rotation automatically so long as the [built-in OAuth](https://slack.dev/bolt-js/concepts#authenticating-oauth) functionality is used. |
Co-authored-by: Steve Gill <stevengill97@gmail.com>
Forgot to mention this: For the Japanese translation work, can you create a “good first issue” like this? #994 I can work on it but am also happy to have the contributions from the community! |
Summary
Add section to documentation that outlines token rotation and links out to corresponding spec + API documentation.
Requirements (place an
x
in each[ ]
)