openstack/zun
Code Issues Proposed changes

Fix some issues in API microversion doc

Browse Source 
* The samples should pass the pep8 test (add spaces around # noqa).
* Add an item under "Other necessary changes" about updating the
  API version for tests.

Change-Id: I6c98b24b8e3aa5f92d7a7a156994a1200682c6c4
This commit is contained in:
Hongbin Lu 2018-06-17 21:30:33 +00:00
parent 4db4adf6e5
commit c17a75d975
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/contributor/api-microversion.rst
View File

@ -229,7 +229,7 @@ In the controller class::
def my_api_method(self, req, id): def my_api_method(self, req, id):
.... method_1 ... .... method_1 ...
@base.Controller.api_version("1.4") #noqa @base.Controller.api_version("1.4") # noqa
def my_api_method(self, req, id): def my_api_method(self, req, id):
.... method_2 ... .... method_2 ...
@ -295,6 +295,8 @@ necessary to add changes to other places which describe your change:
* Update the expected versions in affected tests, for example in * Update the expected versions in affected tests, for example in
``zun/tests/unit/api/controllers/test_root.py``. ``zun/tests/unit/api/controllers/test_root.py``.
* Update ``CURRENT_VERSION`` in ``zun/tests/unit/api/base.py``.
* Make a new commit to python-zunclient and update corresponding * Make a new commit to python-zunclient and update corresponding
files to enable the newly added microversion API. files to enable the newly added microversion API.