From 51b883ea1849ed186de63d3b76a2b66fe317ff9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 14 Oct 2017 22:17:42 +0200 Subject: Update docs --- docs/en/cowboy/2.0/guide/resource_design.asciidoc | 4 ++-- docs/en/cowboy/2.0/guide/resource_design/index.html | 4 ++-- docs/en/cowboy/2.0/guide/ws_handlers.asciidoc | 15 ++++++++------- docs/en/cowboy/2.0/guide/ws_handlers/index.html | 15 ++++++++------- 4 files changed, 20 insertions(+), 18 deletions(-) (limited to 'docs/en/cowboy') diff --git a/docs/en/cowboy/2.0/guide/resource_design.asciidoc b/docs/en/cowboy/2.0/guide/resource_design.asciidoc index 2325b9f2..fa0c6122 100644 --- a/docs/en/cowboy/2.0/guide/resource_design.asciidoc +++ b/docs/en/cowboy/2.0/guide/resource_design.asciidoc @@ -193,8 +193,8 @@ callback. If you implement the methods PUT, POST and/or PATCH, you must implement the `content_types_accepted` callback, -and one `AcceptResource` callback for each content-type -it returns. Prefix the `AcceptResource` callback names +and one `AcceptCallback` callback for each content-type +it returns. Prefix the `AcceptCallback` callback names with `from_` for clarity. For example, `from_html` or `from_json`. diff --git a/docs/en/cowboy/2.0/guide/resource_design/index.html b/docs/en/cowboy/2.0/guide/resource_design/index.html index 32c8a129..c2331de4 100644 --- a/docs/en/cowboy/2.0/guide/resource_design/index.html +++ b/docs/en/cowboy/2.0/guide/resource_design/index.html @@ -248,8 +248,8 @@ callback.

If you implement the methods PUT, POST and/or PATCH, you must implement the content_types_accepted callback, -and one AcceptResource callback for each content-type -it returns. Prefix the AcceptResource callback names +and one AcceptCallback callback for each content-type +it returns. Prefix the AcceptCallback callback names with from_ for clarity. For example, from_html or from_json.

Do we want to allow the POST method to create individual diff --git a/docs/en/cowboy/2.0/guide/ws_handlers.asciidoc b/docs/en/cowboy/2.0/guide/ws_handlers.asciidoc index 84dfb9bc..a79d7e29 100644 --- a/docs/en/cowboy/2.0/guide/ws_handlers.asciidoc +++ b/docs/en/cowboy/2.0/guide/ws_handlers.asciidoc @@ -57,18 +57,19 @@ be: [source,erlang] ---- -init(Req, State) -> - case cowboy_req:parse_header(<<"sec-websocket-protocol">>, Req) of +init(Req0, State) -> + case cowboy_req:parse_header(<<"sec-websocket-protocol">>, Req0) of undefined -> - {cowboy_websocket, Req, State}; + {cowboy_websocket, Req0, State}; Subprotocols -> case lists:keymember(<<"mqtt">>, 1, Subprotocols) of true -> - Req2 = cowboy_req:set_resp_header(<<"sec-websocket-protocol">>, - <<"mqtt">>, Req), - {cowboy_websocket, Req2, State}; + Req = cowboy_req:set_resp_header(<<"sec-websocket-protocol">>, + <<"mqtt">>, Req0), + {cowboy_websocket, Req, State}; false -> - {stop, Req, State} + Req = cowboy_req:reply(400, Req0), + {ok, Req, State} end end. ---- diff --git a/docs/en/cowboy/2.0/guide/ws_handlers/index.html b/docs/en/cowboy/2.0/guide/ws_handlers/index.html index 334bb049..f17b1093 100644 --- a/docs/en/cowboy/2.0/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.0/guide/ws_handlers/index.html @@ -122,18 +122,19 @@ be:

by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -
init(Req, State) ->
-    case cowboy_req:parse_header(<<"sec-websocket-protocol">>, Req) of
+
init(Req0, State) ->
+    case cowboy_req:parse_header(<<"sec-websocket-protocol">>, Req0) of
         undefined ->
-            {cowboy_websocket, Req, State};
+            {cowboy_websocket, Req0, State};
         Subprotocols ->
             case lists:keymember(<<"mqtt">>, 1, Subprotocols) of
                 true ->
-                    Req2 = cowboy_req:set_resp_header(<<"sec-websocket-protocol">>,
-                        <<"mqtt">>, Req),
-                    {cowboy_websocket, Req2, State};
+                    Req = cowboy_req:set_resp_header(<<"sec-websocket-protocol">>,
+                        <<"mqtt">>, Req0),
+                    {cowboy_websocket, Req, State};
                 false ->
-                    {stop, Req, State}
+                    Req = cowboy_req:reply(400, Req0),
+                    {ok, Req, State}
             end
     end.
-- cgit v1.2.3