From 05f5e772c3f59c9be40132eb7afd4f049ced140a Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@nullcube.com>
Date: Sun, 24 Jun 2012 16:47:44 +1200
Subject: Document our use of the 800 response code.

---
 doc-src/pathod.html | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

(limited to 'doc-src')

diff --git a/doc-src/pathod.html b/doc-src/pathod.html
index 31fd0bbe..b73918a1 100644
--- a/doc-src/pathod.html
+++ b/doc-src/pathod.html
@@ -30,7 +30,9 @@ various other goodies. Try it by visiting the server root:
 
 
 
-# Specifying Responses
+<div class="page-header">
+   <h1>Specifying Responses</h1>
+</div>
 
 The general form of a response is as follows:
     
@@ -284,7 +286,9 @@ Supported data types are:
 - bytes
 
 
-# API
+<div class="page-header">
+   <h1>API</h1>
+</div>
 
 __pathod__ exposes a simple API, intended to make it possible to drive and
 inspect the daemon remotely for use in unit testing and the like. 
@@ -328,3 +332,16 @@ inspect the daemon remotely for use in unit testing and the like.
         </tr>
     </tbody>
 </table>
+
+<div class="page-header">
+   <h1>Error Responses</h1>
+</div>
+
+To let users distinguish crafted responses from internal pathod responses,
+pathod uses the non-standard 800 response code to indicate errors. For example,
+a request to:
+
+    http://localhost:9999/p/foo
+
+... will return an 800 response, because "foo" is not a valid page specifier.
+
-- 
cgit v1.2.3