Update action format docs for new 2.3 API #306
Conversation
This file contains hidden or 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
This was accidentally changed in a mass find/replace of “2.2” to “2.3” when we created the 2.3 guides.
katafrakt
reviewed
Nov 12, 2025
| module Books | ||
| class Index < Bookshelf::Action | ||
| config.default_charset "koi8-r" | ||
| config.default_charset = koi8-r" |
Contributor
There was a problem hiding this comment.
Suggested change
| config.default_charset = koi8-r" | |
| config.default_charset = "koi8-r" |
missing quote
Comment on lines
+38
to
+39
| You can also accept formats on any individual action class. `config.formats` in an action class is | ||
| analogous to `config.actions.formats` in your app class. |
Contributor
There was a problem hiding this comment.
Just a random thought, but maybe "works the same way as" is more precise than "is analogous to", which suggests similarity with differences (at least to this non-native English speaker)
| ## Request acceptance | ||
|
|
||
| Once you've configured a format, your actions will reject certain requests that do not match the format. | ||
| Once your actions accept a format, they will reject requests that do not match the format. |
Contributor
There was a problem hiding this comment.
Not exactly related to this PR, but maybe it's worth to write a little more what rejection means in this context, i.e. what status will be returned (an which view rendered?)
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.
Update the "Formats and MIME types" docs to use the new config API we're introducing in hanami/hanami-controller#485
Also add the beginnings for a 2.3 upgrade guide, covering the action format changes.