openstack/api-site
Code Issues Proposed changes

Merge "Modify API ref for per-project-user quotas CRUD methods"

Browse Source
This commit is contained in:
Jenkins
2014-01-03 16:25:02 +00:00
committed by Gerrit Code Review
parent 6f49c24c14 838718c807
commit ddfee241da
1 changed files with 49 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
api-ref/src/wadls/compute-api/src/ext/os-quota-sets.wadl
View File

@@ -9,7 +9,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"> xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://servers.api.openstack.com"> <resources base="https://servers.api.openstack.com">
<resource id="version" type="#VersionDetails" path="v2/"> <resource id="version" type="#VersionDetails" path="v2/">
<resource id="tenantID" path="{tenant_id}"> <resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template" <param name="tenant_id" style="template"
type="xsd:string" required="true"> type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -23,21 +23,49 @@
<resource path="defaults" id="defaults"> <resource path="defaults" id="defaults">
<method href="#getDefaults"/> <method href="#getDefaults"/>
</resource> </resource>
<resource path="{user_id}" id="user_id"> <resource path="{tenant_id}" id="tenantID">
<param name="user_id" style="template" <param name="tenant_id" style="template"
type="csapi:UUID" required="true"> type="xsd:string" required="true">
<wadl:doc <wadl:doc
xmlns="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="User ID"> xml:lang="EN" title="Project ID">
<para>The user ID. Specify in the URI <para>The ID for the tenant for which
as you want to show quotas. This ID is
<code>user_id={user_id}</code>.</para> different from the first tenant ID
that you specify in the URI: That
ID is for the admin tenant.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<method href="#showQuotaUser"/> <resource id="user_id"
<method href="#updateQuotaUser"/> path="?user_id={user_id}">
<param name="user_id" style="template"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="User ID">
<para>The user ID. Specify in the
URI as a query string, like
<code>user_id={user_id}</code>.</para>
</wadl:doc>
</param>
<method href="#showQuotaUser"/>
<method href="#updateQuotaUser"/>
</resource>
<resource id="detail" path="detail"> <resource id="detail" path="detail">
<method href="#showQuotaDetailUser"/> <resource id="user_id-detail"
path="?user_id={user_id}">
<param name="user_id" style="template"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="User ID">
<para>The user ID. Specify in the
URI as a query string, like
<code>user_id={user_id}</code>.</para>
</wadl:doc>
</param>
<method href="#showQuotaDetailUser"/>
</resource>
</resource> </resource>
</resource> </resource>
</resource> </resource>
@@ -140,8 +168,9 @@
</method> </method>
<method name="GET" id="showQuotaUser"> <method name="GET" id="showQuotaUser">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show quotas for user"><para role="shortdesc">Shows title="Show quotas for user"><para role="shortdesc"
quotas for a specified tenant and user.</para> >Enables an admin user to show quotas for a specified
tenant and user.</para>
</wadl:doc> </wadl:doc>
<response status="200"> &quotaSetsRespParameters; <response status="200"> &quotaSetsRespParameters;
<representation mediaType="application/json"> <representation mediaType="application/json">
@@ -149,7 +178,7 @@
xml:lang="EN" xml:lang="EN"
title="Show quotas for user: JSON response"> title="Show quotas for user: JSON response">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-user-show-get-resp.json" href="../api_samples/os-user-quotas/user-quotas-show-get-resp.json"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@@ -158,7 +187,7 @@
xml:lang="EN" xml:lang="EN"
title="Show quotas for user: XML response"> title="Show quotas for user: XML response">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-user-show-get-resp.xml" href="../api_samples/os-user-quotas/user-quotas-show-get-resp.xml"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@@ -168,7 +197,7 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update quotas for user"> title="Update quotas for user">
<para role="shortdesc">Updates quotas for a specified <para role="shortdesc">Updates quotas for a specified
tenant and user.</para> tenant/project and user.</para>
</wadl:doc> </wadl:doc>
<request> &quotaSetsReqParameters; <representation <request> &quotaSetsReqParameters; <representation
mediaType="application/json"> mediaType="application/json">
@@ -176,7 +205,7 @@
xml:lang="EN" xml:lang="EN"
title="Update quotas for user: JSON request"> title="Update quotas for user: JSON request">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-post-req.json" href="../api_samples/os-user-quotas/user-quotas-update-post-req.json"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@@ -185,7 +214,7 @@
xml:lang="EN" xml:lang="EN"
title="Update quotas for user: XML request"> title="Update quotas for user: XML request">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-post-req.xml" href="../api_samples/os-user-quotas/user-quotas-update-post-req.xml"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@@ -196,7 +225,7 @@
xml:lang="EN" xml:lang="EN"
title="Update quotas for user: JSON response"> title="Update quotas for user: JSON response">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-post-resp.json" href="../api_samples/os-user-quotas/user-quotas-update-post-resp.json"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@@ -205,7 +234,7 @@
xml:lang="EN" xml:lang="EN"
title="Show quotas for user: XML response"> title="Show quotas for user: XML response">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-post-resp.xml" href="../api_samples/os-user-quotas/user-quotas-update-post-resp.xml"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>