openstack
/
api-site
Code Issues Proposed changes

Add "List servers" in Compute API v2.1 ref 

1. Add /v2.1/{tenant_id}/servers (List servers) api.
2. Modify /v2.1/servers/detail -> /v2.1/{tenant_id}/servers/detail.
          /v2.1/serveers/{server_id} -> /v2.1/{tenant_id}/serveers/{server_id}.

Change-Id: I9d7a999dec859cdd0af664db2fd5cec8c86d67a1
Closes-Bug: #1475464
This commit is contained in:
Duncan.C 2015-07-20 17:18:41 +08:00
parent 2fb4bc984a
commit 853f038c5e
3 changed files with 106 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-server-usage/servers-list-resp.json Normal file
View File

@ -0,0 +1,18 @@
{
"servers": [
{
"id": "22c91117-08de-4894-9aa9-6ef382400985",
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/22c91117-08de-4894-9aa9-6ef382400985",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/22c91117-08de-4894-9aa9-6ef382400985",
"rel": "bookmark"
}
],
"name": "new-server-test"
}
]
}

41
api-ref/src/wadls/compute-api/src/v2.1/common.ent
View File

@ -276,6 +276,47 @@
</para>
</wadl:doc>
</param>'>
<!-- ServersListQueryParameters -->
<!ENTITY ServersListQueryParameters '
<param name="tenant_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The tenant ID in a multi-tenancy cloud.</para>
</wadl:doc>
</param>
'>
<!-- ServersListDetailQueryParameters -->
<!ENTITY ServersListDetailQueryParameters '
<param name="tenant_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The tenant ID in a multi-tenancy cloud.</para>
</wadl:doc>
</param>
'>
<!-- GetServerDetailQueryParameters -->
<!ENTITY GetServerDetailQueryParameters '
<param name="tenant_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The tenant ID in a multi-tenancy cloud.</para>
</wadl:doc>
</param>
<param name="server_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The UUID for the server.</para>
</wadl:doc>
</param>
'>
<!-- Server List Parameters -->
<!ENTITY serverListParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"

60
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl
View File

@ -1,20 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2014-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:csapi="http://docs.openstack.org/identity/api/v3"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
<resources base="https://servers.api.openstack.com"
xml:id="os-server-usage-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="servers" path="servers">
<resource id="detail" path="detail">
<method href="#returnserveruser"/>
</resource>
<resource id="server_id" path="{server_id}">
<method href="#returnserverdetails"/>
<resource id="tenant_id" path="{tenant_id}">
<resource id="servers" path="servers">
<method href="#listServers"/>
<resource id="detail" path="detail">
<method href="#returnListDetailServers"/>
</resource>
<resource id="server_id" path="{server_id}">
<method href="#returngetServer"/>
</resource>
</resource>
</resource>
</resource>
@ -22,12 +26,38 @@
<!-- *******************************************************-->
<!-- OS Server Usage -->
<!--*******************************************************-->
<method name="GET" id="returnserverdetails">
<method name="GET" id="listServers">
<wadl:doc xml:lang="EN" title="List servers"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists IDs, names, and links for
all servers.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&ServersListQueryParameters;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-server-usage/servers-list-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="GET" id="returngetServer">
<wadl:doc xml:lang="EN" title="Show server details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified
server.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&GetServerDetailQueryParameters;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
@ -38,13 +68,17 @@
</representation>
</response>
</method>
<method name="GET" id="returnserveruser">
<wadl:doc xml:lang="EN" title="List server details for user"
<method name="GET" id="returnListDetailServers">
<wadl:doc xml:lang="EN" title="List details for servers"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists server details for a
specified user.</para>
<para role="shortdesc">List details for servers.
</para>
</wadl:doc>
<request> </request>
<request>
<representation mediaType="application/json">
&ServersListDetailQueryParameters;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">