Improve OAuth documentation #1315
Conversation
Added details about when storeInstallation and fetchInstallation execute in Bolt * Added detail about the install path: if your app was hosted at `www.example.com`, you would be able to install your app at `www.example.com/slack/install` * Added details about OAuth process: first you must click on add to slack, then allow, then open Slack, and only then will fetch/storeInstallation will execute * Added sample `installation` object (useful for folks working on DB schemas before the fetch/storeInstallation runs * Added sample `installQuery` object
Codecov Report
@@ Coverage Diff @@
## main #1315 +/- ##
=======================================
Coverage 72.88% 72.88%
=======================================
Files 17 17
Lines 1479 1479
Branches 442 442
=======================================
Hits 1078 1078
Misses 311 311
Partials 90 90 Continue to review full report at Codecov.
|
|
Thanks @horeaporutiu! FYI for some reason Github won't link the PR to close unless you add Fix #[issuenumber] in your PR description body vs in your PR header. I've gone ahead and updated it so that it's properly linked. Taking a look now! |
Co-authored-by: Sarah Jiang <srajiang@gmail.com>
|
Thanks for the suggestions @srajiang !! I've committed those. Yes, once quick double check would be amazing. Thanks! |
|
Btw - I've just added one last sentence in there about the Redirect URI / opening slack. I think this sentence is critical for understanding the full process. |
add installerOptions.directInstall:true details Co-authored-by: Kazuhiro Sera <seratch@gmail.com>
|
LGTM! We can merge this PR tomorrow in Pacific Time (if there is no further feedback) 👍 |
|
@seratch I added some sample code showing installOptions:true. We can remove it if you think it is too verbose. Let me know :) |
| stateSecret: 'my-state-secret', | ||
| scopes: ['chat:write'], | ||
| installerOptions: { | ||
| directInstall: true, |
There was a problem hiding this comment.
@horeaporutiu Nice! but this option is optional while the rest are required. Can you add some code comment indicating that?
There was a problem hiding this comment.
@seratch Comment has been added! Thanks for the suggestion!
There was a problem hiding this comment.
Alrighty, thanks for patience as I reviewed the InstallProvider. Looks like fetchInstallation and storeInstallation are run anytime authorize() method is run, and that would happen when the receiver processes events from Slack, so I have added a suggestion to make that clearer. Feel free to reword if you think the meaning can be clearer.
adding suggestions from Sarah Co-authored-by: Sarah Jiang <srajiang@gmail.com>
Fixes #1306
Added details about when storeInstallation and fetchInstallation execute in Bolt
www.example.com, you would be able to install your app atwww.example.com/slack/installinstallationobject (useful for folks working on DB schemas before the fetch/storeInstallation runsinstallQueryobjectSummary
Describe the goal of this PR. Mention any related Issue numbers.
Requirements (place an
xin each[ ])