openstack/glance
Code Issues Proposed changes

do not declare code blocks as json when they do not parse

Browse Source 
Change-Id: I697be9b9dd15801d8d8df4fdae429e2d639f250e
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-06-15 14:46:00 -04:00
parent ca7a572d11
commit 03c0a1875c
5 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
glance/api/v1/images.py
View File

@ -334,7 +334,7 @@ class Controller(controller.BaseController):
:param req: The WSGI/Webob Request object :param req: The WSGI/Webob Request object
:returns: The response body is a mapping of the following form :returns: The response body is a mapping of the following form
.. code-block:: json ::
{'images': [ {'images': [
{'id': <ID>, {'id': <ID>,
@ -362,7 +362,7 @@ class Controller(controller.BaseController):
:param req: The WSGI/Webob Request object :param req: The WSGI/Webob Request object
:returns: The response body is a mapping of the following form :returns: The response body is a mapping of the following form
.. code-block:: json ::
{'images': {'images':
[{ [{

8
glance/api/v1/members.py
View File

@ -64,7 +64,7 @@ class Controller(controller.BaseController):
:param image_id: The opaque image identifier :param image_id: The opaque image identifier
:returns: The response body is a mapping of the following form :returns: The response body is a mapping of the following form
.. code-block:: json ::
{'members': [ {'members': [
{'member_id': <MEMBER>, {'member_id': <MEMBER>,
@ -133,7 +133,7 @@ class Controller(controller.BaseController):
Adds a membership to the image, or updates an existing one. Adds a membership to the image, or updates an existing one.
If a body is present, it is a dict with the following format If a body is present, it is a dict with the following format
.. code-block:: json ::
{'member': { {'member': {
'can_share': [True|False] 'can_share': [True|False]
@ -176,7 +176,7 @@ class Controller(controller.BaseController):
Replaces the members of the image with those specified in the Replaces the members of the image with those specified in the
body. The body is a dict with the following format body. The body is a dict with the following format
.. code-block:: json ::
{'memberships': [ {'memberships': [
{'member_id': <MEMBER_ID>, {'member_id': <MEMBER_ID>,
@ -216,7 +216,7 @@ class Controller(controller.BaseController):
:param id: the opaque member identifier :param id: the opaque member identifier
:returns: The response body is a mapping of the following form :returns: The response body is a mapping of the following form
.. code-block:: json ::
{'shared_images': [ {'shared_images': [
{'image_id': <IMAGE>, {'image_id': <IMAGE>,

8
glance/api/v2/image_members.py
View File

@ -98,7 +98,7 @@ class ImageMembersController(object):
:param member_id: the member identifier :param member_id: the member identifier
:returns: The response body is a mapping of the following form :returns: The response body is a mapping of the following form
.. code-block:: json ::
{'member_id': <MEMBER>, {'member_id': <MEMBER>,
'image_id': <IMAGE>, 'image_id': <IMAGE>,
@ -142,7 +142,7 @@ class ImageMembersController(object):
:param member_id: the member identifier :param member_id: the member identifier
:returns: The response body is a mapping of the following form :returns: The response body is a mapping of the following form
.. code-block:: json ::
{'member_id': <MEMBER>, {'member_id': <MEMBER>,
'image_id': <IMAGE>, 'image_id': <IMAGE>,
@ -177,7 +177,7 @@ class ImageMembersController(object):
:param image_id: The image identifier :param image_id: The image identifier
:returns: The response body is a mapping of the following form :returns: The response body is a mapping of the following form
.. code-block:: json ::
{'members': [ {'members': [
{'member_id': <MEMBER>, {'member_id': <MEMBER>,
@ -208,7 +208,7 @@ class ImageMembersController(object):
:param image_id: The image identifier :param image_id: The image identifier
:returns: The response body is a mapping of the following form :returns: The response body is a mapping of the following form
.. code-block:: json ::
{'member_id': <MEMBER>, {'member_id': <MEMBER>,
'image_id': <IMAGE>, 'image_id': <IMAGE>,

4
glance/common/rpc.py
View File

@ -101,7 +101,7 @@ class Controller(object):
This is the base controller for RPC based APIs. Commands This is the base controller for RPC based APIs. Commands
handled by this controller respect the following form: handled by this controller respect the following form:
.. code-block:: json ::
[{ [{
'command': 'method_name', 'command': 'method_name',
@ -238,7 +238,7 @@ class RPCClient(client.BaseClient):
:param commands: List of commands to send. Commands :param commands: List of commands to send. Commands
must respect the following form must respect the following form
.. code-block:: json ::
{ {
'command': 'method_name', 'command': 'method_name',

4
glance/registry/api/v1/images.py
View File

@ -146,7 +146,7 @@ class Controller(object):
Where image_list is a sequence of mappings Where image_list is a sequence of mappings
.. code-block:: json ::
{ {
'id': <ID>, 'id': <ID>,
@ -177,7 +177,7 @@ class Controller(object):
:param req: the Request object coming from the wsgi layer :param req: the Request object coming from the wsgi layer
:returns: a mapping of the following form :returns: a mapping of the following form
.. code-block:: json ::
{'images': {'images':
[{ [{