Add API Reference for Watcher

This patch set adds API Reference along with some
fixes to documentation. It partially fixes bug #1757423.

Change-Id: I107b4fd5daf40aad63fc13864debbbbc82a9826c
This commit is contained in:
Alexander Chadin
2018-04-03 19:55:57 +03:00
parent bbd0ae5b16
commit 533c0a4114
57 changed files with 3033 additions and 30 deletions

View File

@@ -83,7 +83,7 @@ class ScoringEngine(base.APIBase):
def _convert_with_links(se, url, expand=True):
if not expand:
se.unset_fields_except(
['uuid', 'name', 'description', 'metainfo'])
['uuid', 'name', 'description'])
se.links = [link.Link.make_link('self', url,
'scoring_engines', se.uuid),

View File

@@ -292,7 +292,7 @@ class StrategiesController(rest.RestController):
@wsme_pecan.wsexpose(wtypes.text, wtypes.text)
def state(self, strategy):
"""Retrieve a inforamation about strategy requirements.
"""Retrieve an information about strategy requirements.
:param strategy: name of the strategy.
"""

View File

@@ -21,7 +21,7 @@ from watcher.tests.objects import utils as obj_utils
class TestListScoringEngine(api_base.FunctionalTest):
def _assert_scoring_engine_fields(self, scoring_engine):
scoring_engine_fields = ['uuid', 'name', 'description', 'metainfo']
scoring_engine_fields = ['uuid', 'name', 'description']
for field in scoring_engine_fields:
self.assertIn(field, scoring_engine)