134 lines
9.4 KiB
Plaintext
134 lines
9.4 KiB
Plaintext
|
|
<!--
|
|
A collection of common faults, these are pretty much expected
|
|
in every request.
|
|
-->
|
|
<!ENTITY commonFaults
|
|
'
|
|
<response xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:computeFault"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:serviceUnavailable"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:unauthorized"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:forbidden"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:badRequest"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="405" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:badMethod"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="413" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:overLimit"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!--
|
|
Faults on GET
|
|
-->
|
|
<!ENTITY getFaults
|
|
'
|
|
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:itemNotFound"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!--
|
|
Faults on POST/PUT
|
|
-->
|
|
<!ENTITY postPutFaults
|
|
'
|
|
<response status="415" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:badMediaType"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!--
|
|
Faults that can occur when we are building servers or images.
|
|
-->
|
|
<!ENTITY buildFaults
|
|
'
|
|
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:serverCapacityUnavailable"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!--
|
|
Holds build in progress which occurs when an operation fails
|
|
because the server is in the process of being built.
|
|
-->
|
|
<!ENTITY inProgressFault
|
|
'
|
|
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:buildInProgress"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
|
|
<!-- Image List Parameters -->
|
|
|
|
<!ENTITY imageListParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="changes-since" style="query" required="false" type="xsd:dateTime"><doc><p xmlns="http://www.w3.org/1999/xhtml">A time/date stamp for when the image last changed status.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="server" style="query" required="false" type="xsd:anyURI"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the server in URL format.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="query" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the image as a string.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="status" style="query" required="false" type="csapi:ImageStatus"><doc><p xmlns="http://www.w3.org/1999/xhtml">Value of the status of the image so that you can filter on "ACTIVE" for example.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="marker" style="query" required="false" type="csapi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">UUID of the image at which you want to set a marker.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the limit of values to return.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="type" style="query" required="false" type="xsd:string" default="ALL"><doc><p xmlns="http://www.w3.org/1999/xhtml">Value of the type of image, such as BASE, SERVER, or ALL.</p></doc>
|
|
<option value="BASE"/>
|
|
<option value="SERVER"/>
|
|
<option value="ALL"/>
|
|
</param>
|
|
'>
|
|
<!-- Server Create Parameters -->
|
|
<!ENTITY serverCreateParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_group" style="query" required="true" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The name of the security group. If blank, the server is created in the "default" security group.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="user_data" style="query" required="true" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Use to pass configuration information or scripts upon launch. Must be Base64 encoded.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="availability_zone" style="query" required="true" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The availability zone in which to launch the server.</p></doc></param>
|
|
'>
|
|
|
|
<!-- Server List Parameters -->
|
|
|
|
<!ENTITY serverListParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="changes-since" style="query" required="false" type="xsd:dateTime"><doc><p xmlns="http://www.w3.org/1999/xhtml">A time/date stamp for when the server last changed status.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="image" style="query" required="false" type="xsd:anyURI"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the image in URL format.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="flavor" style="query" required="false" type="xsd:anyURI"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the flavor in URL format.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="query" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the server as a string.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="marker" style="query" required="false" type="csapi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">UUID of the server at which you want to set a marker.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the limit of values to return.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="status" style="query" required="false" type="csapi:ServerStatus"><doc><p xmlns="http://www.w3.org/1999/xhtml">Value of the status of the server so that you can filter on "ACTIVE" for example.</p></doc></param>
|
|
'>
|
|
|
|
<!-- Flavor List Parameters -->
|
|
|
|
<!ENTITY flavorListParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="changes-since" style="query" required="false" type="xsd:dateTime"><doc><p xmlns="http://www.w3.org/1999/xhtml">A time/date stamp for when the flavor last changed.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="minDisk" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the minimum disk space in GB so you can filter results.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="minRam" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the minimum RAM so you can filter results.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="marker" style="query" required="false" type="csapi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">UUID of the flavor at which you want to set a marker.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the limit of values to return.</p></doc></param>
|
|
'>
|
|
|
|
<!-- Useful for describing APIs -->
|
|
|
|
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
|
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
|
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
|
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
|
|