Identity API v3 nonstandard response code format

[Brant Knudson]

This is similar to bugs 1338123 and 1338124 which I opened against the "Identity API v2.0 Reference", but this one is against the "Identity API v3" api-ref (http://developer.openstack.org/api-ref-identity-v3.html)

The error response codes are listed like this: "identityFault (400, 500, …), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413), serviceUnavailable (503), itemNotFound (404)"

There are a few 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, this one has "identityFault (400, 500, …)". This is not useful because it seems to indicate that any response code is identityFault. "identityFault (400, 500, …)" should be removed from "Error response codes".

The text seems to indicate that 405 is "Bad Method", but HTTP 1.1 defines it as "405 Method Not Allowed" -- http://tools.ietf.org/html/rfc2616#section-10.4.6

Similar for 404. HTTP 1.1 defines the phrase for this as "Not Found" and not "Item Not Found" -- http://tools.ietf.org/html/rfc2616#section-10.4.5

Similar for 413. "overLimit (413)" should be "414 Request-URI Too Long" http://tools.ietf.org/html/rfc2616#section-10.4.14

[Brant Knudson (blk-u)]

This is interesting... this page has response codes as I'd expect to see them: http://docs.openstack.org/api/openstack-network/2.0/content/update_extra_route.html

[Brant Knudson (blk-u)]

it looks like http://docs.openstack.org/api/openstack-network/2.0/content/update_extra_route.html uses a hardcoded docbook string rather than wadl change.

[Anne Gentle (annegentle)]

Will also be addressed with https://review.openstack.org/#/c/106173/ as per my request on that patch.

[Anne Gentle (annegentle)]

Related to the comments #1 and #2 we have this bug logged against the toolchain for outputting different output despite using the same source WADL: https://bugs.launchpad.net/openstack-manuals/+bug/1342379

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/89291
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=44511224105bfe5192fbf265933bef6d749cfe22
Submitter: Jenkins
Branch: master

commit 44511224105bfe5192fbf265933bef6d749cfe22
Author: Brant Knudson <email address hidden>
Date: Sat Nov 29 10:02:28 2014 -0600

    Use HTTP response codes for identity v3

    The HTTP 1.1 standard (http://tools.ietf.org/html/rfc2616)
    defines the "reason phrase" for each status code. For example,
    400 is Bad Request, 404 is Not Found, etc.

    The identity V3 API reference had unexpected values listed for
    the return codes for different requests, such as
    "identityFault" and "overLimit".

    There's no HTTP response code for identityFault, so this was
    removed.

    The others were changed to use the standard reason phrase.

    Closes-Bug: #1338128

    Change-Id: I5ea51cf456fed9d14e4296b6e0bf19c8fd0f02bb