umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 20:30:23 +00:00
Code Issues Wiki Activity

Document media type wildcard in content_types_accepted

Browse source
This commit is contained in:
Loïc Hoguin 2019-10-03 16:20:29 +02:00
parent 1ba48c58b1
commit 28aee1f272
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
4 changed files with 26 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/src/manual/cowboy_rest.asciidoc
View file

@ -184,7 +184,7 @@ content-type header of the response if the media type is text.
----
content_types_accepted(Req, State) -> {Result, Req, State}
Result :: [{binary() | ParsedMime, AcceptCallback :: atom()}]
Result :: [{'*' | binary() | ParsedMime, AcceptCallback :: atom()}]
ParsedMime :: {Type :: binary(), SubType :: binary(), '*' | Params}
Params :: [{Key :: binary(), Value :: binary()}]
@ -200,6 +200,8 @@ A media type is made of different parts. The media type
`text/html;charset=utf-8` is of type `text`, subtype `html`
and has a single parameter `charset` with value `utf-8`.
The special value `'*'` can be used to accept any media type.
// @todo Cowboy needs to ignore the boundary parameter for
// multipart, as we never want to match against it. Or allow
// ignoring specific parameters at the very least.
@ -724,6 +726,8 @@ listed here, like the authorization header.
== Changelog
* *2.7*: The media type wildcard in `content_types_accepted`
is now documented.
* *2.6*: The callback `rate_limited` was added.
* *2.1*: The `switch_handler` return value was added.
* *1.0*: Behavior introduced.