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

Adding documentation for handleInstallPath, beforeRedirection, beforeInstallation, afterInstallation #1448

Merged
merged 5 commits into from Mar 25, 2022

Conversation

filmaj
Copy link
Contributor

@filmaj filmaj commented Mar 15, 2022

Also updated the oauth package reference documentation (that was pretty out of date)!

Summary

Describe the goal of this PR. Mention any related Issue numbers.

Requirements (place an x in each [ ])

…llPath`), as well as new before/after callbacks (`beforeRedirection`, `beforeInstallation`, `afterInstallation`). Updated the oauth package reference documentation.
@filmaj filmaj added docs M-T: Documentation work only pkg:oauth applies to `@slack/oauth-helper` labels Mar 15, 2022
@filmaj filmaj added this to the oauth@2.5.0 milestone Mar 15, 2022
Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

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

@filmaj Thanks for updating the docs! Left a few comments on the changes.

docs/_packages/oauth.md Outdated Show resolved Hide resolved
docs/_packages/oauth.md Outdated Show resolved Hide resolved
docs/_packages/oauth.md Show resolved Hide resolved
docs/_packages/oauth.md Outdated Show resolved Hide resolved
docs/_reference/oauth.md Outdated Show resolved Hide resolved
docs/_reference/oauth.md Outdated Show resolved Hide resolved
Co-authored-by: Kazuhiro Sera <seratch@gmail.com>
@seratch
Copy link
Member

seratch commented Mar 15, 2022

@filmaj I forgot to mention this in the review comment but we may want to add a new section in https://slack.dev/node-slack-sdk/oauth, which explains how to set custom cookies to the installer browser in beforeRedirection function and then utilize them in beforeInstallation to verify the eligibility of installation etc. before performing oauth.v2.access API method.

@filmaj
Copy link
Contributor Author

filmaj commented Mar 15, 2022

@seratch good idea, will try to add that

@filmaj filmaj requested a review from seratch March 16, 2022 00:57
@filmaj
Copy link
Contributor Author

filmaj commented Mar 16, 2022

@seratch I have added a new section "Persisting data during the OAuth flow" where I hope I was able to depict the example of reading and writing from cookies and using the new callbacks. What do you think?

Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

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

Looks great to me. Once we release @slack/oauth@2.5.0, we can merge this document updates.

@seratch seratch merged commit 8b6d380 into main Mar 25, 2022
@seratch seratch deleted the oauth-v2.5-docs branch March 25, 2022 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only pkg:oauth applies to `@slack/oauth-helper`
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants