openstack
/
nova
Code Issues Proposed changes

Merge "Add 415 to list of exceptions for microversions devref"

This commit is contained in:
Jenkins 2016-04-22 23:04:05 +00:00 committed by Gerrit Code Review
parent 7b095dba18 e781103841
commit af9f2d5161
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/api_microversion_dev.rst
View File

@ -82,7 +82,7 @@ changed. The user contract covers many kinds of information such as:
Example: an API previously could return 200, 400, 403, 404 and the
change would make the API now also be allowed to return 409.
See [#f2]_ for the 400, 403 and 404 cases.
See [#f2]_ for the 400, 403, 404 and 415 cases.
- changing a status code on a particular response
@ -172,11 +172,18 @@ we need a microversion".
microversion is probably needed.
.. [#f2] The exception to not needing a microversion when returning a
previously unspecified error code is the 400, 403 and 404 cases. This is
previously unspecified error code is the 400, 403, 404 and 415 cases. This is
considered OK to return even if previously unspecified in the code since
it's implied given keystone authentication can fail with a 403 and API
validation can fail with a 400 for invalid json request body. Request to
url/resource that does not exist always fails with 404.
url/resource that does not exist always fails with 404. Invalid content types
are handled before API methods are called which results in a 415.
.. note:: When in doubt about whether or not a microversion is required
for changing an error response code, consult the `Nova API subteam`_.
.. _Nova API subteam: https://wiki.openstack.org/wiki/Meetings/NovaAPI
When a microversion is not needed
---------------------------------