[or-cvs] r11111: Document http status codes (in tor/trunk: . doc/spec)

[nickm at seul.org]

Author: nickm
Date: 2007-08-14 16:20:06 -0400 (Tue, 14 Aug 2007)
New Revision: 11111

Modified:
   tor/trunk/
   tor/trunk/doc/spec/dir-spec.txt
Log:
 r14021 at Kushana:  nickm | 2007-08-14 16:16:58 -0400
 Document http status codes



Property changes on: tor/trunk
___________________________________________________________________
 svk:merge ticket from /tor/trunk [r14021] on c95137ef-5f19-0410-b913-86e773d04f59

Modified: tor/trunk/doc/spec/dir-spec.txt
===================================================================
--- tor/trunk/doc/spec/dir-spec.txt	2007-08-14 20:19:58 UTC (rev 11110)
+++ tor/trunk/doc/spec/dir-spec.txt	2007-08-14 20:20:06 UTC (rev 11111)
@@ -1505,8 +1505,30 @@
 
 7.2. HTTP status codes
 
-  XXX We should write down what return codes dirservers send in what situations.
+  Tor delivers the following status codes.  Some were chosen without much
+  thought; other code SHOULD NOT rely on specific status codes yet.
 
+  200 -- the operation completed successfully
+      -- the user requested statuses or serverdescs, and none of the ones we
+         requested were found (0.2.0.4-alpha and earlier).
+
+  304 -- the client specified an if-modified-since time, and none of the
+         requested resources have changed since that time.
+
+  400 -- the request is malformed, or
+      -- the URL is for a malformed variation of one of the URLs we support,
+          or
+      -- the client tried to post to a non-authority, or
+      -- the authority rejected a malformed posted document, or
+
+  404 -- the requested document was not found.
+      -- the user requested statuses or serverdescs, and none of the ones we
+         requested were found (0.2.0.5-alpha and later).
+
+  503 -- we are declining the request in order to save bandwidth
+      -- user requested some items that we ordinarily generate or store,
+         but we do not have any available.
+
 9. Backward compatibility and migration plans
 
   Until Tor versions before 0.1.1.x are completely obsolete, directory