Project

General

Profile

Bug #1240

Exception handling docs not clear about use of http Status codes

Added by Rob Nahf almost 14 years ago. Updated almost 14 years ago.

Status:
Closed
Priority:
High
Assignee:
Category:
Documentation
Target version:
Start date:
2011-01-18
Due date:
% Done:

100%

Milestone:
Product Version:
*
Story Points:
Sprint:

Description

A couple items on the exception handling page seem to be problematic:
http://mule1.dataone.org/ArchitectureDocs-current/apis/Exceptions.html

  1. In the HTTP Error Handling Codes table, the "<100 error" category is redundant with 500 errors, and should be removed. We currently use the detailCode to describe and pinpoint local errors. (we also set HTTP status codes for problems outside the transmission protocol.)

  2. Under the general section, the last paragraph is vague, especially with regard to the value of HTTP status. Because it is highly advantageous for the clients to rely on the HTTP status to determine what is in the response stream (especially java, to avoid buffering large files), the request is to assert in the documentation a guarantee that if a d1 error is returned, the HTTP status matches the value of the errorCode attribute.

History

#1 Updated by Dave Vieglais almost 14 years ago

  • Status changed from New to Closed

Closed @3042

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)