openstack/ironic
Code Issues Proposed changes

[api-ref] clarify what /v1/lookup returns

Browse Source 
Update the api-ref documentation for the /v1/lookup API, so that
it mentions the node fields that are returned. It does not return
the configdrive value (that is bleeped out in the response).

Change-Id: I24a47a2cfefc582bd0b5f1f0068e89a3091cf397
This commit is contained in:
Ruby Loo 2018-01-31 15:48:47 -05:00
parent b8af1cd853
commit 2166974f28
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api-ref/source/baremetal-api-v1-misc.inc
View File

@ -46,8 +46,7 @@ service.
The query string should include either or both a ``node_uuid`` or an
``addresses`` query parameter. If a matching Node is found, information about
that Node shall be returned, including instance-specific information such as
the configdrive.
that Node shall be returned.
Normal response codes: 200

3
api-ref/source/parameters.yaml
View File

@ -327,7 +327,8 @@ agent_config:
type: JSON
agent_node:
description: |
JSON document containing a subset of Node fields, used by the
JSON document containing the Node fields "uuid", "properties",
"instance_info", and "driver_internal_info"; used by the
ironic-python-agent process as it operates on the Node.
in: body
required: true