openstack
/
api-site
Code Issues Proposed changes

Add Bare Metal API v1 

Add WADL and code samples

Source is docs.openstack.org/developer/ironic/webapi/v1.html
Focus on adding ironic only.

Unchenged from previous (from patch set 37)
  The name of the common query parameters
  The description of the timestamp paramters

Change-Id: I6dc432f226ee7cb47e27296487621f75d4483b25
Closes-Bug: #1482238
This commit is contained in:
Diane Fleming 2015-11-14 18:03:28 -06:00 committed by Atsushi SAKAI
parent 2ed1e8797b
commit f4af43e2e7
19 changed files with 1792 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
api-ref-guides/pom.xml
View File

@ -50,6 +50,17 @@
<pdfFilenameBase>api-ref</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-baremetal-v1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-baremetal-v1.xml </includes>
<pdfFilenameBase>api-ref-baremetal-v1</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-blockstorage-v2</id>
<goals>

13
api-ref/pom.xml
View File

@ -47,6 +47,17 @@
<pdfFilename>bk-api-ref</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-baremetal-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> api-ref-baremetal-v1.xml</includes>
<pdfFilename>bk-api-ref-baremetal-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-blockstorage-v2</id>
<goals>
@ -58,7 +69,7 @@
<pdfFilename>bk-api-ref-blockstorage-v2</pdfFilename>
</configuration>
</execution>
<execution>
<execution>
<id>os-api-ref-blockstorage-v1</id>
<goals>
<goal>generate-html</goal>

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

@ -0,0 +1,23 @@
<?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>

141
api-ref/src/docbkx/ch_baremetal-api-v1.xml Normal file
View File

@ -0,0 +1,141 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter 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="baremetal-api-v1"
role="api-reference">
<title>Bare Metal API v1 (CURRENT)</title>
<para>
Manages chassis, drivers, links, nodes, and ports for use with the
Bare Metal API, also known as ironic services.
</para>
<para>
Each Bare Metal API response returns the
<code>X-OpenStack-Ironic-API-Minimum-Version</code> and
<code>X-OpenStack-Ironic-API-Maximum-Version</code> headers, which
indicate, respectively, the minimum and maximum supported API versions
that the server supports.
</para>
<para>
The client can use the <code>X-OpenStack-Ironic-API-Version</code>
request header to request an API version. If the client does not
request an API version, the default is API v1.1, which is the minimum
supported version. The client has access to the features that the
requested API version supports. OpenStack recommends that clients
always request a specific version of API. However, you can request the
<code>latest</code> value, which always requests the most current,
supported API version.
</para>
<!-- <para>
When you create, list, or delete chassis, the following status values
are possible:
</para>
<itemizedlist spacing="compact">
<listitem><para>CREATING. The chassis is being created.</para></listitem>
<listitem><para>AVAILABLE. The chassis is ready to be attached to
an instance.</para></listitem>
<listitem><para>ATTACHING. The chassis is attaching to an
instance.</para></listitem>
<listitem><para>IN-USE. The chassis is attached to an
instance.</para></listitem>
<listitem><para>DELETING. The chassis is being deleted.</para></listitem>
<listitem><para>ERROR. An error has occurred with the
chassis.</para></listitem>
<listitem><para>ERROR_DELETING. There was an error deleting the
chassis.</para></listitem>
</itemizedlist> -->
<section xml:id="baremetal-api-v1-chassis">
<title>Chassis (chassis)</title>
<para>
Chassis operations.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#chassis">
<wadl:method href="#createChassis"/>
<wadl:method href="#listChassis"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#detail-chassis">
<wadl:method href="#listChassisDetail"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#chassis_id">
<wadl:method href="#showChassis"/>
<wadl:method href="#updateChassis"/>
<wadl:method href="#deleteChassis"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="baremetal-api-v1-drivers">
<title>Drivers (drivers)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#drivers">
<wadl:method href="#listDrivers"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#driver_name">
<wadl:method href="#showDriver"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#properties">
<wadl:method href="#showDriverProperties"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#logical_disk_properties">
<wadl:method href="#showLogicalDiskProperties"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#vendor_passthru-methods">
<wadl:method href="#showVendorMethods"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="baremetal-api-v1-links">
<title>Links (links)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#links">
<wadl:method href="#createLink"/>
<wadl:method href="#listLinks"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#detail-links">
<wadl:method href="#listLinksDetail"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#link_id">
<wadl:method href="#showLink"/>
<wadl:method href="#updateLink"/>
<wadl:method href="#deleteLink"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="baremetal-api-v1-nodes">
<title>Nodes (nodes)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#nodes">
<wadl:method href="#createNode"/>
<wadl:method href="#listNodes"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#detail-nodes">
<wadl:method href="#listNodesDetail"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#node_id">
<wadl:method href="#showNode"/>
<wadl:method href="#updateNode"/>
<wadl:method href="#deleteNode"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="baremetal-api-v1-ports">
<title>Ports (ports)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#ports">
<wadl:method href="#createPort"/>
<wadl:method href="#listPorts"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#detail-ports">
<wadl:method href="#listPortsDetail"/>
</wadl:resource>
<wadl:resource href="../wadls/baremetal-api/src/v1/baremetal-api-v1.wadl#port_id">
<wadl:method href="#showPort"/>
<wadl:method href="#updatePort"/>
<wadl:method href="#deletePort"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

5
api-ref/src/docbkx/itemizedlist-service-list.xml
View File

@ -5,6 +5,11 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:lang="EN" xml:id="service-list">
<listitem>
<para>
<link xlink:type="simple" xlink:href="api-ref-baremetal-v1.html">Bare Metal API v1 (CURRENT)</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:type="simple" xlink:href="api-ref-blockstorage-v2.html">Block Storage API v2 (CURRENT)</link>

897
api-ref/src/wadls/baremetal-api/src/v1/baremetal-api-v1.wadl Normal file
View File

@ -0,0 +1,897 @@
<?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="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<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="links" path="links">
<method href="#createLink"/>
<method href="#listLinks"/>
<resource path="detail" id="detail-links">
<method href="#listLinksDetail"/>
</resource>
<resource path="{link_id}" id="link_id">
&link_idTemplateParameter;
<method href="#showLink"/>
<method href="#updateLink"/>
<method href="#deleteLink"/>
</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>
</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;
&chassisResponseParameter;
&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>
<!-- ************************************** -->
<!-- Links -->
<!-- ************************************** -->
<!-- ************************************** -->
<!-- Create link -->
<!-- ************************************** -->
<method name="POST" id="createLink">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create link">
<para role="shortdesc">
Creates a link.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/link-create-request.json"/>
</wadl:doc>
&link-hrefRequestParameter;
&link-relRequestParameter;
&link-typeRequestParameter;
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/link-show-response.json"/>
</wadl:doc>
&link-hrefResponseParameter;
&link-relResponseParameter;
&link-typeResponseParameter;
</representation>
</response>
&postPutDeleteFaults;
</method>
<!-- ************************************** -->
<!-- List all Links -->
<!-- ************************************** -->
<method name="GET" id="listLinks">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List links">
<para role="shortdesc">
Lists all links.
</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/link-show-response.json"/>
</wadl:doc>
&link-hrefResponseParameter;
&link-relResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- List all links with details -->
<!-- ************************************** -->
<method name="GET" id="listLinksDetail">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List links with details">
<para role="shortdesc">
Lists all links with details.
</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/link-show-response.json"/>
</wadl:doc>
&link-hrefResponseParameter;
&link-relResponseParameter;
&link-typeResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Show link details -->
<!-- ************************************** -->
<method name="GET" id="showLink">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show link details">
<para role="shortdesc">
Shows details for a link.
</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/link-show-response.json"/>
</wadl:doc>
&link-hrefResponseParameter;
&link-relResponseParameter;
&link-typeResponseParameter;
</representation>
</response>
&getFaults;
</method>
<!-- ************************************** -->
<!-- Update link -->
<!-- ************************************** -->
<method name="PATCH" id="updateLink">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Update link">
<para role="shortdesc">
Updates a link.
</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/link-create-request.json"
/>
</xsdxt:sample>
</wadl:doc>
&link-hrefRequestParameter;
&link-relRequestParameter;
&link-typeRequestParameter;
</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/link-show-response.json"
/>
</xsdxt:sample>
</wadl:doc>
&link-hrefResponseParameter;
&link-relResponseParameter;
&link-typeResponseParameter;
</representation>
</response>
&postPutDeleteFaults;
</method>
<!-- ************************************** -->
<!-- Delete link -->
<!-- ************************************** -->
<method name="DELETE" id="deleteLink">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Delete link">
<para role="shortdesc">
Deletes a link.
</para>
</wadl:doc>
<response status="204"/>
&postPutDeleteFaults;
</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/driver-list-response.json"/>
</wadl:doc>
&driverResponseParameter;
&driver-descriptionResponseParameter;
&driver-extraResponseParameter;
&driver-uuidResponseParameter;
</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/driver-list-details-response.json"/>
</wadl:doc>
&driverResponseParameter;
&driver-descriptionResponseParameter;
&driver-extraResponseParameter;
&driver-uuidResponseParameter;
</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/driver-list-details-response.json"/>
</wadl:doc>
&driverResponseParameter;
&driver-descriptionResponseParameter;
&driver-extraResponseParameter;
&driver-uuidResponseParameter;
</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>

506
api-ref/src/wadls/baremetal-api/src/v1/common.ent Normal file
View File

@ -0,0 +1,506 @@
<!-- ************************************ -->
<!-- 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 link_idTemplateParameter '
<param name="link_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 link.
</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>'>
<!ENTITY tenant_idTemplateParameter '
<param name="tenant_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 tenant ID in a multi-tenancy cloud.
</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: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>
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>'>
<!-- ************************************ -->
<!-- LINKS -->
<!-- ************************************ -->
<!-- LINKS REQUEST PARAMETERS -->
<!-- ************************************ -->
<!ENTITY link-hrefRequestParameter '
<param name="href" 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 URL of a link.
</para>
</wadl:doc>
</param>'>
<!ENTITY link-relRequestParameter '
<param name="rel" 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 a link.
</para>
</wadl:doc>
</param>'>
<!ENTITY link-typeRequestParameter '
<param name="type" 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 type of document and link.
</para>
</wadl:doc>
</param>'>
<!-- ************************************ -->
<!-- LINKS RESPONSE PARAMETERS -->
<!-- ************************************ -->
<!ENTITY link-hrefResponseParameter '
<param name="href" 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 URL of a link.
</para>
</wadl:doc>
</param>'>
<!ENTITY link-relResponseParameter '
<param name="rel" 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 a link.
</para>
</wadl:doc>
</param>'>
<!ENTITY link-typeResponseParameter '
<param name="type" 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 type of document and link.
</para>
</wadl:doc>
</param>'>

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

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

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

@ -0,0 +1,18 @@
{
"chassis": [
{
"description": "Sample chassis",
"links": [
{
"href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "self"
},
{
"href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "bookmark"
}
],
"uuid": "eaaca217-e7d8-47b4-bb41-3f99f20eed89"
}
]
}

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

@ -0,0 +1,18 @@
{
"chassis": [
{
"description": "Sample chassis",
"links": [
{
"href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "self"
},
{
"href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "bookmark"
}
],
"uuid": "eaaca217-e7d8-47b4-bb41-3f99f20eed89"
}
]
}

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

@ -0,0 +1,27 @@
{
"created_at": "2000-01-01T12:00:00",
"description": "Sample chassis",
"extra": {},
"links": [
{
"href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "self"
},
{
"href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "bookmark"
}
],
"nodes": [
{
"href": "http://localhost:6385/v1/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89/nodes",
"rel": "self"
},
{
"href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89/nodes",
"rel": "bookmark"
}
],
"updated_at": "2000-01-01T12:00:00",
"uuid": "eaaca217-e7d8-47b4-bb41-3f99f20eed89"
}

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

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

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

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

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

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

4
api-ref/src/wadls/baremetal-api/src/v1/samples/link-create-request.json Normal file
View File

@ -0,0 +1,4 @@
{
"href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "bookmark"
}

4
api-ref/src/wadls/baremetal-api/src/v1/samples/link-show-response.json Normal file
View File

@ -0,0 +1,4 @@
{
"href": "http://localhost:6385/chassis/eaaca217-e7d8-47b4-bb41-3f99f20eed89",
"rel": "bookmark"
}

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

@ -0,0 +1,63 @@
{
"chassis_uuid": "edcad704-b2da-41d5-96d9-afd580ecfa12",
"clean_step": {},
"console_enabled": false,
"created_at": "2000-01-01T12:00:00",
"driver": "fake",
"driver_info": {},
"driver_internal_info": {},
"extra": {},
"inspection_finished_at": null,
"inspection_started_at": "2000-01-01T12:00:00",
"instance_info": {},
"instance_uuid": "dcf1fbc5-93fc-4596-9395-b80572f6267b",
"last_error": null,
"links": [
{
"href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123",
"rel": "self"
},
{
"href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123",
"rel": "bookmark"
}
],
"maintenance": false,
"maintenance_reason": null,
"name": "database16-dc02",
"ports": [
{
"href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/ports",
"rel": "self"
},
{
"href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/ports",
"rel": "bookmark"
}
],
"power_state": "power on",
"properties": {
"cpus": "1",
"local_gb": "10",
"memory_mb": "1024"
},
"provision_state": "active",
"provision_updated_at": "2000-01-01T12:00:00",
"raid_config": null,
"reservation": null,
"states": [
{
"href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/states",
"rel": "self"
},
{
"href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123/states",
"rel": "bookmark"
}
],
"target_power_state": null,
"target_provision_state": null,
"target_raid_config": null,
"updated_at": "2000-01-01T12:00:00",
"uuid": "1be26c0b-03f2-4d2e-ae87-c02d7f33c123"
}

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

@ -0,0 +1,11 @@
{
"console_enabled": false,
"last_error": null,
"power_state": "power on",
"provision_state": null,
"provision_updated_at": null,
"raid_config": null,
"target_power_state": "power on",
"target_provision_state": "active",
"target_raid_config": null
}

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

@ -0,0 +1,22 @@
{
"nodes": [
{
"instance_uuid": "dcf1fbc5-93fc-4596-9395-b80572f6267b",
"links": [
{
"href": "http://localhost:6385/v1/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123",
"rel": "self"
},
{
"href": "http://localhost:6385/nodes/1be26c0b-03f2-4d2e-ae87-c02d7f33c123",
"rel": "bookmark"
}
],
"maintenance": false,
"name": "database16-dc02",
"power_state": "power on",
"provision_state": "active",
"uuid": "1be26c0b-03f2-4d2e-ae87-c02d7f33c123"
}
]
}