Better support API-only Rails applications #1128
Merged
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
Co-authored-by: Adrianna Chang <[email protected]>
nvasilevski
approved these changes
Nov 29, 2024
adrianna-chang-shopify
approved these changes
Nov 29, 2024
README.md
Outdated
| ### Using Maintenance Tasks in API-only applications | ||
|
|
||
| The Maintenance Tasks engine uses Rails sessions for flash messages and storing | ||
| the CRSF token. For the engine to work in an API-only Rails application, you need |
There was a problem hiding this comment.
Suggested change
| the CRSF token. For the engine to work in an API-only Rails application, you need | |
| the CSRF token. For the engine to work in an API-only Rails application, you need |
README.md
Outdated
|
|
||
| The Maintenance Tasks engine uses Rails sessions for flash messages and storing | ||
| the CRSF token. For the engine to work in an API-only Rails application, you need | ||
| to add a [session middleware][] and the Flash middleware. The engine also defines |
There was a problem hiding this comment.
Maybe let's call out the Flash middleware more explicitly?
Suggested change
| to add a [session middleware][] and the Flash middleware. The engine also defines | |
| to add a [session middleware][] and the `ActionDispatch::Flash` middleware. The engine also defines |
README.md
Outdated
Comment on lines
903
to
905
| a strict [Content Security Policy][], but it won't make it to the user's browser | ||
| unless you also include the appropriate middleware | ||
| (`ActionDispatch::ContentSecurityPolicy::Middleware`). |
There was a problem hiding this comment.
Tiny nit: can we make the wording on this more action-oriented?
Suggested change
| a strict [Content Security Policy][], but it won't make it to the user's browser | |
| unless you also include the appropriate middleware | |
| (`ActionDispatch::ContentSecurityPolicy::Middleware`). | |
| a strict [Content Security Policy][]. Make sure to include `ActionDispatch::ContentSecurityPolicy::Middleware` | |
| in your app's middleware stack to ensure the CSP is delivered to the user's browser. |
Co-authored-by: Adrianna Chang <[email protected]>
etiennebarrie
force-pushed
the
api-only
branch
from
47b379f to
49fa2b7
Compare
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.
Fix #992
While we can't automatically get full compatibility with API-only applications, we can make it easier by not using
PUTand documenting how to add the missing middleware necessary for our engine.