openstack/nova
Code Issues Proposed changes

Document our policy on fixing v2.0 API bugs

Browse Source 
There was recent discussion in some reviews about fixing
latent bugs in the legacy v2.0 API code. Since the
v2.0 API is deprecated and v2.1 is the default since Liberty,
we shouldn't need to fix latent low-priority bugs in v2.0
anymore.

However, we'll still fix critical bugs, and we shouldn't
knowingly introduce new regressions that would result
in a 500 response.

Change-Id: I9937d9226a99754dadcc48d599090296f5ae01f7
This commit is contained in:
Matt Riedemann
2016-04-05 19:52:00 -04:00
parent 629f9f0f44
commit a61219721a
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/code-review.rst
View File

@@ -115,6 +115,22 @@ very long. So here are some key points:
* Synchronous resource deletion: ``204 No Content``
* For all other successful operations: ``200 OK``
Fixing bugs in v2.0
-------------------
The v2.1 API was made the default in Liberty [1]_ and the ability to disable
the v2.1 API was removed in Newton [2]_. The v2.0 legacy API code is also
deprecated [3]_. As such, latent bugs do not need to be fixed in the legacy
v2.0 API code, with the exception of critical bugs like security
vulnerabilities. Also, new regressions should be avoided, like if raising a
new exception would result in a 500 response from the REST API, that should be
handled in the v2.0 API code as well as the v2.1 API.
.. [1] https://github.com/openstack/nova/commit/4a18f7d3bafcdbede48500aac389e0a770b8e6a8
.. [2] https://github.com/openstack/nova/commit/e65557c1933a563a106763e06d0d4f564d7a4174
.. [3] https://github.com/openstack/nova/commit/fe057636a5eb5b95d03c15f13fff20f76b049d6c
Config Options
==============