Browse Source

Document meta values set by REST

You can use these values to perform a reply using the negotiated
content-type and language for non-HEAD/GET methods.
Loïc Hoguin 12 years ago
parent
commit
beaae7bf70
1 changed files with 13 additions and 0 deletions
  1. 13 0
      guide/rest_handlers.md

+ 13 - 0
guide/rest_handlers.md

@@ -106,6 +106,19 @@ each function. For example, `from_html` and `to_html` indicate
 in the first case that we're accepting a resource given as HTML,
 in the first case that we're accepting a resource given as HTML,
 and in the second case that we send one as HTML.
 and in the second case that we send one as HTML.
 
 
+Cowboy will set informative meta values at various points of the
+execution. You can retrieve them using `cowboy_req:meta/{2,3}`.
+The values are defined in the following table.
+
+| Meta key   | Details                                              |
+| -----------| ---------------------------------------------------- |
+| media_type | The content-type negotiated for the response entity. |
+| language   | The language negotiated for the response entity.     |
+| charset    | The charset negotiated for the response entity.      |
+
+They can be used to reply a response entity to a request with
+an idempotent method (`POST`, `PUT`, `PATCH`, `DELETE`).
+
 Usage
 Usage
 -----
 -----