compute-api/v1.0/xsd/actions.xsd

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../xslt/schema.xslt"?>
<!-- (C) 2009 Rackspace Hosting, All Rights Reserved -->
<schema elementFormDefault="qualified"
  attributeFormDefault="unqualified"
  xmlns="http://www.w3.org/2001/XMLSchema"
  xmlns:csapi="http://docs.rackspacecloud.com/servers/api/v1.0"
  xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  targetNamespace="http://docs.rackspacecloud.com/servers/api/v1.0">
  <annotation>
    <xsd:appinfo xml:lang="EN" xmlns="http://www.w3.org/1999/xhtml">
      <xsdxt:title>Server Actions</xsdxt:title>
      <xsdxt:link rel="index" href="api.xsd"/>
    </xsd:appinfo>
    <xsd:documentation xml:lang="EN"
      xmlns="http://www.w3.org/1999/xhtml">
      <p>This schema file defines actions that can be performed on a
        cloud server. All cloud server actions are derived from the <a
          href="#type_Action" title="See definition of
        Action"
          >Action</a> type.</p>
    </xsd:documentation>
  </annotation>
  <element name="reboot" type="csapi:Reboot">
    <annotation>
      <xsd:documentation xml:lang="EN"
        xmlns="http://www.w3.org/1999/xhtml">
        <p>Performs a HARD or SOFT reboot.</p>
      </xsd:documentation>
      <xsd:appinfo>
        <xsdxt:samples>
          <xsdxt:sample>
            <xsdxt:code type="application/xml"
              href="../samples/reboot.xml"/>
          </xsdxt:sample>
          <xsdxt:sample>
            <xsdxt:code type="application/json"
              href="../samples/reboot.json"/>
          </xsdxt:sample>
        </xsdxt:samples>
      </xsd:appinfo>
    </annotation>
  </element>
  <element name="rebuild" type="csapi:Rebuild">
    <annotation>
      <xsd:documentation xml:lang="EN"
        xmlns="http://www.w3.org/1999/xhtml">
        <p>Rebuilds a server.</p>
      </xsd:documentation>
      <xsd:appinfo>
        <xsdxt:samples>
          <xsdxt:sample>
            <xsdxt:code type="application/xml"
              href="../samples/rebuild.xml"/>
          </xsdxt:sample>
          <xsdxt:sample>
            <xsdxt:code type="application/json"
              href="../samples/rebuild.json"/>
          </xsdxt:sample>
        </xsdxt:samples>
      </xsd:appinfo>
    </annotation>
  </element>
  <element name="resize" type="csapi:Resize">
    <annotation>
      <xsd:documentation xml:lang="EN"
        xmlns="http://www.w3.org/1999/xhtml">
        <p>Resizes a server.</p>
      </xsd:documentation>
      <xsd:appinfo>
        <xsdxt:samples>
          <xsdxt:sample>
            <xsdxt:code type="application/xml"
              href="../samples/resize.xml"/>
          </xsdxt:sample>
          <xsdxt:sample>
            <xsdxt:code type="application/json"
              href="../samples/resize.json"/>
          </xsdxt:sample>
        </xsdxt:samples>
      </xsd:appinfo>
    </annotation>
  </element>
  <element name="confirmResize" type="csapi:ConfirmResize">
    <annotation>
      <xsd:documentation xml:lang="EN"
        xmlns="http://www.w3.org/1999/xhtml">
        <p>Confirms a resize action.</p>
      </xsd:documentation>
      <xsd:appinfo>
        <xsdxt:samples>
          <xsdxt:sample>
            <xsdxt:code type="application/xml"
              href="../samples/confirmresize.xml"/>
          </xsdxt:sample>
          <xsdxt:sample>
            <xsdxt:code type="application/json"
              href="../samples/confirmresize.json"/>
          </xsdxt:sample>
        </xsdxt:samples>
      </xsd:appinfo>
    </annotation>
  </element>
  <element name="revertResize" type="csapi:RevertResize">
    <annotation>
      <xsd:documentation xml:lang="EN"
        xmlns="http://www.w3.org/1999/xhtml">
        <p>Reverts a resize action.</p>
      </xsd:documentation>
      <xsd:appinfo>
        <xsdxt:samples>
          <xsdxt:sample>
            <xsdxt:code type="application/xml"
              href="../samples/revertresize.xml"/>
          </xsdxt:sample>
          <xsdxt:sample>
            <xsdxt:code type="application/json"
              href="../samples/revertresize.json"/>
          </xsdxt:sample>
        </xsdxt:samples>
      </xsd:appinfo>
    </annotation>
  </element>
  <!-- Complex Types -->
  <complexType abstract="true" name="Action">
    <annotation>
      <xsd:documentation xml:lang="EN"
        xmlns="http://www.w3.org/1999/xhtml">
        <p>This is the base type for all server actions. It is simply
          a marker abstract type used to differentiate an Action
          element from other elements.</p>
      </xsd:documentation>
    </annotation>
  </complexType>
  <complexType name="Reboot">
    <complexContent>
      <extension base="csapi:Action">
        <attribute name="type" type="csapi:RebootType" use="required">
          <annotation>
            <xsd:documentation xml:lang="EN"
              xmlns="http://www.w3.org/1999/xhtml">
              <p>The <a href="#type_RebootType"
                  title="See definition
                of RebootType"
                  >type</a> of reboot to perform.</p>
            </xsd:documentation>
          </annotation>
        </attribute>
      </extension>
    </complexContent>
  </complexType>
  <complexType name="Rebuild">
    <complexContent>
      <extension base="csapi:Action">
        <attribute name="imageId" type="xsd:int" use="required">
          <annotation>
            <xsd:documentation xml:lang="EN"
              xmlns="http://www.w3.org/1999/xhtml">
              <p>The id of an image to use for the rebuild.</p>
            </xsd:documentation>
          </annotation>
        </attribute>
      </extension>
    </complexContent>
  </complexType>
  <complexType name="Resize">
    <complexContent>
      <extension base="csapi:Action">
        <attribute name="flavorId" type="xsd:int" use="required">
          <annotation>
            <xsd:documentation xml:lang="EN"
              xmlns="http://www.w3.org/1999/xhtml">
              <p>The id of the flavor to convert to.</p>
            </xsd:documentation>
          </annotation>
        </attribute>
      </extension>
    </complexContent>
  </complexType>
  <complexType name="ConfirmResize">
    <complexContent>
      <extension base="csapi:Action"/>
    </complexContent>
  </complexType>
  <complexType name="RevertResize">
    <complexContent>
      <extension base="csapi:Action"/>
    </complexContent>
  </complexType>
  <!-- Simple Types -->
  <simpleType name="RebootType">
    <restriction base="xsd:string">
      <enumeration value="HARD">
        <annotation>
          <xsd:documentation xml:lang="EN"
            xmlns="http://www.w3.org/1999/xhtml">
            <p>A HARD reboot is equivalent to power cycling the
              server. The operating system is not allowed to
              gracefully shutdown.</p>
          </xsd:documentation>
        </annotation>
      </enumeration>
      <enumeration value="SOFT">
        <annotation>
          <xsd:documentation xml:lang="EN"
            xmlns="http://www.w3.org/1999/xhtml">
            <p>With a SOFT reboot, the operating system is signaled
              to restart. This allows for a graceful shutdown of all
              processes.</p>
          </xsd:documentation>
        </annotation>
      </enumeration>
    </restriction>
  </simpleType>
</schema>