From f4af43e2e7c4fc5de135ff2f01bf0df34b0a555d Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Sat, 14 Nov 2015 18:03:28 -0600 Subject: [PATCH] Add Bare Metal API v1 Add WADL and code samples Source is docs.openstack.org/developer/ironic/webapi/v1.html Focus on adding ironic only. Unchenged from previous (from patch set 37) The name of the common query parameters The description of the timestamp paramters Change-Id: I6dc432f226ee7cb47e27296487621f75d4483b25 Closes-Bug: #1482238 --- api-ref-guides/pom.xml | 11 + api-ref/pom.xml | 13 +- api-ref/src/docbkx/api-ref-baremetal-v1.xml | 23 + api-ref/src/docbkx/ch_baremetal-api-v1.xml | 141 +++ .../src/docbkx/itemizedlist-service-list.xml | 5 + .../src/v1/baremetal-api-v1.wadl | 897 ++++++++++++++++++ .../src/wadls/baremetal-api/src/v1/common.ent | 506 ++++++++++ .../v1/samples/chassis-create-request.json | 7 + .../chassis-list-details-response.json | 18 + .../src/v1/samples/chassis-list-response.json | 18 + .../src/v1/samples/chassis-show-response.json | 27 + .../v1/samples/chassis-update-request.json | 7 + .../src/v1/samples/driver-get-response.json | 6 + .../src/v1/samples/drivers-list-response.json | 10 + .../src/v1/samples/link-create-request.json | 4 + .../src/v1/samples/link-show-response.json | 4 + .../src/v1/samples/node-show-response.json | 63 ++ .../v1/samples/node-states-show-response.json | 11 + .../src/v1/samples/nodes-list-response.json | 22 + 19 files changed, 1792 insertions(+), 1 deletion(-) create mode 100644 api-ref/src/docbkx/api-ref-baremetal-v1.xml create mode 100644 api-ref/src/docbkx/ch_baremetal-api-v1.xml create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/baremetal-api-v1.wadl create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/common.ent create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-create-request.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-details-response.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-response.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-show-response.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-update-request.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/driver-get-response.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/drivers-list-response.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/link-create-request.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/link-show-response.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/node-show-response.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/node-states-show-response.json create mode 100644 api-ref/src/wadls/baremetal-api/src/v1/samples/nodes-list-response.json diff --git a/api-ref-guides/pom.xml b/api-ref-guides/pom.xml index a718e4016..150d6cbda 100644 --- a/api-ref-guides/pom.xml +++ b/api-ref-guides/pom.xml @@ -50,6 +50,17 @@ api-ref + + os-api-ref-baremetal-v1 + + generate-pdf + + generate-sources + + bk-api-ref-baremetal-v1.xml + api-ref-baremetal-v1 + + os-api-ref-blockstorage-v2 diff --git a/api-ref/pom.xml b/api-ref/pom.xml index b32576dba..896492733 100644 --- a/api-ref/pom.xml +++ b/api-ref/pom.xml @@ -47,6 +47,17 @@ bk-api-ref + + os-api-ref-baremetal-v1 + + generate-html + + generate-sources + + api-ref-baremetal-v1.xml + bk-api-ref-baremetal-v1 + + os-api-ref-blockstorage-v2 @@ -58,7 +69,7 @@ bk-api-ref-blockstorage-v2 - + os-api-ref-blockstorage-v1 generate-html diff --git a/api-ref/src/docbkx/api-ref-baremetal-v1.xml b/api-ref/src/docbkx/api-ref-baremetal-v1.xml new file mode 100644 index 000000000..f2429eba2 --- /dev/null +++ b/api-ref/src/docbkx/api-ref-baremetal-v1.xml @@ -0,0 +1,23 @@ + + + + OpenStack Bare Metal API v1 (CURRENT) + + 2016 + + + + + + + + + + diff --git a/api-ref/src/docbkx/ch_baremetal-api-v1.xml b/api-ref/src/docbkx/ch_baremetal-api-v1.xml new file mode 100644 index 000000000..e53026f2d --- /dev/null +++ b/api-ref/src/docbkx/ch_baremetal-api-v1.xml @@ -0,0 +1,141 @@ + + + Bare Metal API v1 (CURRENT) + + Manages chassis, drivers, links, nodes, and ports for use with the + Bare Metal API, also known as ironic services. + + + Each Bare Metal API response returns the + X-OpenStack-Ironic-API-Minimum-Version and + X-OpenStack-Ironic-API-Maximum-Version headers, which + indicate, respectively, the minimum and maximum supported API versions + that the server supports. + + + The client can use the X-OpenStack-Ironic-API-Version + request header to request an API version. If the client does not + request an API version, the default is API v1.1, which is the minimum + supported version. The client has access to the features that the + requested API version supports. OpenStack recommends that clients + always request a specific version of API. However, you can request the + latest value, which always requests the most current, + supported API version. + + +
+ Chassis (chassis) + + Chassis operations. + + + + + + + + + + + + + + + +
+
+ Drivers (drivers) + + + + + + + + + + + + + + + + + +
+
+ Links (links) + + + + + + + + + + + + + + +
+
+ Nodes (nodes) + + + + + + + + + + + + + + +
+
+ Ports (ports) + + + + + + + + + + + + + + +
+ diff --git a/api-ref/src/docbkx/itemizedlist-service-list.xml b/api-ref/src/docbkx/itemizedlist-service-list.xml index be5ed503a..ba8b64fff 100644 --- a/api-ref/src/docbkx/itemizedlist-service-list.xml +++ b/api-ref/src/docbkx/itemizedlist-service-list.xml @@ -5,6 +5,11 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:xlink="http://www.w3.org/1999/xlink" xml:lang="EN" xml:id="service-list"> + + + Bare Metal API v1 (CURRENT) + + Block Storage API v2 (CURRENT) diff --git a/api-ref/src/wadls/baremetal-api/src/v1/baremetal-api-v1.wadl b/api-ref/src/wadls/baremetal-api/src/v1/baremetal-api-v1.wadl new file mode 100644 index 000000000..a40ba9c25 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/baremetal-api-v1.wadl @@ -0,0 +1,897 @@ + + + + %common; + + %common_project; +]> + + + + + &tenant_idTemplateParameter; + + + + + + + + &chassis_uuidTemplateParameter; + + + + + + + + + &driver_nameTemplateParameter; + + + + + + + + + + + + + + + + + + + + + + &link_idTemplateParameter; + + + + + + + + + + + + + &node_idTemplateParameter; + + + + + + + + + + + + + &port_idTemplateParameter; + + + + + + + + + + + + + + + + + + Creates a chassis. + + + + + + + + &chassisRequestParameter; + &chassis-descriptionRequestParameter; + &chassis-extraRequestParameter; + + + + + + + + &created_at-ResponseParameter; + &chassis-descriptionResponseParameter; + &chassisResponseParameter; + &chassis-extraResponseParameter; + &chassis-linksResponseParameter; + &chassis-nodesResponseParameter; + &updated_at-ResponseParameter; + &chassis-uuidResponseParameter; + + + &postPutDeleteFaults; + + + + + + + + Lists all chassis. + + + + + &limitMarkerReqParameter; + &sort_dirQueryParameter; + &sort_keyQueryParameter; + &fieldsQueryParameter; + + + + + + + + &chassisResponseParameter; + &chassis-descriptionResponseParameter; + &chassis-extraResponseParameter; + &chassis-uuidResponseParameter; + + + &getFaults; + + + + + + + + Lists all chassis with details. + + + + + &limitMarkerReqParameter; + &sort_dirQueryParameter; + &sort_keyQueryParameter; + + + + + + + + &chassisResponseParameter; + &chassis-descriptionResponseParameter; + &chassis-extraResponseParameter; + &chassis-uuidResponseParameter; + + + &getFaults; + + + + + + + + Shows details for a chassis. + + + + + &fieldsQueryParameter; + + + + + + + + &chassisResponseParameter; + &chassis-descriptionResponseParameter; + &chassis-extraResponseParameter; + &chassis-uuidResponseParameter; + + + &getFaults; + + + + + + + + Updates a chassis. + + + + + + + + + + &chassisRequestParameter; + &chassis-descriptionRequestParameter; + &chassis-extraRequestParameter; + + + + + + + + + + &created_at-ResponseParameter; + &chassis-descriptionResponseParameter; + &chassisResponseParameter; + &chassis-extraResponseParameter; + &chassis-linksResponseParameter; + &chassis-nodesResponseParameter; + &updated_at-ResponseParameter; + &chassis-uuidResponseParameter; + + &postPutDeleteFaults; + + + + + + + + Deletes a chassis. + + + + &postPutDeleteFaults; + + + + + + + + + + + Lists all drivers. + + + + + + + + &driversResponseParameter; + &hostsResponseParameter; + &host-nameResponseParameter; + + + &getFaults; + + + + + + + + Shows details for a driver. + + + + + + + + &hostsResponseParameter; + &host-nameResponseParameter; + + + &getFaults; + + + + + + + + Shows properties for a driver. + + + + + + + + &hostsResponseParameter; + &host-linksResponseParameter; + &host-nameResponseParameter; + &host-propertiesResponseParameter; + + + &getFaults; + + + + + + + + Shows logical disk properties for a driver. + + + + + + + + &hostsResponseParameter; + &host-linksResponseParameter; + &host-nameResponseParameter; + &host-propertiesResponseParameter; + + + &getFaults; + + + + + + + + Shows vendor methods for a driver. + + + + + + + + &hostsResponseParameter; + &host-linksResponseParameter; + &host-nameResponseParameter; + &host-propertiesResponseParameter; + + + &getFaults; + + + + + + + + + + + Creates a link. + + + + + + + + &link-hrefRequestParameter; + &link-relRequestParameter; + &link-typeRequestParameter; + + + + + + + + &link-hrefResponseParameter; + &link-relResponseParameter; + &link-typeResponseParameter; + + + &postPutDeleteFaults; + + + + + + + + Lists all links. + + + + + + + + &link-hrefResponseParameter; + &link-relResponseParameter; + + + &getFaults; + + + + + + + + Lists all links with details. + + + + + + + + &link-hrefResponseParameter; + &link-relResponseParameter; + &link-typeResponseParameter; + + + &getFaults; + + + + + + + + Shows details for a link. + + + + + + + + &link-hrefResponseParameter; + &link-relResponseParameter; + &link-typeResponseParameter; + + + &getFaults; + + + + + + + + Updates a link. + + + + + + + + + + &link-hrefRequestParameter; + &link-relRequestParameter; + &link-typeRequestParameter; + + + + + + + + + + &link-hrefResponseParameter; + &link-relResponseParameter; + &link-typeResponseParameter; + + + &postPutDeleteFaults; + + + + + + + + Deletes a link. + + + + &postPutDeleteFaults; + + + + + + + + + + + Creates a node. + + + + + + + + + + + + + + + &postPutDeleteFaults; + + + + + + + + Lists all nodes. + + + + + + + + + + + &getFaults; + + + + + + + + Lists all nodes with details. + + + + + + + + + + + &getFaults; + + + + + + + + Shows details for a node. + + + + + &fieldsQueryParameter; + + + + + + &getFaults; + + + + + + + + Updates a node. + + + + + + + + &postPutDeleteFaults; + + + + + + + + Deletes a node. + + + + &postPutDeleteFaults; + + + + + + + + + + + Creates a port. + + + + + + + + + + + + + + + &postPutDeleteFaults; + + + + + + + + Lists all ports. + + + + + + + + + + + &getFaults; + + + + + + + + Lists all ports with details. + + + + + + + + + + + &getFaults; + + + + + + + + Shows details for a port. + + + + + &fieldsQueryParameter; + + + + + + &getFaults; + + + + + + + + Updates a port. + + + + + + + + &postPutDeleteFaults; + + + + + + + + Deletes a port. + + + + &postPutDeleteFaults; + + diff --git a/api-ref/src/wadls/baremetal-api/src/v1/common.ent b/api-ref/src/wadls/baremetal-api/src/v1/common.ent new file mode 100644 index 000000000..cd99f0b63 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/common.ent @@ -0,0 +1,506 @@ + + + + + + + +'> + + + +'> + + + +'> + + + +'> + + + +'> + + + +'> + + + +'> + + + +'> + + + +'> + + + + + + + + + + + + + + + A list of one or more representation schemes that are accepted in + the response to this request. Use the semicolon (;) character to + separate multiple schemes. See Accept. + + + (Since v3.3) If the Accept request header value is + application/json-home, the call returns a JSON + Home document. The JSON Home document includes all core + components and the resources for any enabled extensions and excludes + the resources for disabled extensions. + + + Note that the client must check the Content-Type + header value in the response because earlier servers return a + normal JSON response rather than a JSON Home document. + + +'> + + + + A valid authentication token for an administrative user. + + +'> + + + + The authentication token for which you want to perform the + operation. + + +'> + + + + + + + The authentication token. + + + An authentication response returns the token ID in this header + rather than in the response body. + + +'> + + + + + + + The UUID of the chassis. + + +'> + + + + The name of the driver. + + +'> + + + + The UUID of the link. + + +'> + + + + The UUID of the node. + + +'> + + + + The UUID of the port. + + +'> + + + + The tenant ID in a multi-tenancy cloud. + + +'> + + + + + + + Filters the response by a description. + + +'> + + + + One or more chassis fields to be returned in the response. + + + For example, the following request returns only the + description field for each chassis: + +GET /v1/chassis?fields=description + +'> + + + + Sorts the response by the this attribute value. Default is + id. You can specify multiple pairs of sort key and + sort direction query parameters. If you omit the sort direction in + a pair, the API uses the natural sorting direction of the server + attribute that is provided as the sort_key. + + +'> + + + + Sorts the response by the requested sort direction. A valid value + is asc (ascending) or desc (descending). + Default is asc. You can specify multiple pairs of + sort key and sort direction query parameters. If you omit the sort + direction in a pair, the API uses the natural sorting direction of + the server attribute that is provided as the + sort_key. + + +'> + + + + + + + + + A chassis object. + + +'> + + + + A description for the chassis. + + +'> + + + + A set of one or more arbitrary metadata key and value pairs for + the chassis. + + +'> + + + + + + + A list of chassis objects. + + +'> + + + + A description for the chassis. + + +'> + + + + A set of zero or more arbitrary metadata key and value pairs for + the chassis. + + +'> + + + + A list that contains a self link and associated chassis links. + + +'> + + + + Links to the collection of nodes contained in this chassis. + + +'> + + + + The UUID for the chassis. + + +'> + + + + + + + + + A list of drivers objects. + + +'> + + + + A list of active hosts that support this driver. + + +'> + + + A list of relative links. Includes the self and bookmark links. + + +'> + + + The name of the driver. + + +'> + + + A list of links to driver properties. + + +'> + + + + + + + + + The URL of a link. + + +'> + + + + The name of a link. + + +'> + + + + The type of document and link. + + +'> + + + + + + + The URL of a link. + + +'> + + + + The name of a link. + + +'> + + + + The type of document and link. + + +'> + + + diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-create-request.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-create-request.json new file mode 100644 index 000000000..56a95334d --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-create-request.json @@ -0,0 +1,7 @@ +{ + "chassis": [ + { + "description": "Sample chassis" + } + ] +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-details-response.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-details-response.json new file mode 100644 index 000000000..034166cf5 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-details-response.json @@ -0,0 +1,18 @@ +{ + "chassis": [ + { + "description": "Sample chassis", + "links": [ + { + "href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89", + "rel": "self" + }, + { + "href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89", + "rel": "bookmark" + } + ], + "uuid": "eaaca217-e7d8-47b4-bb41-3f99f20eed89" + } + ] +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-response.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-response.json new file mode 100644 index 000000000..034166cf5 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-response.json @@ -0,0 +1,18 @@ +{ + "chassis": [ + { + "description": "Sample chassis", + "links": [ + { + "href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89", + "rel": "self" + }, + { + "href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89", + "rel": "bookmark" + } + ], + "uuid": "eaaca217-e7d8-47b4-bb41-3f99f20eed89" + } + ] +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-show-response.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-show-response.json new file mode 100644 index 000000000..124fff077 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-show-response.json @@ -0,0 +1,27 @@ +{ + "created_at": "2000-01-01T12:00:00", + "description": "Sample chassis", + "extra": {}, + "links": [ + { + "href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89", + "rel": "self" + }, + { + "href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89", + "rel": "bookmark" + } + ], + "nodes": [ + { + "href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89/nodes", + "rel": "self" + }, + { + "href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89/nodes", + "rel": "bookmark" + } + ], + "updated_at": "2000-01-01T12:00:00", + "uuid": "eaaca217-e7d8-47b4-bb41-3f99f20eed89" +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-update-request.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-update-request.json new file mode 100644 index 000000000..56a95334d --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-update-request.json @@ -0,0 +1,7 @@ +{ + "chassis": [ + { + "description": "Sample chassis" + } + ] +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/driver-get-response.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/driver-get-response.json new file mode 100644 index 000000000..d1053fb87 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/driver-get-response.json @@ -0,0 +1,6 @@ +{ + "hosts": [ + "fake-host" + ], + "name": "sample-driver" +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/drivers-list-response.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/drivers-list-response.json new file mode 100644 index 000000000..db387dc76 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/drivers-list-response.json @@ -0,0 +1,10 @@ +{ + "drivers": [ + { + "hosts": [ + "fake-host" + ], + "name": "sample-driver" + } + ] +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/link-create-request.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/link-create-request.json new file mode 100644 index 000000000..6890c07a4 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/link-create-request.json @@ -0,0 +1,4 @@ +{ + "href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89", + "rel": "bookmark" +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/link-show-response.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/link-show-response.json new file mode 100644 index 000000000..6890c07a4 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/link-show-response.json @@ -0,0 +1,4 @@ +{ + "href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89", + "rel": "bookmark" +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/node-show-response.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/node-show-response.json new file mode 100644 index 000000000..34cc5f7de --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/node-show-response.json @@ -0,0 +1,63 @@ +{ + "chassis_uuid": "edcad704-b2da-41d5-96d9-afd580ecfa12", + "clean_step": {}, + "console_enabled": false, + "created_at": "2000-01-01T12:00:00", + "driver": "fake", + "driver_info": {}, + "driver_internal_info": {}, + "extra": {}, + "inspection_finished_at": null, + "inspection_started_at": "2000-01-01T12:00:00", + "instance_info": {}, + "instance_uuid": "dcf1fbc5-93fc-4596-9395-b80572f6267b", + "last_error": null, + "links": [ + { + "href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123", + "rel": "self" + }, + { + "href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123", + "rel": "bookmark" + } + ], + "maintenance": false, + "maintenance_reason": null, + "name": "database16-dc02", + "ports": [ + { + "href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/ports", + "rel": "self" + }, + { + "href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/ports", + "rel": "bookmark" + } + ], + "power_state": "power on", + "properties": { + "cpus": "1", + "local_gb": "10", + "memory_mb": "1024" + }, + "provision_state": "active", + "provision_updated_at": "2000-01-01T12:00:00", + "raid_config": null, + "reservation": null, + "states": [ + { + "href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/states", + "rel": "self" + }, + { + "href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/states", + "rel": "bookmark" + } + ], + "target_power_state": null, + "target_provision_state": null, + "target_raid_config": null, + "updated_at": "2000-01-01T12:00:00", + "uuid": "1be26c0b-03f2-4d2e-ae87-c02d7f33c123" +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/node-states-show-response.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/node-states-show-response.json new file mode 100644 index 000000000..fd9a40da5 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/node-states-show-response.json @@ -0,0 +1,11 @@ +{ + "console_enabled": false, + "last_error": null, + "power_state": "power on", + "provision_state": null, + "provision_updated_at": null, + "raid_config": null, + "target_power_state": "power on", + "target_provision_state": "active", + "target_raid_config": null +} diff --git a/api-ref/src/wadls/baremetal-api/src/v1/samples/nodes-list-response.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/nodes-list-response.json new file mode 100644 index 000000000..8acb80205 --- /dev/null +++ b/api-ref/src/wadls/baremetal-api/src/v1/samples/nodes-list-response.json @@ -0,0 +1,22 @@ +{ + "nodes": [ + { + "instance_uuid": "dcf1fbc5-93fc-4596-9395-b80572f6267b", + "links": [ + { + "href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123", + "rel": "self" + }, + { + "href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123", + "rel": "bookmark" + } + ], + "maintenance": false, + "name": "database16-dc02", + "power_state": "power on", + "provision_state": "active", + "uuid": "1be26c0b-03f2-4d2e-ae87-c02d7f33c123" + } + ] +}