8659ff0ef5
This patch is for converting API Reference to RST and host it in the Cinder tree. This patch contains all the RST for cinder to bring over to their repos to begin building API reference information from within. This contains .inc files which have all the contents of the .rst files but are grouped together for easier editing This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API. Cleaning task will be done once this part is merged. As we have removed XML API support in Newton release, we need to remove XML from API reference as well. But we still have installations which are using XML. So implementation plan is to first merge this patch in Newton release keeping XML for now, then I will backport same to stable branches. After that I will remove same from Newton release to match API reference with actual API implementation. Implements: bp api-reference-to-rst Change-Id: I865ac922538bfa5bd45c24eb4bc49f5e966dc811
166 lines
7.5 KiB
XML
166 lines
7.5 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<extensions xmlns:atom="http://www.w3.org/2005/Atom"
|
|
xmlns="http://docs.openstack.org/common/api/v1.0">
|
|
<extension alias="OS-SCH-HNT" updated="2013-04-18T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/block-service/ext/scheduler-hints/api/v2"
|
|
name="SchedulerHints">
|
|
<description>Pass arbitrary key/value pairs to the
|
|
scheduler.</description>
|
|
</extension>
|
|
<extension alias="os-hosts" updated="2011-06-29T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/hosts/api/v1.1"
|
|
name="Hosts">
|
|
<description>Admin-only host administration.</description>
|
|
</extension>
|
|
<extension alias="os-vol-tenant-attr"
|
|
updated="2011-11-03T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/volume_tenant_attribute/api/v1"
|
|
name="VolumeTenantAttribute">
|
|
<description>Expose the internal project_id as an attribute of
|
|
a volume.</description>
|
|
</extension>
|
|
<extension alias="os-quota-sets"
|
|
updated="2011-08-08T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/quotas-sets/api/v1.1"
|
|
name="Quotas">
|
|
<description>Quota management support.</description>
|
|
</extension>
|
|
<extension alias="os-types-manage"
|
|
updated="2011-08-24T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/types-manage/api/v1"
|
|
name="TypesManage">
|
|
<description>Types manage support.</description>
|
|
</extension>
|
|
<extension alias="os-volume-encryption-metadata"
|
|
updated="2013-07-10T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/os-volume-encryption-metadata/api/v1"
|
|
name="VolumeEncryptionMetadata">
|
|
<description>Volume encryption metadata retrieval
|
|
support.</description>
|
|
</extension>
|
|
<extension alias="backups" updated="2012-12-12T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/backups/api/v1"
|
|
name="Backups">
|
|
<description>Backups support.</description>
|
|
</extension>
|
|
<extension alias="os-snapshot-actions"
|
|
updated="2013-07-16T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/snapshot-actions/api/v1.1"
|
|
name="SnapshotActions">
|
|
<description>Enable snapshot manager actions.</description>
|
|
</extension>
|
|
<extension alias="os-volume-actions"
|
|
updated="2012-05-31T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/volume-actions/api/v1.1"
|
|
name="VolumeActions">
|
|
<description>Enable volume actions </description>
|
|
</extension>
|
|
<extension alias="os-used-limits"
|
|
updated="2013-10-03T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/used-limits/api/v1.1"
|
|
name="UsedLimits">
|
|
<description>Provide data on limited resources that are being
|
|
used.</description>
|
|
</extension>
|
|
<extension alias="os-volume-unmanage"
|
|
updated="2012-05-31T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/volume-unmanage/api/v1.1"
|
|
name="VolumeUnmanage">
|
|
<description>Enable volume unmanage operation.</description>
|
|
</extension>
|
|
<extension alias="os-vol-host-attr"
|
|
updated="2011-11-03T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/volume_host_attribute/api/v1"
|
|
name="VolumeHostAttribute">
|
|
<description>Expose host as an attribute of a
|
|
volume.</description>
|
|
</extension>
|
|
<extension alias="encryption" updated="2013-07-01T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/volume-type-encryption/api/v1"
|
|
name="VolumeTypeEncryption">
|
|
<description>Encryption support for volume
|
|
types.</description>
|
|
</extension>
|
|
<extension alias="os-availability-zone"
|
|
updated="2013-06-27T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/os-availability-zone/api/v1"
|
|
name="AvailabilityZones">
|
|
<description>Describe Availability Zones.</description>
|
|
</extension>
|
|
<extension alias="qos-specs" updated="2013-08-02T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/qos-specs/api/v1"
|
|
name="Qos_specs_manage">
|
|
<description>QoS specs support.</description>
|
|
</extension>
|
|
<extension alias="os-types-extra-specs"
|
|
updated="2011-08-24T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/types-extra-specs/api/v1"
|
|
name="TypesExtraSpecs">
|
|
<description>Type extra specs support.</description>
|
|
</extension>
|
|
<extension alias="os-vol-mig-status-attr"
|
|
updated="2013-08-08T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/volume_mig_status_attribute/api/v1"
|
|
name="VolumeMigStatusAttribute">
|
|
<description>Expose migration_status as an attribute of a
|
|
volume.</description>
|
|
</extension>
|
|
<extension alias="os-image-create"
|
|
updated="2012-08-13T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/image-create/api/v1"
|
|
name="CreateVolumeExtension">
|
|
<description>Allow creating a volume from an image in the
|
|
Create Volume v1 API.</description>
|
|
</extension>
|
|
<extension alias="os-extended-services"
|
|
updated="2014-01-10T00:00:00-00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/extended_services/api/v2"
|
|
name="ExtendedServices">
|
|
<description>Extended services support.</description>
|
|
</extension>
|
|
<extension alias="os-extended-snapshot-attributes"
|
|
updated="2012-06-19T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/extended_snapshot_attributes/api/v1"
|
|
name="ExtendedSnapshotAttributes">
|
|
<description>Extended SnapshotAttributes
|
|
support.</description>
|
|
</extension>
|
|
<extension alias="os-vol-image-meta"
|
|
updated="2012-12-07T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/volume_image_metadata/api/v1"
|
|
name="VolumeImageMetadata">
|
|
<description>Show image metadata associated with the
|
|
volume.</description>
|
|
</extension>
|
|
<extension alias="os-quota-class-sets"
|
|
updated="2012-03-12T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/quota-classes-sets/api/v1.1"
|
|
name="QuotaClasses">
|
|
<description>Quota classes management support.</description>
|
|
</extension>
|
|
<extension alias="os-volume-transfer"
|
|
updated="2013-05-29T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/volume-transfer/api/v1.1"
|
|
name="VolumeTransfer">
|
|
<description>Volume transfer management support.</description>
|
|
</extension>
|
|
<extension alias="os-volume-manage"
|
|
updated="2014-02-10T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/os-volume-manage/api/v1"
|
|
name="VolumeManage">
|
|
<description>Allows existing back end storage to be 'managed'
|
|
by cinder.</description>
|
|
</extension>
|
|
<extension alias="os-admin-actions"
|
|
updated="2012-08-25T00:00:00+00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/admin-actions/api/v1.1"
|
|
name="AdminActions">
|
|
<description>Enable admin actions.</description>
|
|
</extension>
|
|
<extension alias="os-services" updated="2012-10-28T00:00:00-00:00"
|
|
namespace="http://docs.openstack.org/volume/ext/services/api/v2"
|
|
name="Services">
|
|
<description>Services support.</description>
|
|
</extension>
|
|
</extensions>
|