openstack/deb-mistral
Code Issues Proposed changes

Fix version response from root controller

Browse Source 
According to guideline from API-WG [1], the version discovery protocol
requires a GET on '/' return a dictionary containing 'versions', whose
value is a list of supported versions. Under each version record, there
could be multiple 'links'. This patch tunes the root controller to
better align with this guideline.

[1] http://git.openstack.org/cgit/openstack/api-wg/tree/guidelines/
microversion_specification.rst#n130

Change-Id: I6834310e6d4e7e14a7720f6577890757fe4dca21
This commit is contained in:
tengqm 2016-12-19 05:19:36 -05:00
parent 3be004e523
commit 4293e4061f
2 changed files with 26 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
mistral/api/controllers/root.py
View File

@ -28,7 +28,7 @@ API_STATUS = wtypes.Enum(str, 'SUPPORTED', 'CURRENT', 'DEPRECATED')
class APIVersion(resource.Resource):
"""API Version."""
"""An API Version."""
id = wtypes.text
"The version identifier."
@ -36,7 +36,7 @@ class APIVersion(resource.Resource):
status = API_STATUS
"The status of the API (SUPPORTED, CURRENT or DEPRECATED)."
link = resource.Link
links = wtypes.ArrayType(resource.Link)
"The link to the versioned API."
@classmethod
@ -44,17 +44,28 @@ class APIVersion(resource.Resource):
return cls(
id='v1.0',
status='CURRENT',
link=resource.Link(
target_name='v1',
href='http://example.com:9777/v1'
)
links=[
resource.Link(target_name='v1',
href='http://example.com:9777/v1')
]
)
class APIVersions(resource.Resource):
"""API Versions."""
versions = wtypes.ArrayType(APIVersion)
@classmethod
def sample(cls):
v2 = APIVersion(id='v2.0', status='CURRENT',
href='http://example.com:9777/v2')
return cls(versions=[v2])
class RootController(object):
v2 = v2_root.Controller()
@wsme_pecan.wsexpose([APIVersion])
@wsme_pecan.wsexpose(APIVersions)
def index(self):
LOG.debug("Fetching API versions.")
@ -62,7 +73,7 @@ class RootController(object):
api_v2 = APIVersion(
id='v2.0',
status='CURRENT',
link=resource.Link(href=host_url_v2, target='v2')
links=[resource.Link(href=host_url_v2, target='v2')]
)
return [api_v2]
return APIVersions(versions=[api_v2])

12
mistral/tests/unit/api/v2/test_root.py
View File

@ -26,12 +26,12 @@ class TestRootController(base.APITest):
self.assertEqual(200, resp.status_int)
data = jsonutils.loads(resp.body.decode())
data = data['versions']
self.assertEqual('v2.0', data[0]['id'])
self.assertEqual('CURRENT', data[0]['status'])
self.assertEqual(
{'href': 'http://localhost/v2', 'target': 'v2'},
data[0]['link']
[{'href': 'http://localhost/v2', 'target': 'v2'}],
data[0]['links']
)
def test_v2_root(self):
@ -54,12 +54,12 @@ class TestRootControllerWithAuth(test_auth.TestKeystoneMiddleware):
self.assertEqual(200, resp.status_int)
data = jsonutils.loads(resp.body.decode())
data = data['versions']
self.assertEqual('v2.0', data[0]['id'])
self.assertEqual('CURRENT', data[0]['status'])
self.assertEqual(
{'href': 'http://localhost/v2', 'target': 'v2'},
data[0]['link']
[{'href': 'http://localhost/v2', 'target': 'v2'}],
data[0]['links']
)
def test_v2_root(self):