openstack/api-site
Code Issues Proposed changes

Merge "Add 'usage' flag description for block storage"

Browse Source
This commit is contained in:
Jenkins 2015-08-03 15:46:38 +00:00 committed by Gerrit Code Review
commit fd7786ba9f
5 changed files with 54 additions and 392 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

388
api-ref/src/wadls/volume-api/src/v1/common.ent
View File

@ -1,388 +0,0 @@
<!ENTITY quotaSetsReqParameters '
<param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
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 quota_set object.</para></wadl:doc>
</param>
<param name="cores" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of instance cores allowed for
each tenant.</para></wadl:doc>
</param>
<param name="fixed_ips" style="plain"
required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of fixed IP addresses allowed
for each tenant. Must be equal to or
greater than the number of allowed
instances.</para></wadl:doc>
</param>
<param name="floating_ips" style="plain"
required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of floating IP addresses
allowed for each tenant.</para></wadl:doc>
</param>
<param name="id" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID for the quota
set.</para></wadl:doc>
</param>
<param name="injected_file_content_bytes"
style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of bytes of content allowed
for each injected file.</para></wadl:doc>
</param>
<param name="injected_file_path_bytes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of bytes allowed for each
injected file path.</para></wadl:doc>
</param>
<param name="injected_files" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of injected files allowed for
each tenant.</para></wadl:doc>
</param>
<param name="instances" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of instances allowed for each
tenant.</para></wadl:doc>
</param>
<param name="key_pairs" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of key pairs allowed for each
user.</para></wadl:doc>
</param>
<param name="metadata_items" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of metadata items allowed for
each instance.</para></wadl:doc>
</param>
<param name="ram" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The amount of instance RAM in megabytes
allowed for each tenant.</para></wadl:doc>
</param>
<param name="security_group_rules" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of rules allowed for each
security group.</para></wadl:doc>
</param>
<param name="security_groups" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of security groups allowed
for each tenant.</para></wadl:doc>
</param>'>
<!ENTITY quotaSetsRespParameters '<param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
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 quota_set object.</para></wadl:doc>
</param>
<param name="cores" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of instance cores allowed for
each tenant.</para></wadl:doc>
</param>
<param name="fixed_ips" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of fixed IP addresses allowed
for each tenant. Must be equal to or
greater than the number of allowed
instances.</para></wadl:doc>
</param>
<param name="floating_ips" style="plain"
required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of floating IP addresses
allowed for each tenant.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID for the quota
set.</para></wadl:doc>
</param>
<param name="injected_file_content_bytes"
style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of bytes of content allowed
for each injected file.</para></wadl:doc>
</param>
<param name="injected_file_path_bytes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of bytes allowed for each
injected file path.</para></wadl:doc>
</param>
<param name="injected_files" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of injected files allowed for
each tenant.</para></wadl:doc>
</param>
<param name="instances" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of instances allowed for each
tenant.</para></wadl:doc>
</param>
<param name="key_pairs" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of key pairs allowed for each
user.</para></wadl:doc>
</param>
<param name="metadata_items" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of metadata items allowed for
each instance.</para></wadl:doc>
</param>
<param name="ram" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The amount of instance RAM in megabytes
allowed for each tenant.</para></wadl:doc>
</param>
<param name="security_group_rules" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of rules allowed for each
security group.</para></wadl:doc>
</param>
<param name="security_groups" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of security groups allowed
for each tenant.</para></wadl:doc>
</param>'>
<!ENTITY createVolumeParameters '
<param name="display_name" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The volume name.</para></wadl:doc>
</param>
<param name="display_description" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The volume
description.</para></wadl:doc>
</param>
<param name="size" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The size of the volume, in
GBs.</para></wadl:doc>
</param>
<param name="volume_type" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The associated volume
type.</para></wadl:doc>
</param>
<param name="metadata" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>One or more metadata key and value pairs
to associate with the
volume.</para></wadl:doc>
</param>
<param name="availability_zone" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The availability zone.</para></wadl:doc>
</param>
<param name="snapshot_id" style="plain"
type="csapi:uuid" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>To create a volume from an existing
snapshot, specify the ID of the existing
volume snapshot. The volume is created in same availability
zone and with same size as the snapshot.</para></wadl:doc>
</param>' >
<!ENTITY createVolumeResponseParameters '
<param name="id" style="plain"
type="csapi:uuid" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The volume ID.</para></wadl:doc>
</param>
<param name="display_name" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The volume name.</para></wadl:doc>
</param>
<param name="display_description" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The volume
description.</para></wadl:doc>
</param>
<param name="size" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The size of the volume, in
GBs.</para></wadl:doc>
</param>
<param name="volume_type" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The associated volume
type.</para></wadl:doc>
</param>
<param name="metadata" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>One or more metadata key and value pairs
to associate with the
volume.</para></wadl:doc>
</param>
<param name="availability_zone" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The availability zone.</para></wadl:doc>
</param>
<param name="snapshot_id" style="plain"
type="csapi:uuid" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>To create a volume from an existing
snapshot, specify the ID of the existing
volume snapshot. The volume is created in same availability
zone and with same size as the snapshot.</para></wadl:doc>
</param>
<param name="bootable" style="plain"
type="xsd:boolean" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Indicates whether you can boot an instance from the volume.</para></wadl:doc>
</param>
<param name="attachments" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Attachments.</para></wadl:doc>
</param>
<param name="created_at" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Created-at timestamp.</para></wadl:doc>
</param>' >

11
api-ref/src/wadls/volume-api/src/v1/os-quota-sets-v1.wadl
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013-2015 OpenStack Foundation, All Rights Reserved --> <!-- (C) 2013-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [ <!DOCTYPE application [
<!ENTITY % common SYSTEM "common.ent"> <!ENTITY % common SYSTEM "../v2/common.ent">
%common; %common;
<!ENTITY % common SYSTEM "../common_project.ent"> <!ENTITY % common SYSTEM "../common_project.ent">
%common_project; %common_project;
@ -130,6 +130,11 @@
title="Show quotas"> title="Show quotas">
<para role="shortdesc">Shows quotas for a tenant.</para> <para role="shortdesc">Shows quotas for a tenant.</para>
</wadl:doc> </wadl:doc>
<request>
<representation mediaType="application/xml">
&quotaSetsShowReqParameters;
</representation>
</request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -145,7 +150,9 @@
<xsdxt:code <xsdxt:code
href="api_samples/os-quota-sets/quotas-show-get-resp.xml" href="api_samples/os-quota-sets/quotas-show-get-resp.xml"
/> />
</wadl:doc>&quotaSetsRespParameters; </representation> </wadl:doc>&quotaSetsRespParameters;
&quotaSetsShowRespParameters;
</representation>
</response> </response>
</method> </method>
<method name="PUT" id="updateQuota"> <method name="PUT" id="updateQuota">

2
api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2015 OpenStack Foundation, All Rights Reserved --> <!-- (C) 2012-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [ <!DOCTYPE application [
<!ENTITY % common SYSTEM "common.ent"> <!ENTITY % common SYSTEM "../v2/common.ent">
%common; %common;
<!ENTITY % common SYSTEM "../common_project.ent"> <!ENTITY % common SYSTEM "../common_project.ent">
%common_project; %common_project;

39
api-ref/src/wadls/volume-api/src/v2/common.ent
View File

@ -50,6 +50,18 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY quotasShowRequest '
<param name="usage" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Set to <code>usage=True</code> to show quota usage. Default is
<code>False</code>.
</para></wadl:doc>
</param>'>
<!ENTITY quotaSetsReqParameters ' <!ENTITY quotaSetsReqParameters '
<param name="quota_set" style="plain" required="true" <param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -57,7 +69,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>A quota_set object.</para></wadl:doc> <para>A <code>quota_set</code> object.</para></wadl:doc>
</param> </param>
<param name="cores" style="plain" required="false" <param name="cores" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -179,6 +191,31 @@
<para>The number of security groups allowed <para>The number of security groups allowed
for each tenant.</para></wadl:doc> for each tenant.</para></wadl:doc>
</param>'> </param>'>
<!ENTITY quotasShowResponse '
<param name="in_use" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The in use data size. Visible only if you set the
<code>usage=True</code> query parameter.
</para>
</wadl:doc>
</param>
<param name="reserved" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Reserved volume size. Visible only if you set the
<code>usage=True</code> query parameter.
</para>
</wadl:doc>
</param>'>
<!ENTITY quotaSetsRespParameters ' <!ENTITY quotaSetsRespParameters '
<param name="quota_set" style="plain" required="true" <param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"

6
api-ref/src/wadls/volume-api/src/v2/os-quota-sets-v2.wadl
View File

@ -135,6 +135,11 @@
title="Show quotas"> title="Show quotas">
<para role="shortdesc">Shows quotas for a tenant.</para> <para role="shortdesc">Shows quotas for a tenant.</para>
</wadl:doc> </wadl:doc>
<request>
<representation mediaType="application/xml">
&quotasShowRequest;
</representation>
</request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -152,6 +157,7 @@
/> />
</wadl:doc> </wadl:doc>
&quotasResponse; &quotasResponse;
&quotasShowResponse;
</representation> </representation>
</response> </response>
</method> </method>