openstack/ironic
Code Issues Proposed changes

Document backwards compat for passthru methods

Browse Source 
This adds a section to the vendor-passthru documentation
about backwards compatibility (which isn't necessary but
desirable) for vendor-passthru methods.

Change-Id: I27b4a6638772e3508e9dab34d90ca904198352f0
This commit is contained in:
Ruby Loo 2016-01-13 20:59:06 +00:00
parent 10c02f7c24
commit c12cc036eb
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/dev/vendor-passthru.rst
View File

@ -129,3 +129,16 @@ Both decorators accepts the same parameters:
Each asynchronous request consumes a worker thread in the
``ironic-conductor`` process. This can lead to starvation of the
thread pool, resulting in a denial of service.
Backwards Compatibility
=======================
There is no requirement that changes to a vendor method be backwards
compatible. However, for your users' sakes, we highly recommend that
you do so.
If you are changing the exceptions being raised, you might want to ensure
that the same HTTP code is being returned to the user.
For non-backwards compatibility, please make sure you add a release
note that indicates this.