diff --git a/libpathod/templates/docs_lang.html b/libpathod/templates/docs_lang.html index e67b13c56..ac3f85822 100644 --- a/libpathod/templates/docs_lang.html +++ b/libpathod/templates/docs_lang.html @@ -9,19 +9,31 @@
The general form of a response is as follows:
+code:[colon-separated list of features]
code | +
+ An integer specifying the HTTP response code. + +The special method ws creates a valid + websocket upgrade response (code 101), and moves pathod + to websocket mode. Apart from that, websocket responses + are just like any other, and all aspects of the + response can be over-ridden. + |
+ ||||||||||
bVALUE |
@@ -97,8 +109,7 @@
-
- The general form of a request is as follows: +method:path:[colon-separated list of features]@@ -108,10 +119,18 @@ method |
- A VALUE specifying the HTTP
+
+ |
A VALUE specifying the HTTP method to use. Standard methods do not need to be - quoted. The special method ws creates a valid - websocket upgrade request. + enclosed in quotes, while non-standard methods can be + specified as quoted strings. + +The special method ws creates a valid + websocket upgrade GET request, and signals to pathoc to + switch to websocket recieve mode if the server responds + correctly. Apart from that, websocket requests are just + like any other, and all aspects of the request can be + over-ridden.
-
Requests and responses can be decorated with the ws prefix to - create a websockets client or server handshake. Since the websocket - specifier implies a request method (GET) and a response code (102), - these can optionally be omitted. All other request and response - features can be applied, and websocket-specific headers can be - over-ridden explicitly. +wf:[colon-separated list of features]- Request+
ws:put:/- - - Response- -ws[:code:][colon-separated list of features]- - This will generate a simple protocol acceptance with a 101 response - code: - -ws- - This will do the same, but using the (invalid) 202 code: - -ws:202 |