Documentation to explain request header casing #1887
Conversation
Changelog as per PR comment
|
|
||
| The header name will have been normalized for you. | ||
|
|
||
| - In the `header` helper names will be coerced into a capitalized kebab case. |
There was a problem hiding this comment.
It's that thing where you use '-' between all words so they look like they're on a kebab. https://medium.com/@pddivine/string-case-styles-camel-pascal-snake-and-kebab-case-981407998841
| @@ -1822,6 +1822,22 @@ get do | |||
| end | |||
| ``` | |||
|
|
|||
| The above example may have been requested as follows: | |||
There was a problem hiding this comment.
Let's add a section called Header Case Handling? This way it appears in the TOC and can be linked.
There was a problem hiding this comment.
Adding the section heading awkwardly makes it run into the next section on the response headers and I don't want to imply that this handling applies to responses. So I'll add a Request and Response section title as well to be clear. I hope this is ok.
README.md
Outdated
| - In the `header` helper names will be coerced into a capitalized kebab case. | ||
| - In the `env` collection they appear in all uppercase, in snake case, and prefixed with 'HTTP_'. | ||
|
|
||
| With this normalization you will be able to handle headers in a case-insensitive way as per |
There was a problem hiding this comment.
For an API documentation we don't need to convince people this is a good idea. I would put this in the prefix.
The header name will have been normalized per HTTP standards defined in ... regardless of what is being sent by a client.
(fix HTTP type, 2 Ts)
CHANGELOG.md
Outdated
| @@ -5,6 +5,7 @@ | |||
| * Your contribution here. | |||
| * [#1864](https://github.com/ruby-grape/grape/pull/1864): Adds `finally` on the API - [@myxoh](https://github.com/myxoh). | |||
| * [#1869](https://github.com/ruby-grape/grape/pull/1869): Fix issue with empty headers after `error!` method call - [@anaumov](https://github.com/anaumov). | |||
| * [#1887](https://github.com/ruby-grape/grape/pull/1887): Documentation to explain request header casing - [@carlism](https://github.com/carlism). | |||
There was a problem hiding this comment.
No need for a changelog for this. Ignore the bot.
Here's an example of a CHANGELOG.md entry: * [#1887](https://github.com/ruby-grape/grape/pull/1887): Documentation to explain request header casing - [@carlism](https://github.com/carlism).Generated by 🚫 danger |
|
thank you, merged |
Addresses Issue #1882 Header helper and what it does to case on header names