diff options
author | Julia Kreger <juliaashleykreger@gmail.com> | 2018-11-16 11:10:15 -0800 |
---|---|---|
committer | Julia Kreger <juliaashleykreger@gmail.com> | 2018-12-10 14:27:31 -0800 |
commit | 052d90506fdb75479250705be4ba033f9f025c76 (patch) | |
tree | db179129de168f2d96eefcbed8a84430cff3d6c9 /api-ref | |
parent | 88e13746267f64376b7ed1cd9fd95a770b1b1989 (diff) | |
download | ironic-052d90506fdb75479250705be4ba033f9f025c76.tar.gz |
Add "owner" information field
Adds "owner" field on the node object and exposes it for updates
via the API.
Additionally, fixed a couple minor items related to the prior
where we missed updating version numbers in rebases.
Change-Id: Iaaf3db97d21de9b11236cf2d18ffcc3f73f6e50c
Story: #2001814
Task: #12550
Diffstat (limited to 'api-ref')
-rw-r--r-- | api-ref/source/baremetal-api-v1-nodes.inc | 13 | ||||
-rw-r--r-- | api-ref/source/parameters.yaml | 6 | ||||
-rw-r--r-- | api-ref/source/samples/node-create-response.json | 1 | ||||
-rw-r--r-- | api-ref/source/samples/node-show-response.json | 1 | ||||
-rw-r--r-- | api-ref/source/samples/node-update-driver-info-response.json | 1 | ||||
-rw-r--r-- | api-ref/source/samples/nodes-list-details-response.json | 2 |
6 files changed, 24 insertions, 0 deletions
diff --git a/api-ref/source/baremetal-api-v1-nodes.inc b/api-ref/source/baremetal-api-v1-nodes.inc index 28e345be1..8cdb025d0 100644 --- a/api-ref/source/baremetal-api-v1-nodes.inc +++ b/api-ref/source/baremetal-api-v1-nodes.inc @@ -92,6 +92,9 @@ supplied when the Node is created, or the resource may be updated later. .. versionadded:: 1.46 Introduced the ``conductor_group`` field. +.. versionadded: 1.50 + Introduced the ``owner`` field. + Normal response codes: 201 Error codes: 400,403,406 @@ -120,6 +123,7 @@ Request - storage_interface: req_storage_interface - uuid: req_uuid - vendor_interface: req_vendor_interface + - owner: owner **Example Node creation request with a dynamic driver:** @@ -188,6 +192,7 @@ microversion 1.48. - conductor_group: conductor_group - protected: protected - protected_reason: protected_reason + - owner: owner **Example JSON representation of a Node:** @@ -235,6 +240,9 @@ provision state, and maintenance setting for each Node. Introduced the ``conductor_group`` request parameter, to allow filtering the list of returned nodes by conductor group. +.. versionadded: 1.50 + Introduced the ``owner`` field. + Normal response codes: 200 Error codes: 400,403,406 @@ -258,6 +266,7 @@ Request - sort_dir: sort_dir - sort_key: sort_key - detail: detail + - owner: owner Response -------- @@ -307,6 +316,9 @@ Nova instance, eg. with a request to ``v1/nodes/detail?instance_uuid={NOVA INSTA .. versionadded:: 1.48 Introduced the ``protected`` and ``protected_reason`` fields. +.. versionadded: 1.50 + Introduced the ``owner`` field. + Normal response codes: 200 Error codes: 400,403,406 @@ -324,6 +336,7 @@ Request - driver: r_driver - resource_class: r_resource_class - conductor_group: r_conductor_group + - owner: owner - limit: limit - marker: marker - sort_dir: sort_dir diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index c05bc3571..1ed61419b 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -856,6 +856,12 @@ nodes: in: body required: true type: array +owner: + description: | + A string or UUID of the tenant who owns the baremetal node. + in: body + required: false + type: string passthru_async: description: | If True the passthru function is invoked asynchronously; if False, diff --git a/api-ref/source/samples/node-create-response.json b/api-ref/source/samples/node-create-response.json index 33d075a10..e615b226b 100644 --- a/api-ref/source/samples/node-create-response.json +++ b/api-ref/source/samples/node-create-response.json @@ -36,6 +36,7 @@ "management_interface": null, "name": "test_node_classic", "network_interface": "flat", + "owner": null, "portgroups": [ { "href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/portgroups", diff --git a/api-ref/source/samples/node-show-response.json b/api-ref/source/samples/node-show-response.json index 8e0078c8d..d12619e57 100644 --- a/api-ref/source/samples/node-show-response.json +++ b/api-ref/source/samples/node-show-response.json @@ -38,6 +38,7 @@ "management_interface": null, "name": "test_node_classic", "network_interface": "flat", + "owner": null, "portgroups": [ { "href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/portgroups", diff --git a/api-ref/source/samples/node-update-driver-info-response.json b/api-ref/source/samples/node-update-driver-info-response.json index 420772242..374e6043a 100644 --- a/api-ref/source/samples/node-update-driver-info-response.json +++ b/api-ref/source/samples/node-update-driver-info-response.json @@ -40,6 +40,7 @@ "management_interface": null, "name": "test_node_classic", "network_interface": "flat", + "owner": null, "portgroups": [ { "href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/portgroups", diff --git a/api-ref/source/samples/nodes-list-details-response.json b/api-ref/source/samples/nodes-list-details-response.json index a6ba4480d..a8fc2faaa 100644 --- a/api-ref/source/samples/nodes-list-details-response.json +++ b/api-ref/source/samples/nodes-list-details-response.json @@ -40,6 +40,7 @@ "management_interface": null, "name": "test_node_classic", "network_interface": "flat", + "owner": "john doe", "portgroups": [ { "href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/portgroups", @@ -139,6 +140,7 @@ "management_interface": "ipmitool", "name": "test_node_dynamic", "network_interface": "flat", + "owner": "43e61ec9-8e42-4dcb-bc45-30d66aa93e5b", "portgroups": [ { "href": "http://127.0.0.1:6385/v1/nodes/2b045129-a906-46af-bc1a-092b294b3428/portgroups", |