From 868166f699ba58db97d8088818528d635205ed78 Mon Sep 17 00:00:00 2001
From: Jakob Voss <jakob@nichtich.de>
Date: Mon, 28 May 2012 09:20:39 +0200
Subject: [PATCH] more on error codes

---
 Makefile       |  3 ++-
 paia.md        | 67 ++++++++++++++++++++++++++++++++++++++++++++++----
 references.bib |  8 ++++++
 3 files changed, 72 insertions(+), 6 deletions(-)

diff --git a/Makefile b/Makefile
index 54e297b..6d0a72e 100644
--- a/Makefile
+++ b/Makefile
@@ -12,7 +12,8 @@ paia.html: paia.md template.html5 references.bib
 revision: paia.html
 	cp paia.html paia-${REVSHRT}.html
 
-website: revision
+website: clean revision
+	# TODO: "git status -s 2> /dev/null" check whether working directory is clean
 	git checkout gh-pages
 	echo '<meta HTTP-EQUIV="REFRESH" content="0; url=paia-${REVSHRT}.html">' > paia.html
 	git add paia.html paia-${REVSHRT}.html
diff --git a/paia.md b/paia.md
index 08f3397..95851c1 100644
--- a/paia.md
+++ b/paia.md
@@ -129,15 +129,70 @@ either as request parameter in the request body (HTTP POST) or as request header
 
 ## Error response
 
-...
+There are two types of errors:
+
+Request errors
+  : Malformed requests, failed authentification, unsupported methods, and
+    unexpected server errors such as backend downtime etc. MUST result in an 
+	error response. An error response is returned with a HTTP status code 
+	4xx (client error) or 5xx (server error) as defined in [@RFC2616], unless
+    the request parameter `suppress_response_codes` is given.
+Document errors
+  : Unknown document URIs and failed attempts to request, renew, or cancel 
+    a document do not result in an error response, unless there is another
+	request error. Document errors are indicated by setting the `doc.error`
+	response field.
+
+
+An error response is a JSON object with the following fields, compatible
+with OAuth error responses:
+
+------------------- ------ --------------------- -----------------------------------------
+ error               1..1   string                alphanumerical error code
+ code                0..1   nonnegative integer   HTTP status error code
+ error_description   0..1   string                Human-readable error description
+ error_uri           0..1   string                Human-readable web page about the error
+------------------- ------ --------------------- -----------------------------------------
+
+The `code` field is REQUIRED with request parameter `suppress_response_codes`. 
+It SHOULD be omitted with PAIA auth requests to not confuse OAuth clients.
+
+This is a preliminary, incomplete list of errors and error codes:
+
+------ ----------------------- -----------------------------
+ code  error
+------ ----------------------- -----------------------------
+ 400    invalid_request
+
+ 401    invalid_client
+ 
+ 401    invalid_grant
+ 
+ 404    not_found                Unknown method or base URL
+ 
+ 500    internal_server_error
+ 
+ 502    bad_gateway
+ 
+ 503    service_unavailable
 
+ 504    gateway_timeout
+------ ----------------------- ------------------------------
 
-## Special request parameters
+NOTE: See <https://dev.twitter.com/docs/error-codes-responses> (TODO)
 
-* callback
-* suppress_response_codes
+## Special request parameters
 
+The following special request parameters can be added to any request:
 
+callback
+  : A JavaScript callback method name to return JSONP instead of JSON. The
+    callback SHOULD only contain alphanumeric characters and underscores; 
+	any invalid characters MUST be stripped by a PAIA server. If callback
+	is given, the response content type MUST be `application/javascript`.
+suppress_response_codes
+  : If this parameter is present, *all* responses MUST be returned with a 
+    200 OK status code, even [error responses](#error-response).
 
 ## Data types
 
@@ -452,7 +507,9 @@ The server MUST check
 * whether the user identified by username is allowed to 
   change the given patrond’s password
 
-A PAIA server MAY reject this method (TODO: document error response).
+A PAIA server MAY reject this method and return an [error
+response](#error-response) with error code 403 (forbidden) or error code 501
+(not implemented).
 
 
 # Glossary
diff --git a/references.bib b/references.bib
index 18be0ae..19c77a7 100644
--- a/references.bib
+++ b/references.bib
@@ -6,6 +6,14 @@ @techreport{RFC2119
     URL     = "http://tools.ietf.org/html/rfc2119",
     institution = "IETF"
 }
+@techreport{RFC2616,
+	author 	= "R. Fielding",
+	title	= "{RFC 2616}: Hypertext Transfer Protocol",
+	year	= "1999",
+	month	= jun,
+    URL     = "http://tools.ietf.org/html/rfc2616",
+    institution = "IETF"
+}
 @techreport{RFC2818,
     author  = "E. Rescorla",
     title   = "{RFC 2818}: HTTP over TLS",