Update token exchange and secret rotation documentation #1902
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
paulomarg
approved these changes
Aug 27, 2024
README.md
Outdated
| you'll need to create and configure a custom PostAuthenticateTasks class to run these tasks after the token exchange. The original | ||
| OAuth CallbackController will not be triggered anymore. See [Post Authenticate Tasks documentation](/docs/shopify_app/authentication.md#post-authenticate-tasks) for more information. | ||
| 4. Enjoy a smoother and faster app installation process. | ||
| 4. Make sure your `embedded_app` layout is correct. If your app has any Controllers which include `ShopifyApp::EnsureInstalled`, they will now also include `ShopifyApp::EmbeddedApp` concern. See [this concern's documentation](/docs/shopify_app/controller-concerns.md#embeddedapp) for more information. |
There was a problem hiding this comment.
Nit: should we call out what the effects of having it would be in this case? Or do we do that in the docs?
There was a problem hiding this comment.
The docs around EmbeddedApp detail everything it does, but I'll explicitly add that the layout file the controller will look for will change 👍
rachel-carvalho
force-pushed
the
update_docs
branch
from
72d1cca to
763e2c9
Compare
rachel-carvalho
force-pushed
the
update_docs
branch
from
763e2c9 to
a37bb9b
Compare
paulomarg
approved these changes
Aug 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
This PR adds information to the Token Exchange section of the documentation about changes that turning on
new_embedded_auth_strategywill have on theShopifyApp::EnsureInstalledconcern.It also adds a new block about correctly setting up
ShopifyAPI::Contextwhen performing secret rotation.Things to focus on
Are the additions in the best part of the documentation? Any suggestions to wording?
Checklist
Before submitting the PR, please consider if any of the following are needed:
CHANGELOG.mdif the changes would impact usersREADME.md, if appropriate./docs, if necessarycloses https://github.com/Shopify/develop-app-runtime-primitives/issues/468
part of https://github.com/Shopify/develop-app-runtime-primitives/issues/467