Extensions in OpenStack Identity API v2.0 Reference - API v2.0 and extensions

[Brant Knudson]

Throughout the book "OpenStack Identity API v2.0 Reference - API v2.0 and extensions", the error response codes are listed like

  Error response code(s): badRequest (400), identityFault (500), serviceUnavailable(503)

I have a couple of issues with this.

First, the way that response codes are described is nonstandard. The HTTP 1.1 standard lists the response codes and reason phrase, and HTTP servers respond with the code and phrase, like "400 Bad Request" and "503 Service Unavailable", not like "badRequest (400)" or "serviceUnavailable(503)". So "badRequest (400)" should be "400 Bad Request", "serviceUnavailable(503)" should be "503 Service Unavailable", and so forth.

Second, while "400 Bad Request" and "503 Service Unavailable" are actual HTTP response codes, 500 is actually "500 Internal Server Error" and not "500 Identity Fault". So "identityFault (500)" should be "500 Internal Server Error".

-----------------------------------
Built: 2014-07-05T14:25:04 00:00
git SHA: d92c5799553bee3fa2327a2233bff7578a760104
URL: http://docs.openstack.org/api/openstack-identity-service/2.0/content/Extensions-d1e688.html
source File: file:/home/jenkins/workspace/identity-api-tox-doc-publishdocs/v2.0/src/ch_identity-general-api-info.xml
xml:id: Extensions-d1e688

[Anne Gentle (annegentle)]

We discussed this at length on the review patch at https://review.openstack.org/#/c/106173/ which addresses the issue. I'll mark In Progress.