openstack/api-site
Code Issues Proposed changes

Use in-tree baremetal api-ref rather than WADL

Browse Source 
The api-ref docs in the ironic tree are more up to date, and should be
linked to instead of the existing wadl docs. Redirect all requests for
these docs into the new location.

Additionally, remove the outdated, incorrect WADL based docs from the
tree.

Change-Id: I693560990abe2f63705406d14000c917950647e7
This commit is contained in:
Jay Faulkner 2016-06-08 15:24:21 -07:00
parent e466ebd286
commit 91302a622f
31 changed files with 2 additions and 2859 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

305
api-ref/source/baremetal/v1/baremetal-api-v1-chassis.inc
View File

@ -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

244
api-ref/source/baremetal/v1/baremetal-api-v1-drivers.inc
View File

@ -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

222
api-ref/source/baremetal/v1/baremetal-api-v1-nodes.inc
View File

@ -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

222
api-ref/source/baremetal/v1/baremetal-api-v1-ports.inc
View File

@ -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

209
api-ref/source/baremetal/v1/parameters.yaml
View File

@ -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
<https://en.wikipedia.org/wiki/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
<https://en.wikipedia.org/wiki/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

7
api-ref/source/baremetal/v1/samples/chassis-create-request.json
View File

@ -1,7 +0,0 @@
{
"chassis": [
{
"description": "Sample chassis"
}
]
}

18
api-ref/source/baremetal/v1/samples/chassis-list-details-response.json
View File

@ -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"
}
]
}

18
api-ref/source/baremetal/v1/samples/chassis-list-response.json
View File

@ -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"
}
]
}

27
api-ref/source/baremetal/v1/samples/chassis-show-response.json
View File

@ -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"
}

7
api-ref/source/baremetal/v1/samples/chassis-update-request.json
View File

@ -1,7 +0,0 @@
{
"chassis": [
{
"description": "Sample chassis"
}
]
}

6
api-ref/source/baremetal/v1/samples/driver-get-response.json
View File

@ -1,6 +0,0 @@
{
"hosts": [
"fake-host"
],
"name": "sample-driver"
}

10
api-ref/source/baremetal/v1/samples/drivers-list-response.json
View File

@ -1,10 +0,0 @@
{
"drivers": [
{
"hosts": [
"fake-host"
],
"name": "sample-driver"
}
]
}

63
api-ref/source/baremetal/v1/samples/node-show-response.json
View File

@ -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"
}

11
api-ref/source/baremetal/v1/samples/node-states-show-response.json
View File

@ -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
}

64
api-ref/source/baremetal/v1/samples/nodes-list-details-response.json
View File

@ -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"
}
]
}

22
api-ref/source/baremetal/v1/samples/nodes-list-response.json
View File

@ -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"
}
]
}

23
api-ref/src/docbkx/api-ref-baremetal-v1.xml
View File

@ -1,23 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-baremetal-v1" status="CURRENT">
<info xreflabel="api-ref-baremetal-v1.html">
<title>OpenStack Bare Metal API v1 (CURRENT)</title>
<copyright>
<year>2016</year>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_baremetal-api-v1.xml"/>
</book>

715
api-ref/src/wadls/baremetal-api/src/v1/baremetal-api-v1.wadl
View File

@ -1,715 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/api/openstack-baremetal/v1"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend">
<resources base="https://ironic.example.com/" xml:id="baremetal-v1">
<resource id="v1" path="//v1">
<resource id="chassis" path="chassis">
<method href="#createChassis"/>
<method href="#listChassis"/>
<resource path="detail" id="detail-chassis">
<method href="#listChassisDetail"/>
</resource>
<resource path="{chassis_id}" id="chassis_id">
&chassis_uuidTemplateParameter;
<method href="#showChassis"/>
<method href="#updateChassis"/>
<method href="#deleteChassis"/>
</resource>
</resource>
<resource id="drivers" path="drivers">
<method href="#listDrivers"/>
<resource path="{driver_name}" id="driver_name">
&driver_nameTemplateParameter;
<method href="#showDriver"/>
<resource path="properties" id="properties">
<method href="#showDriverProperties"/>
</resource>
<resource path="raid" id="raid">
<resource path="logical_disk_properties" id="logical_disk_properties">
<method href="#showLogicalDiskProperties"/>
</resource>
</resource>
<resource path="vendor_passthru/methods" id="vendor_passthru-methods">
<method href="#showVendorMethods"/>
</resource>
</resource>
</resource>
<resource id="nodes" path="nodes">
<method href="#createNode"/>
<method href="#listNodes"/>
<resource path="detail" id="detail-nodes">
<method href="#listNodesDetail"/>
</resource>
<resource path="{node_id}" id="node_id">
&node_idTemplateParameter;
<method href="#showNode"/>
<method href="#updateNode"/>
<method href="#deleteNode"/>
</resource>
</resource>
<resource id="ports" path="ports">
<method href="#createPort"/>
<method href="#listPorts"/>
<resource path="detail" id="detail-ports">
<method href="#listPortsDetail"/>
</resource>
<resource path="{port_id}" id="port_id">
&port_idTemplateParameter;
<method href="#showPort"/>
<method href="#updatePort"/>
<method href="#deletePort"/>
</resource>
</resource>
</resource>
</resources>
<!-- ************************************** -->
<!-- Chassis -->
<!-- ************************************** -->
<!-- ************************************** -->
<!-- Create chassis -->
<!-- ************************************** -->
<method name="POST" id="createChassis">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create chassis">
<para role="shortdesc">
Creates a chassis.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/chassis-create-request.json"/>
</wadl:doc>
&chassisRequestParameter;
&chassis-descriptionRequestParameter;
&chassis-extraRequestParameter;
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/chassis-show-response.json"/>
</wadl:doc>
&created_at-ResponseParameter;
&chassis-descriptionResponseParameter;
&chassis-extraResponseParameter;
&chassis-linksResponseParameter;
&chassis-nodesResponseParameter;
&updated_at-ResponseParameter;
&chassis-uuidResponseParameter;
</representation>
</response>
&postPutDeleteFaults;
</method>
<!-- ************************************** -->
<!-- List all chassis -->
<!-- ************************************** -->
<method name="GET" id="listChassis">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List chassis">
<para role="shortdesc">
Lists all chassis.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&limitMarkerReqParameter;
&sort_dirQueryParameter;
&sort_keyQueryParameter;
&fieldsQueryParameter;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/chassis-list-response.json"/>
</wadl:doc>
&chassisResponseParameter;
&chassis-descriptionResponseParameter;
&chassis-extraResponseParameter;
&chassis-uuidResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- List all chassis with details -->
<!-- ************************************** -->
<method name="GET" id="listChassisDetail">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List chassis with details">
<para role="shortdesc">
Lists all chassis with details.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&limitMarkerReqParameter;
&sort_dirQueryParameter;
&sort_keyQueryParameter;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/chassis-list-details-response.json"/>
</wadl:doc>
&chassisResponseParameter;
&chassis-descriptionResponseParameter;
&chassis-extraResponseParameter;
&chassis-uuidResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Show chassis details -->
<!-- ************************************** -->
<method name="GET" id="showChassis">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show chassis details">
<para role="shortdesc">
Shows details for a chassis.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&fieldsQueryParameter;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/chassis-show-response.json"/>
</wadl:doc>
&chassisResponseParameter;
&chassis-descriptionResponseParameter;
&chassis-extraResponseParameter;
&chassis-uuidResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Update chassis -->
<!-- ************************************** -->
<method name="PATCH" id="updateChassis">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Update chassis">
<para role="shortdesc">
Updates a chassis.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:sample>
<xsdxt:code
href="samples/chassis-update-request.json"
/>
</xsdxt:sample>
</wadl:doc>
&chassisRequestParameter;
&chassis-descriptionRequestParameter;
&chassis-extraRequestParameter;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:sample>
<xsdxt:code
href="samples/chassis-show-response.json"
/>
</xsdxt:sample>
</wadl:doc>
&created_at-ResponseParameter;
&chassis-descriptionResponseParameter;
&chassisResponseParameter;
&chassis-extraResponseParameter;
&chassis-linksResponseParameter;
&chassis-nodesResponseParameter;
&updated_at-ResponseParameter;
&chassis-uuidResponseParameter;
</representation>
</response> &postPutDeleteFaults;
</method>
<!-- ************************************** -->
<!-- Delete chassis -->
<!-- ************************************** -->
<method name="DELETE" id="deleteChassis">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Delete chassis">
<para role="shortdesc">
Deletes a chassis.
</para>
</wadl:doc>
<response status="204"/>
&postPutDeleteFaults;
</method>
<!-- ************************************** -->
<!-- Drivers -->
<!-- ************************************** -->
<!-- ************************************** -->
<!-- List all drivers -->
<!-- ************************************** -->
<method name="GET" id="listDrivers">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="List drivers">
<para role="shortdesc">
Lists all drivers.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/drivers-list-response.json"/>
</wadl:doc>
&driversResponseParameter;
&hostsResponseParameter;
&host-nameResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Show driver details -->
<!-- ************************************** -->
<method name="GET" id="showDriver">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show driver details">
<para role="shortdesc">
Shows details for a driver.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-get-response.json"/>
</wadl:doc>
&hostsResponseParameter;
&host-nameResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Shows properties for a driver -->
<!-- ************************************** -->
<method name="GET" id="showDriverProperties">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show driver properties">
<para role="shortdesc">
Shows properties for a driver.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-get-response.json"/>
</wadl:doc>
&hostsResponseParameter;
&host-linksResponseParameter;
&host-nameResponseParameter;
&host-propertiesResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ******************************************* -->
<!-- Shows logical disk properties for a driver -->
<!-- ******************************************* -->
<method name="GET" id="showLogicalDiskProperties">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show driver logical disk properties">
<para role="shortdesc">
Shows logical disk properties for a driver.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-get-response.json"/>
</wadl:doc>
&hostsResponseParameter;
&host-linksResponseParameter;
&host-nameResponseParameter;
&host-propertiesResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Shows vendor methods for a driver -->
<!-- ************************************** -->
<method name="GET" id="showVendorMethods">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show driver vendor methods">
<para role="shortdesc">
Shows vendor methods for a driver.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-get-response.json"/>
</wadl:doc>
&hostsResponseParameter;
&host-linksResponseParameter;
&host-nameResponseParameter;
&host-propertiesResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Nodes -->
<!-- ************************************** -->
<!-- ************************************** -->
<!-- Create node -->
<!-- ************************************** -->
<method name="POST" id="createNode">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create node">
<para role="shortdesc">
Creates a node.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<!-- <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-create-request.json"/>
</wadl:doc> -->
<!-- &driverRequestParameter;
&driver-descriptionRequestParameter;
&driver-extraRequestParameter; -->
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<!-- <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-create-response.json"/>
</wadl:doc> -->
<!-- &created_at-ResponseParameter;
&driver-descriptionResponseParameter;
&driverResponseParameter;
&driver-extraResponseParameter;
&driver-linksResponseParameter;
&driver-nodesResponseParameter;
&updated_at-ResponseParameter;
&driver-uuidResponseParameter; -->
</representation>
</response>
&postPutDeleteFaults;
</method>
<!-- ************************************** -->
<!-- List all nodes -->
<!-- ************************************** -->
<method name="GET" id="listNodes">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List nodes">
<para role="shortdesc">
Lists all nodes.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<!-- &limitMarkerQueryParameters;
&sort_dirQueryParameter;
&sort_keyQueryParameter;
&fieldsQueryParameter; -->
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/nodes-list-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- List all nodes with details -->
<!-- ************************************** -->
<method name="GET" id="listNodesDetail">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List nodes with details">
<para role="shortdesc">
Lists all nodes with details.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<!-- &limitMarkerQueryParameters;
&sort_dirQueryParameter;
&sort_keyQueryParameter; -->
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/nodes-list-details-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Show node details -->
<!-- ************************************** -->
<method name="GET" id="showNode">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show node details">
<para role="shortdesc">
Shows details for a node.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&fieldsQueryParameter;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/node-show-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Update node -->
<!-- ************************************** -->
<method name="PATCH" id="updateNode">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Update node">
<para role="shortdesc">
Updates a node.
</para>
</wadl:doc>
<request>
<!-- <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:sample>
<xsdxt:code
href="../samples/driver-update-request.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation> -->
</request>
<response status="200">
<!-- <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:sample>
<xsdxt:code
href="samples/driver-create-response.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation> -->
</response> &postPutDeleteFaults;
</method>
<!-- ************************************** -->
<!-- Delete node -->
<!-- ************************************** -->
<method name="DELETE" id="deleteNode">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Delete node">
<para role="shortdesc">
Deletes a node.
</para>
</wadl:doc>
<response status="204"/>
&postPutDeleteFaults;
</method>
<!-- ************************************** -->
<!-- Ports -->
<!-- ************************************** -->
<!-- ************************************** -->
<!-- Create port -->
<!-- ************************************** -->
<method name="POST" id="createPort">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create port">
<para role="shortdesc">
Creates a port.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<!-- <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-create-request.json"/>
</wadl:doc> -->
<!-- &driverRequestParameter;
&driver-descriptionRequestParameter;
&driver-extraRequestParameter; -->
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<!-- <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-create-response.json"/>
</wadl:doc> -->
<!-- &created_at-ResponseParameter;
&driver-descriptionResponseParameter;
&driverResponseParameter;
&driver-extraResponseParameter;
&driver-linksResponseParameter;
&driver-nodesResponseParameter;
&updated_at-ResponseParameter;
&driver-uuidResponseParameter; -->
</representation>
</response>
&postPutDeleteFaults;
</method>
<!-- ************************************** -->
<!-- List all Ports -->
<!-- ************************************** -->
<method name="GET" id="listPorts">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List ports">
<para role="shortdesc">
Lists all ports.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<!-- &limitMarkerQueryParameters;
&sort_dirQueryParameter;
&sort_keyQueryParameter;
&fieldsQueryParameter; -->
</representation>
</request>
<response status="200">
<!-- <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-list-response.json"/>
</wadl:doc>
&driverResponseParameter;
&driver-descriptionResponseParameter;
&driver-extraResponseParameter;
&driver-uuidResponseParameter;
</representation> -->
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- List all ports with details -->
<!-- ************************************** -->
<method name="GET" id="listPortsDetail">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List ports with details">
<para role="shortdesc">
Lists all ports with details.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<!-- &limitMarkerQueryParameters;
&sort_dirQueryParameter;
&sort_keyQueryParameter; -->
</representation>
</request>
<response status="200">
<!-- <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-list-details-response.json"/>
</wadl:doc>
&driverResponseParameter;
&driver-descriptionResponseParameter;
&driver-extraResponseParameter;
&driver-uuidResponseParameter;
</representation> -->
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Show port details -->
<!-- ************************************** -->
<method name="GET" id="showPort">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show port details">
<para role="shortdesc">
Shows details for a port.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&fieldsQueryParameter;
</representation>
</request>
<response status="200">
<!-- <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/driver-list-details-response.json"/>
</wadl:doc>
&driverResponseParameter;
&driver-descriptionResponseParameter;
&driver-extraResponseParameter;
&driver-uuidResponseParameter;
</representation> -->
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Update port -->
<!-- ************************************** -->
<method name="PATCH" id="updatePort">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Update port">
<para role="shortdesc">
Updates a port.
</para>
</wadl:doc>
<request>
<!-- <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:sample>
<xsdxt:code
href="../samples/driver-update-request.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation> -->
</request>
<response status="200">
<!-- <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:sample>
<xsdxt:code
href="samples/driver-create-response.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation> -->
</response> &postPutDeleteFaults;
</method>
<!-- ************************************** -->
<!-- Delete port -->
<!-- ************************************** -->
<method name="DELETE" id="deletePort">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Delete port">
<para role="shortdesc">
Deletes a port.
</para>
</wadl:doc>
<response status="204"/>
&postPutDeleteFaults;
</method>
</application>

413
api-ref/src/wadls/baremetal-api/src/v1/common.ent
View File

@ -1,413 +0,0 @@
<!-- ************************************ -->
<!-- FAULTS -->
<!-- ************************************ -->
<!-- A collection of common faults, these are pretty much expected in every request. -->
<!ENTITY fault400 '
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badRequest"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault401 '
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:unauthorized"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault403 '
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:forbidden"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault404 '
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:itemNotFound"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault405 '
<response status="405" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMethod"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault409 '
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:conflict"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault413 '
<response status="413" xmlns="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api" rax:phrase="Request Entity Too Large">
<representation mediaType="application/xml" element="csapi:overLimit"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault415 '
<response status="415" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMediaType"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault503 '
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serverCapacityUnavailable"/>
<representation mediaType="application/json"/>
</response>'>
<!-- ************************************** -->
<!-- Faults on GET - includes common faults -->
<!-- ************************************** -->
<!ENTITY getFaults '
&fault400;
&fault401;
&fault403;
&fault404;
&fault405;
&fault413;
&fault503;'>
<!-- ******************************************* -->
<!-- Faults on POST/PUT - includes common faults -->
<!-- ******************************************* -->
<!ENTITY postPutDeleteFaults '
&fault400;
&fault401;
&fault403;
&fault404;
&fault405;
&fault409;
&fault413;
&fault415;
&fault503;'>
<!-- *************************************** -->
<!-- REQUEST HEADERS -->
<!-- *************************************** -->
<!ENTITY AcceptRequestHeader '
<param xmlns="http://wadl.dev.java.net/2009/02" name="Accept"
style="header" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
A list of one or more representation schemes that are accepted in
the response to this request. Use the semicolon (<code>;</code>) character to
separate multiple schemes. See <link
xlink:href="http://www.w3.org/Protocols/HTTP/HTRQ_Headers.html#z3">Accept</link>.
</para>
<para>
(Since v3.3) If the <code>Accept</code> request header value is
<code>application/json-home</code>, the call returns a <link
xlink:href="http://tools.ietf.org/html/draft-nottingham-json-home-00">JSON
Home document</link>. The JSON Home document includes all core
components and the resources for any enabled extensions and excludes
the resources for disabled extensions.
</para>
<para>
Note that the client must check the <code>Content-Type</code>
header value in the response because earlier servers return a
normal JSON response rather than a JSON Home document.
</para>
</wadl:doc>
</param>'>
<!ENTITY authTokenHeader '
<param name="X-Auth-Token" style="header"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
A valid authentication token for an administrative user.
</para>
</wadl:doc>
</param>'>
<!ENTITY subjectTokenRequestHeader '
<param name="X-Subject-Token" style="header"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The authentication token for which you want to perform the
operation.
</para>
</wadl:doc>
</param>'>
<!-- ************************************ -->
<!-- RESPONSE HEADERS -->
<!-- ************************************ -->
<!ENTITY subjectTokenResponseHeader '
<param name="X-Subject-Token" style="header"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The authentication token.
</para>
<para>
An authentication response returns the token ID in this header
rather than in the response body.
</para>
</wadl:doc>
</param>'>
<!-- ************************************ -->
<!-- TEMPLATE PARAMETERS -->
<!-- ************************************ -->
<!ENTITY chassis_uuidTemplateParameter '
<param name="chassis_uuid"
style="template" required="true" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the chassis.
</para>
</wadl:doc>
</param>'>
<!ENTITY driver_nameTemplateParameter '
<param name="driver_name"
style="template" required="true" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The name of the driver.
</para>
</wadl:doc>
</param>'>
<!ENTITY node_idTemplateParameter '
<param name="node_id"
style="template" required="true" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the node.
</para>
</wadl:doc>
</param>'>
<!ENTITY port_idTemplateParameter '
<param name="port_id"
style="template" required="true" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the port.
</para>
</wadl:doc>
</param>'>
<!-- ************************************ -->
<!-- QUERY PARAMETERS -->
<!-- ************************************ -->
<!ENTITY descriptionQueryParameter '
<param name="description" style="query"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Filters the response by a description.
</para>
</wadl:doc>
</param>'>
<!ENTITY fieldsQueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="fields" type="xsd:list" style="query">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
One or more chassis fields to be returned in the response.
</para>
<para>
For example, the following request returns only the
<code>description</code> field for each chassis:
</para>
<programlisting>GET /v1/chassis?fields=description</programlisting>
</wadl:doc>
</param>'>
<!ENTITY sort_keyQueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_key"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Sorts the response by the this attribute value. Default is
<code>id</code>. 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 <code>sort_key</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY sort_dirQueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_dir"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Sorts the response by the requested sort direction. A valid value
is <code>asc</code> (ascending) or <code>desc</code> (descending).
Default is <code>asc</code>. 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
<code>sort_key</code>.
</para>
</wadl:doc>
</param>'>
<!-- ************************************ -->
<!-- CHASSIS -->
<!-- ************************************ -->
<!-- CHASSIS REQUEST PARAMETERS -->
<!-- ************************************ -->
<!ENTITY chassisRequestParameter '
<param name="chassis" style="plain" required="true"
type="xsd:list" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
A <code>chassis</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY chassis-descriptionRequestParameter '
<param name="description" style="plain" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02" required="false">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A description for the chassis.
</para>
</wadl:doc>
</param>'>
<!ENTITY chassis-extraRequestParameter '
<param name="extra" style="plain" type="xsd:dict"
xmlns="http://wadl.dev.java.net/2009/02" required="false">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A set of one or more arbitrary metadata key and value pairs for
the chassis.
</para>
</wadl:doc>
</param>'>
<!-- ************************************ -->
<!-- CHASSIS RESPONSE PARAMETERS -->
<!-- ************************************ -->
<!ENTITY chassisResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="chassis" style="plain" required="true" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
A list of chassis objects.
</para>
</wadl:doc>
</param>'>
<!ENTITY chassis-descriptionResponseParameter '
<param name="description" style="plain" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A description for the chassis.
</para>
</wadl:doc>
</param>'>
<!ENTITY chassis-extraResponseParameter '
<param name="extra" style="plain" type="xsd:dict"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A set of zero or more arbitrary metadata key and value pairs for
the chassis.
</para>
</wadl:doc>
</param>'>
<!ENTITY chassis-linksResponseParameter '
<param name="links" style="plain" type="xsd:list"
xmlns="http://wadl.dev.java.net/2009/02"
required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
A list that contains a self link and associated chassis links.
</para>
</wadl:doc>
</param>'>
<!ENTITY chassis-nodesResponseParameter '
<param name="nodes" style="plain" type="xsd:list"
xmlns="http://wadl.dev.java.net/2009/02"
required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Links to the collection of nodes contained in this chassis.
</para>
</wadl:doc>
</param>'>
<!ENTITY chassis-uuidResponseParameter '
<param name="uuid" style="plain" type="csapi:uuid"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The UUID for the chassis.
</para>
</wadl:doc>
</param>'>
<!-- ************************************ -->
<!-- DRIVERS -->
<!-- ************************************ -->
<!-- DRIVERS RESPONSE PARAMETERS -->
<!-- ************************************ -->
<!ENTITY driversResponseParameter '
<param name="drivers" style="plain" type="xsd:list"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A list of <code>drivers</code> objects.
</para>
</wadl:doc>
</param>'>
<!ENTITY hostsResponseParameter '
<param name="hosts" style="plain" type="xsd:list"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A list of active hosts that support this driver.
</para>
</wadl:doc>
</param>'>
<!ENTITY host-linksResponseParameter '
<param name="links" style="plain" type="xsd:list"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A list of relative links. Includes the self and bookmark links.
</para>
</wadl:doc>
</param>'>
<!ENTITY host-nameResponseParameter '
<param name="name" style="plain" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The name of the driver.
</para>
</wadl:doc>
</param>'>
<!ENTITY host-propertiesResponseParameter '
<param name="properties" style="plain" type="xsd:list"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A list of links to driver properties.
</para>
</wadl:doc>
</param>'>

7
api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-create-request.json
View File

@ -1,7 +0,0 @@
{
"chassis": [
{
"description": "Sample chassis"
}
]
}

18
api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-details-response.json
View File

@ -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"
}
]
}

18
api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-list-response.json
View File

@ -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"
}
]
}

27
api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-show-response.json
View File

@ -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"
}

7
api-ref/src/wadls/baremetal-api/src/v1/samples/chassis-update-request.json
View File

@ -1,7 +0,0 @@
{
"chassis": [
{
"description": "Sample chassis"
}
]
}

6
api-ref/src/wadls/baremetal-api/src/v1/samples/driver-get-response.json
View File

@ -1,6 +0,0 @@
{
"hosts": [
"fake-host"
],
"name": "sample-driver"
}

10
api-ref/src/wadls/baremetal-api/src/v1/samples/drivers-list-response.json
View File

@ -1,10 +0,0 @@
{
"drivers": [
{
"hosts": [
"fake-host"
],
"name": "sample-driver"
}
]
}

63
api-ref/src/wadls/baremetal-api/src/v1/samples/node-show-response.json
View File

@ -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"
}

11
api-ref/src/wadls/baremetal-api/src/v1/samples/node-states-show-response.json
View File

@ -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
}

64
api-ref/src/wadls/baremetal-api/src/v1/samples/nodes-list-details-response.json
View File

@ -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"
}
]
}

22
api-ref/src/wadls/baremetal-api/src/v1/samples/nodes-list-response.json
View File

@ -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"
}
]
}

2
www/static/.htaccess
View File

@ -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