Add the api help information

Add the help information about the /introspection/%s/data/ api.

Change-Id: I8c60c80bee2582d56acc7da120f12415eab39427
This commit is contained in:
jinxingfang 2018-03-08 10:29:25 +08:00
parent b73403fdad
commit cce74f8cf8
1 changed files with 6 additions and 0 deletions

View File

@ -106,6 +106,9 @@ class ClientV1(http.BaseClient):
def reprocess(self, uuid):
"""Reprocess stored introspection data.
If swift support is disabled, introspection data won't be stored,
this request will return error response with 404 code.
:param uuid: node UUID or name.
:raises: :py:class:`.ClientError` on error reported from a server
:raises: :py:class:`.VersionNotSupported` if requested api_version
@ -227,6 +230,9 @@ class ClientV1(http.BaseClient):
def get_data(self, uuid, raw=False):
"""Get introspection data from the last introspection of a node.
If swift support is disabled, introspection data won't be stored,
this request will return error response with 404 code.
:param uuid: node UUID or name.
:param raw: whether to return raw binary data or parsed JSON data
:returns: bytes or a dict depending on the 'raw' argument