From 2166974f28fd0c0c11d04b21de007fab69c7a84a Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Wed, 31 Jan 2018 15:48:47 -0500 Subject: [PATCH] [api-ref] clarify what /v1/lookup returns 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 --- api-ref/source/baremetal-api-v1-misc.inc | 3 +-- api-ref/source/parameters.yaml | 3 ++- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/api-ref/source/baremetal-api-v1-misc.inc b/api-ref/source/baremetal-api-v1-misc.inc index 078b956fbb..1e9d0c5e87 100644 --- a/api-ref/source/baremetal-api-v1-misc.inc +++ b/api-ref/source/baremetal-api-v1-misc.inc @@ -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 diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index cb8f290d1a..17a3397ef6 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -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