neutron/doc/source/docbkx/quantum-api-1.0/common.ent

     <!--
         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="osapi:computeFault"/>
            <representation mediaType="application/json"/>
        </response>
        <response status="503" xmlns="http://wadl.dev.java.net/2009/02">
            <representation mediaType="application/xml" element="osapi:serviceUnavailable"/>
            <representation mediaType="applicaiton/json"/>
        </response>
        <response status="401" xmlns="http://wadl.dev.java.net/2009/02">
            <representation mediaType="application/xml" element="osapi:unauthorized"/>
            <representation mediaType="applicaiton/json"/>
        </response>
        <response status="403" xmlns="http://wadl.dev.java.net/2009/02">
            <representation mediaType="application/xml" element="osapi:forbidden"/>
            <representation mediaType="applicaiton/json"/>
        </response>
        <response status="400" xmlns="http://wadl.dev.java.net/2009/02">
            <representation mediaType="application/xml" element="osapi:badRequest"/>
            <representation mediaType="applicaiton/json"/>
        </response>
        <response status="405" xmlns="http://wadl.dev.java.net/2009/02">
            <representation mediaType="application/xml" element="osapi:badMethod"/>
            <representation mediaType="applicaiton/json"/>
        </response>
        <response status="413" xmlns="http://wadl.dev.java.net/2009/02">
            <representation mediaType="application/xml" element="osapi:overLimit"/>
            <representation mediaType="applicaiton/json"/>
        </response>
           '>
      <!--
          Faults on GET
      -->
     <!ENTITY getFaults
           '
        <response status="404" xmlns="http://wadl.dev.java.net/2009/02">
            <representation mediaType="application/xml" element="osapi:itemNotFound"/>
            <representation mediaType="applicaiton/json"/>
        </response>
           '>
      <!--
          Faults on POST/PUT
      -->
     <!ENTITY postPutFaults
           '
        <response status="415" xmlns="http://wadl.dev.java.net/2009/02">
            <representation mediaType="application/xml" element="osapi:badMediaType"/>
            <representation mediaType="applicaiton/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="osapi:serverCapacityUnavailable"/>
            <representation mediaType="applicaiton/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="osapi:buildInProgress"/>
            <representation mediaType="applicaiton/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"/>
            <param xmlns="http://wadl.dev.java.net/2009/02" name="server" style="query" required="false" type="xsd:anyURI"/>
            <param xmlns="http://wadl.dev.java.net/2009/02" name="name"   style="query" required="false" type="xsd:string"/>
            <param xmlns="http://wadl.dev.java.net/2009/02" name="status" style="query" required="false" type="osapi:ImageStatus"/>
            <param xmlns="http://wadl.dev.java.net/2009/02" name="type" style="query" required="false" type="xsd:string" default="ALL">
                <option value="BASE"/>
                <option value="SERVER"/>
                <option value="ALL"/>
            </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"/>
            <param xmlns="http://wadl.dev.java.net/2009/02" name="image" style="query" required="false" type="xsd:anyURI"/>
            <param xmlns="http://wadl.dev.java.net/2009/02" name="flavor" style="query" required="false" type="xsd:anyURI"/>
            <param xmlns="http://wadl.dev.java.net/2009/02" name="name"   style="query" required="false" type="xsd:string"/>
            <param xmlns="http://wadl.dev.java.net/2009/02" name="status" style="query" required="false" type="osapi:ServerStatus"/>
           '>

     <!-- Flavor List Parameters -->

     <!ENTITY flavorListParameters
           '
            <param xmlns="http://wadl.dev.java.net/2009/02" name="changes-since" style="query" required="false" type="xsd:dateTime"/>
            <param xmlns="http://wadl.dev.java.net/2009/02" name="minDisk" style="query" required="false" type="xsd:int"/>
            <param xmlns="http://wadl.dev.java.net/2009/02" name="minRam"  style="query" required="false" type="xsd:int"/>
           '>