I found PaceErrorReports[1], but it's been withdrawn. This
PaseReturnEntryInErrorResponse does not introduce new format in
contrast to PaceErrorReports.
[1]http://www.intertwingly.net/wiki/pie/PaceErrorReports

PaseReturnEntryInErrorResponse uses the Atom Entry Document,
as Eric suggested.[2]
[2]http://www.imc.org/atom-protocol/mail-archive/msg05017.html

Please be gentle, this is going to be my first Pace. And English is
not my primary language. thus, the Pace is mostly made out of
Copy&Paste form here and there;-).

suggestions, objections, corrections are all welcome.


PaseReturnEntryInErrorResponse

== Abstract ==
 Use the Atom Entry Document to express human readable descriptions
 of failure conditions.

== Status ==
 New

== Rationale ==
 When the server generates a response with a status code of 4xx or 5xx,
 it is useful if the server returns an explanation of the rejection
 or the error in a human readable fashion.

== Proposal ==

In Section 8

Add:

 When the server generates a response with a status code of 4xx or
 5xx, it MAY also return a response body, which, if provided, SHOULD
 be an Atom Entry Document representing the error and/or the error
 reason.

Example

HTTP/1.x 500 Internal Server Error
Content-Type: application/atom+xml

<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom"; xml:lang="en">
  <title>Internal Server Error</title>
  <summary>couldn&apos;t connect to the DB server.</summary>
  <content type="html">[long winded explanation or trace log]</content>
  <link type="text/html" rel="alternate" href="http://example.org/FooPu
     blish/Docs/Errors/283.html"/>
  <category scheme="http://w3c.org/http/errors/";
      term="500" label="Internal Server Error" />
  <category scheme="http://example.com/FooPublish/";
      term="error-283" label="DB connect failed" />
  <generator uri="http://www.example.com/FooPublisher";
      version="1.0">Foo Publisher 1.0</generator>
  <author><name>Foo Publisher</name></author>
  <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
  <updated>2003-12-13T18:30:02Z</updated>
</entry>


== Impact ==

Reply via email to