openstack
/
nova
Code Issues Proposed changes

Change wording of microversion bump about 503 

current API microversion document mentioned no need to bump
version if we change from 500 error to 4xx error,
in this case, 503 (service unavailable) also can't be handled
by client side so it should be fine to change without bump.

This patch comes from I80a07222f44017448d1877d6b821eebe462d9fec
discussion.

Change-Id: I2500698b821797568e2564176e87938f2b0f9ae5
This commit is contained in:
jichenjc 2016-02-22 07:16:10 +08:00
parent 3087672083
commit 33eaa0d6a4
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/api_microversion_dev.rst
View File

@ -88,10 +88,11 @@ changed. The user contract covers many kinds of information such as:
Example: changing the return code of an API from 501 to 400.
.. note:: Fixing a bug so that a 400+ code is returned rather than a 500
does not require a microversion change. It's assumed that clients are not
expected to handle a 500 response and therefore should not need to opt-in
to microversion changes that fixes a 500 response from happening.
.. note:: Fixing a bug so that a 400+ code is returned rather than a 500 or
503 does not require a microversion change. It's assumed that clients are
not expected to handle a 500 or 503 response and therefore should not
need to opt-in to microversion changes that fixes a 500 or 503 response
from happening.
According to the OpenStack API Working Group, a
**500 Internal Server Error** should **not** be returned to the user for
failures due to user error that can be fixed by changing the request on