openstack
/
api-site
Code Issues Proposed changes

Document the all_projects parameter to the GET os-server-groups API 

Add the all_projects parameter to the wadl for os-server-groups.

Closes-Bug: #1504255

Change-Id: I38c5b56cefce804d161074a9fc19a3057c450aee
This commit is contained in:
Chuck Carmack 2015-10-13 20:39:03 +00:00 committed by Diane Fleming
parent 7ceede0952
commit 4961c36e4e
1 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-groups-v2.1.wadl
View File

@ -94,8 +94,36 @@
<method name="GET" id="listServerGroups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List server groups">
<para role="shortdesc">Lists server groups.</para>
<para role="shortdesc">
Lists all server groups for the specified tenant.
</para>
<para>
Administrative users can use the <code>all_projects</code>
query parameter to list all server groups for all projects.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<param xmlns="http://wadl.dev.java.net/2009/02"
name="all_projects" style="query" required="false" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Administrator only. Lists server groups for all
projects. For example:
</para>
<programlisting language="json">GET /v2.1/​{admin_tenant_id}​/os-server-groups?all_projects=True</programlisting>
<para>
If you specify a tenant ID for a non-administrative
user with this query parameter, the call lists all
server groups for the specified tenant, or project,
rather than for all projects.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"