diff --git a/api-ref/source/baremetal/v1/baremetal-api-v1-chassis.inc b/api-ref/source/baremetal/v1/baremetal-api-v1-chassis.inc deleted file mode 100644 index f37b5859f..000000000 --- a/api-ref/source/baremetal/v1/baremetal-api-v1-chassis.inc +++ /dev/null @@ -1,305 +0,0 @@ -.. -*- rst -*- - -================= -Chassis (chassis) -================= - -Chassis operations. - - -List chassis with details -========================= - -.. rest_method:: GET /v1/chassis/detail - -Lists all chassis with details. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - limit: limit - - marker: marker - - sort_dir: sort_dir - - sort_key: sort_key - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - uuid: uuid - - chassis: chassis - - description: description - - extra: extra - - - -Response Example ----------------- - -.. literalinclude:: samples/chassis-list-details-response.json - :language: javascript - - - - - - - - - - - -Show chassis details -==================== - -.. rest_method:: GET /v1/chassis/{chassis_id} - -Shows details for a chassis. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - fields: fields - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - uuid: uuid - - chassis: chassis - - description: description - - extra: extra - - - -Response Example ----------------- - -.. literalinclude:: samples/chassis-show-response.json - :language: javascript - - - - - - - - - - - -Update chassis -============== - -.. rest_method:: PATCH /v1/chassis/{chassis_id} - -Updates a chassis. - - -Normal response codes: 200 -Error response codes:413,415,405,404,403,401,400,503,409, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - chassis: chassis - - description: description - - extra: extra - -Request Example ---------------- - -.. literalinclude:: samples/chassis-update-request.json - :language: javascript - - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - description: description - - links: links - - extra: extra - - created_at: created_at - - updated_at: updated_at - - chassis: chassis - - nodes: nodes - - uuid: uuid - - - -Response Example ----------------- - -.. literalinclude:: samples/chassis-show-response.json - :language: javascript - - - - - - - - - - - - - -Delete chassis -============== - -.. rest_method:: DELETE /v1/chassis/{chassis_id} - -Deletes a chassis. - -Error response codes:204,413,415,405,404,403,401,400,503,409, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - - - - - - - - - - - - - - -Create chassis -============== - -.. rest_method:: POST /v1/chassis - -Creates a chassis. - -Error response codes:201,413,415,405,404,403,401,400,503,409, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - chassis: chassis - - description: description - - extra: extra - -Request Example ---------------- - -.. literalinclude:: samples/chassis-create-request.json - :language: javascript - - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - description: description - - links: links - - extra: extra - - created_at: created_at - - updated_at: updated_at - - nodes: nodes - - uuid: uuid - - - - - - - - - - - - - - -List chassis -============ - -.. rest_method:: GET /v1/chassis - -Lists all chassis. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - limit: limit - - marker: marker - - sort_dir: sort_dir - - sort_key: sort_key - - fields: fields - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - uuid: uuid - - chassis: chassis - - description: description - - extra: extra - - - -Response Example ----------------- - -.. literalinclude:: samples/chassis-list-response.json - :language: javascript - - - - - - - - - - diff --git a/api-ref/source/baremetal/v1/baremetal-api-v1-drivers.inc b/api-ref/source/baremetal/v1/baremetal-api-v1-drivers.inc deleted file mode 100644 index ff79d0af7..000000000 --- a/api-ref/source/baremetal/v1/baremetal-api-v1-drivers.inc +++ /dev/null @@ -1,244 +0,0 @@ -.. -*- rst -*- - -================= -Drivers (drivers) -================= - - - - -Show driver details -=================== - -.. rest_method:: GET /v1/drivers/{driver_name} - -Shows details for a driver. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - driver_name: driver_name - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - hosts: hosts - - name: name - - - -Response Example ----------------- - -.. literalinclude:: samples/driver-get-response.json - :language: javascript - - - - - - - - - - - -Show driver properties -====================== - -.. rest_method:: GET /v1/drivers/{driver_name}/properties - -Shows properties for a driver. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - driver_name: driver_name - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - hosts: hosts - - name: name - - links: links - - properties: properties - - - -Response Example ----------------- - -.. literalinclude:: samples/driver-get-response.json - :language: javascript - - - - - - - - - - - -List drivers -============ - -.. rest_method:: GET /v1/drivers - -Lists all drivers. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - drivers: drivers - - hosts: hosts - - name: name - - - -Response Example ----------------- - -.. literalinclude:: samples/drivers-list-response.json - :language: javascript - - - - - - - - - - - -Show driver logical disk properties -=================================== - -.. rest_method:: GET /v1/drivers/{driver_name}/raid/logical_disk_properties - -Shows logical disk properties for a driver. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - driver_name: driver_name - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - hosts: hosts - - name: name - - links: links - - properties: properties - - - -Response Example ----------------- - -.. literalinclude:: samples/driver-get-response.json - :language: javascript - - - - - - - - - - - -Show driver vendor methods -========================== - -.. rest_method:: GET /v1/drivers/{driver_name}/vendor_passthru/methods - -Shows vendor methods for a driver. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - driver_name: driver_name - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - hosts: hosts - - name: name - - links: links - - properties: properties - - - -Response Example ----------------- - -.. literalinclude:: samples/driver-get-response.json - :language: javascript - - - - - - - - - - diff --git a/api-ref/source/baremetal/v1/baremetal-api-v1-nodes.inc b/api-ref/source/baremetal/v1/baremetal-api-v1-nodes.inc deleted file mode 100644 index ae291eeb4..000000000 --- a/api-ref/source/baremetal/v1/baremetal-api-v1-nodes.inc +++ /dev/null @@ -1,222 +0,0 @@ -.. -*- rst -*- - -============= -Nodes (nodes) -============= - - - - -Show node details -================= - -.. rest_method:: GET /v1/nodes/{node_id} - -Shows details for a node. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - node_id: node_id - - fields: fields - - - - -Response Example ----------------- - -.. literalinclude:: samples/node-show-response.json - :language: javascript - - - - - - - - - - - -Update node -=========== - -.. rest_method:: PATCH /v1/nodes/{node_id} - -Updates a node. - - -Normal response codes: 200 -Error response codes:413,415,405,404,403,401,400,503,409, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - node_id: node_id - - - - -Response Example ----------------- - -.. literalinclude:: - :language: javascript - - - - - - - - - - - - - -Delete node -=========== - -.. rest_method:: DELETE /v1/nodes/{node_id} - -Deletes a node. - -Error response codes:204,413,415,405,404,403,401,400,503,409, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - node_id: node_id - - - - - - - - - - - - - - - -List nodes with details -======================= - -.. rest_method:: GET /v1/nodes/detail - -Lists all nodes with details. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - - - -Response Example ----------------- - -.. literalinclude:: samples/nodes-list-details-response.json - :language: javascript - - - - - - - - - - - -Create node -=========== - -.. rest_method:: POST /v1/nodes - -Creates a node. - -Error response codes:201,413,415,405,404,403,401,400,503,409, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - - - - - - - - - - - - - - -List nodes -========== - -.. rest_method:: GET /v1/nodes - -Lists all nodes. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - - - -Response Example ----------------- - -.. literalinclude:: samples/nodes-list-response.json - :language: javascript - - - - - - - - - - diff --git a/api-ref/source/baremetal/v1/baremetal-api-v1-ports.inc b/api-ref/source/baremetal/v1/baremetal-api-v1-ports.inc deleted file mode 100644 index 93cbe0fe7..000000000 --- a/api-ref/source/baremetal/v1/baremetal-api-v1-ports.inc +++ /dev/null @@ -1,222 +0,0 @@ -.. -*- rst -*- - -============= -Ports (ports) -============= - - - - -Show port details -================= - -.. rest_method:: GET /v1/ports/{port_id} - -Shows details for a port. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - port_id: port_id - - fields: fields - - - - -Response Example ----------------- - -.. literalinclude:: - :language: javascript - - - - - - - - - - - -Update port -=========== - -.. rest_method:: PATCH /v1/ports/{port_id} - -Updates a port. - - -Normal response codes: 200 -Error response codes:413,415,405,404,403,401,400,503,409, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - port_id: port_id - - - - -Response Example ----------------- - -.. literalinclude:: - :language: javascript - - - - - - - - - - - - - -Delete port -=========== - -.. rest_method:: DELETE /v1/ports/{port_id} - -Deletes a port. - -Error response codes:204,413,415,405,404,403,401,400,503,409, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - port_id: port_id - - - - - - - - - - - - - - - -List ports with details -======================= - -.. rest_method:: GET /v1/ports/detail - -Lists all ports with details. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - - - -Response Example ----------------- - -.. literalinclude:: - :language: javascript - - - - - - - - - - - -Create port -=========== - -.. rest_method:: POST /v1/ports - -Creates a port. - -Error response codes:201,413,415,405,404,403,401,400,503,409, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - - - - - - - - - - - - - - -List ports -========== - -.. rest_method:: GET /v1/ports - -Lists all ports. - - -Normal response codes: 200 -Error response codes:413,405,404,403,401,400,503, - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - - - -Response Example ----------------- - -.. literalinclude:: - :language: javascript - - - - - - - - - - diff --git a/api-ref/source/baremetal/v1/parameters.yaml b/api-ref/source/baremetal/v1/parameters.yaml deleted file mode 100644 index 821334fc2..000000000 --- a/api-ref/source/baremetal/v1/parameters.yaml +++ /dev/null @@ -1,209 +0,0 @@ -# variables in header -{} - -# variables in path -driver_name: - description: | - The name of the driver. - in: path - required: false - type: string -node_id: - description: | - The UUID of the node. - in: path - required: false - type: string -port_id: - description: | - The UUID of the port. - in: path - required: false - type: string - -# variables in query -fields: - 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 - in: query - required: false - type: array -limit: - description: | - Requests a page size of items. Returns a number - of items up to a limit value. Use the ``limit`` parameter to make - an initial limited request and use the ID of the last-seen item - from the response as the ``marker`` parameter value in a - subsequent limited request. - in: query - required: false - type: integer -marker: - description: | - The ID of the last-seen item. Use the ``limit`` - parameter to make an initial limited request and use the ID of the - last-seen item from the response as the ``marker`` parameter value - in a subsequent limited request. - in: query - required: false - type: string -sort_dir: - description: | - 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``. - in: query - required: false - type: string -sort_key: - 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``. - in: query - required: false - type: string - -# variables in body -chassis: - description: | - A ``chassis`` object. - in: body - required: true - type: array -chassis_1: - description: | - A list of chassis objects. - in: body - required: true - type: array -created_at: - description: | - The date and time when the resource was created. - - The date and time stamp format is `ISO 8601 - `_: - - :: - - CCYY-MM-DDThh:mm:ss±hh:mm - - For example, ``2015-08-27T09:49:58-05:00``. - - The ``±hh:mm`` value, if included, is the time zone as an offset - from UTC. - in: body - required: true - type: string -description: - description: | - A description for the chassis. - in: body - required: false - type: string -description_1: - description: | - A description for the chassis. - in: body - required: true - type: string -drivers: - description: | - A list of ``drivers`` objects. - in: body - required: true - type: array -extra: - description: | - A set of one or more arbitrary metadata key and - value pairs for the chassis. - in: body - required: false - type: object -extra_1: - description: | - A set of zero or more arbitrary metadata key and - value pairs for the chassis. - in: body - required: true - type: object -hosts: - description: | - A list of active hosts that support this driver. - in: body - required: true - type: array -links: - description: | - A list that contains a self link and associated - chassis links. - in: body - required: true - type: array -links_1: - description: | - A list of relative links. Includes the self and - bookmark links. - in: body - required: true - type: array -name: - description: | - The name of the driver. - in: body - required: true - type: string -nodes: - description: | - Links to the collection of nodes contained in - this chassis. - in: body - required: true - type: array -properties: - description: | - A list of links to driver properties. - in: body - required: true - type: array -updated_at: - description: | - The date and time when the resource was updated. - - The date and time stamp format is `ISO 8601 - `_: - - :: - - CCYY-MM-DDThh:mm:ss±hh:mm - - For example, ``2015-08-27T09:49:58-05:00``. - - The ``±hh:mm`` value, if included, is the time zone as an offset - from UTC. In the previous example, the offset value is ``-05:00``. - - If the ``updated_at`` date and time stamp is not set, its value is - ``null``. - in: body - required: true - type: string -uuid: - description: | - The UUID for the chassis. - in: body - required: true - type: string - diff --git a/api-ref/source/baremetal/v1/samples/chassis-create-request.json b/api-ref/source/baremetal/v1/samples/chassis-create-request.json deleted file mode 100644 index 56a95334d..000000000 --- a/api-ref/source/baremetal/v1/samples/chassis-create-request.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "chassis": [ - { - "description": "Sample chassis" - } - ] -} diff --git a/api-ref/source/baremetal/v1/samples/chassis-list-details-response.json b/api-ref/source/baremetal/v1/samples/chassis-list-details-response.json deleted file mode 100644 index 034166cf5..000000000 --- a/api-ref/source/baremetal/v1/samples/chassis-list-details-response.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "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/source/baremetal/v1/samples/chassis-list-response.json b/api-ref/source/baremetal/v1/samples/chassis-list-response.json deleted file mode 100644 index 034166cf5..000000000 --- a/api-ref/source/baremetal/v1/samples/chassis-list-response.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "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/source/baremetal/v1/samples/chassis-show-response.json b/api-ref/source/baremetal/v1/samples/chassis-show-response.json deleted file mode 100644 index 124fff077..000000000 --- a/api-ref/source/baremetal/v1/samples/chassis-show-response.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "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/source/baremetal/v1/samples/chassis-update-request.json b/api-ref/source/baremetal/v1/samples/chassis-update-request.json deleted file mode 100644 index 56a95334d..000000000 --- a/api-ref/source/baremetal/v1/samples/chassis-update-request.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "chassis": [ - { - "description": "Sample chassis" - } - ] -} diff --git a/api-ref/source/baremetal/v1/samples/driver-get-response.json b/api-ref/source/baremetal/v1/samples/driver-get-response.json deleted file mode 100644 index d1053fb87..000000000 --- a/api-ref/source/baremetal/v1/samples/driver-get-response.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "hosts": [ - "fake-host" - ], - "name": "sample-driver" -} diff --git a/api-ref/source/baremetal/v1/samples/drivers-list-response.json b/api-ref/source/baremetal/v1/samples/drivers-list-response.json deleted file mode 100644 index db387dc76..000000000 --- a/api-ref/source/baremetal/v1/samples/drivers-list-response.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "drivers": [ - { - "hosts": [ - "fake-host" - ], - "name": "sample-driver" - } - ] -} diff --git a/api-ref/source/baremetal/v1/samples/node-show-response.json b/api-ref/source/baremetal/v1/samples/node-show-response.json deleted file mode 100644 index 34cc5f7de..000000000 --- a/api-ref/source/baremetal/v1/samples/node-show-response.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "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/source/baremetal/v1/samples/node-states-show-response.json b/api-ref/source/baremetal/v1/samples/node-states-show-response.json deleted file mode 100644 index fd9a40da5..000000000 --- a/api-ref/source/baremetal/v1/samples/node-states-show-response.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "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/source/baremetal/v1/samples/nodes-list-details-response.json b/api-ref/source/baremetal/v1/samples/nodes-list-details-response.json deleted file mode 100644 index 17487fd3c..000000000 --- a/api-ref/source/baremetal/v1/samples/nodes-list-details-response.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "nodes": [ - { - "chassis_uuid": "633f9f21-5bd5-4166-b811-1eb01490c4ab", - "clean_step": {}, - "console_enabled": false, - "created_at": "2016-04-23T10:52:43+00:00", - "driver": "pxe_ssh", - "driver_info": { - "deploy_kernel": "aadebece-ce44-4cf6-a9e8-545f0e8ac9f3", - "deploy_ramdisk": "cfe6f9ce-b2e6-4a7a-9246-0cc7eeb89a71", - "ssh_address": "localhost", - "ssh_key_filename": "/opt/stack/data/ironic/ssh_keys/ironic_key", - "ssh_port": 22, - "ssh_username": "ubuntu", - "ssh_virt_type": "virsh" - }, - "driver_internal_info": {}, - "extra": {}, - "inspection_finished_at": null, - "inspection_started_at": null, - "instance_info": {}, - "instance_uuid": null, - "last_error": null, - "links": [ - { - "href": "http://localhost:6385/v1/nodes/277c9fe9-a385-4e45-9399-660f3287e48c", - "rel": "self" - }, - { - "href": "http://localhost:6385/nodes/277c9fe9-a385-4e45-9399-660f3287e48c", - "rel": "bookmark" - } - ], - "maintenance": false, - "maintenance_reason": null, - "name": "node-0", - "ports": [ - { - "href": "http://localhost:6385/v1/nodes/277c9fe9-a385-4e45-9399-660f3287e48c/ports", - "rel": "self" - }, - { - "href": "http://localhost:6385/nodes/277c9fe9-a385-4e45-9399-660f3287e48c/ports", - "rel": "bookmark" - } - ], - "power_state": "power off", - "properties": { - "cpu_arch": "x86_64", - "cpus": 1, - "local_gb": 10, - "memory_mb": 1024 - }, - "provision_state": "available", - "provision_updated_at": null, - "reservation": null, - "target_power_state": null, - "target_provision_state": null, - "updated_at": "2016-04-23T10:53:37+00:00", - "uuid": "277c9fe9-a385-4e45-9399-660f3287e48c" - } - ] -} diff --git a/api-ref/source/baremetal/v1/samples/nodes-list-response.json b/api-ref/source/baremetal/v1/samples/nodes-list-response.json deleted file mode 100644 index 8acb80205..000000000 --- a/api-ref/source/baremetal/v1/samples/nodes-list-response.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "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" - } - ] -} diff --git a/api-ref/src/docbkx/api-ref-baremetal-v1.xml b/api-ref/src/docbkx/api-ref-baremetal-v1.xml deleted file mode 100644 index f2429eba2..000000000 --- a/api-ref/src/docbkx/api-ref-baremetal-v1.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - OpenStack Bare Metal API v1 (CURRENT) - - 2016 - - - - - - - - - - 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 deleted file mode 100644 index a2e358a9a..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/baremetal-api-v1.wadl +++ /dev/null @@ -1,715 +0,0 @@ - - - - %common; - - %common_project; -]> - - - - - - - - - - - &chassis_uuidTemplateParameter; - - - - - - - - - &driver_nameTemplateParameter; - - - - - - - - - - - - - - - - - - - - - - &node_idTemplateParameter; - - - - - - - - - - - - - &port_idTemplateParameter; - - - - - - - - - - - - - - - - - Creates a chassis. - - - - - - - - &chassisRequestParameter; - &chassis-descriptionRequestParameter; - &chassis-extraRequestParameter; - - - - - - - - &created_at-ResponseParameter; - &chassis-descriptionResponseParameter; - &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 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 deleted file mode 100644 index d9ee4ff45..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/common.ent +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - - -'> - - - -'> - - - -'> - - - -'> - - - -'> - - - -'> - - - -'> - - - -'> - - - -'> - - - - - - - - - - - - - - - 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 node. - - -'> - - - - The UUID of the port. - - -'> - - - - - - - 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. - - -'> - - 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 deleted file mode 100644 index 56a95334d..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-create-request.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "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 deleted file mode 100644 index 034166cf5..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-details-response.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "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 deleted file mode 100644 index 034166cf5..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-response.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "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 deleted file mode 100644 index 124fff077..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-show-response.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "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 deleted file mode 100644 index 56a95334d..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-update-request.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "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 deleted file mode 100644 index d1053fb87..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/driver-get-response.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "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 deleted file mode 100644 index db387dc76..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/drivers-list-response.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "drivers": [ - { - "hosts": [ - "fake-host" - ], - "name": "sample-driver" - } - ] -} 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 deleted file mode 100644 index 34cc5f7de..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/node-show-response.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "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 deleted file mode 100644 index fd9a40da5..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/node-states-show-response.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "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-details-response.json b/api-ref/src/wadls/baremetal-api/src/v1/samples/nodes-list-details-response.json deleted file mode 100644 index 17487fd3c..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/nodes-list-details-response.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "nodes": [ - { - "chassis_uuid": "633f9f21-5bd5-4166-b811-1eb01490c4ab", - "clean_step": {}, - "console_enabled": false, - "created_at": "2016-04-23T10:52:43+00:00", - "driver": "pxe_ssh", - "driver_info": { - "deploy_kernel": "aadebece-ce44-4cf6-a9e8-545f0e8ac9f3", - "deploy_ramdisk": "cfe6f9ce-b2e6-4a7a-9246-0cc7eeb89a71", - "ssh_address": "localhost", - "ssh_key_filename": "/opt/stack/data/ironic/ssh_keys/ironic_key", - "ssh_port": 22, - "ssh_username": "ubuntu", - "ssh_virt_type": "virsh" - }, - "driver_internal_info": {}, - "extra": {}, - "inspection_finished_at": null, - "inspection_started_at": null, - "instance_info": {}, - "instance_uuid": null, - "last_error": null, - "links": [ - { - "href": "http://localhost:6385/v1/nodes/277c9fe9-a385-4e45-9399-660f3287e48c", - "rel": "self" - }, - { - "href": "http://localhost:6385/nodes/277c9fe9-a385-4e45-9399-660f3287e48c", - "rel": "bookmark" - } - ], - "maintenance": false, - "maintenance_reason": null, - "name": "node-0", - "ports": [ - { - "href": "http://localhost:6385/v1/nodes/277c9fe9-a385-4e45-9399-660f3287e48c/ports", - "rel": "self" - }, - { - "href": "http://localhost:6385/nodes/277c9fe9-a385-4e45-9399-660f3287e48c/ports", - "rel": "bookmark" - } - ], - "power_state": "power off", - "properties": { - "cpu_arch": "x86_64", - "cpus": 1, - "local_gb": 10, - "memory_mb": 1024 - }, - "provision_state": "available", - "provision_updated_at": null, - "reservation": null, - "target_power_state": null, - "target_provision_state": null, - "updated_at": "2016-04-23T10:53:37+00:00", - "uuid": "277c9fe9-a385-4e45-9399-660f3287e48c" - } - ] -} 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 deleted file mode 100644 index 8acb80205..000000000 --- a/api-ref/src/wadls/baremetal-api/src/v1/samples/nodes-list-response.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "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" - } - ] -} diff --git a/www/static/.htaccess b/www/static/.htaccess index 74acb2876..fde260a28 100644 --- a/www/static/.htaccess +++ b/www/static/.htaccess @@ -8,3 +8,5 @@ redirect 301 /api-ref-compute-v2.html /api-ref-compute-v2.1.html redirect 301 /api-ref-compute-v2-ext.html /api-ref-compute-v2.1.html # Redirect plural databases file name to database redirect 301 /api-ref-databases-v1.html /api-ref-database-v1.html +# Redirect WADL-based Bare Metal API docs to in-tree docs +redirect 301 /api-ref-baremetal-v1.html /api-ref/baremetal/index.html