From beaae7bf7036d195bc775372e1d8de90d20d60bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 25 Apr 2013 17:46:40 +0200 Subject: 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. --- guide/rest_handlers.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'guide') diff --git a/guide/rest_handlers.md b/guide/rest_handlers.md index d5997f9..ac11d98 100644 --- a/guide/rest_handlers.md +++ b/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, 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 ----- -- cgit v1.2.3