openstack/api-site
Code Issues Proposed changes

Merge "Update os-security-groups for v2 and v2.1 Compute"

Browse Source
This commit is contained in:
Jenkins 2015-04-26 12:38:20 +00:00 committed by Gerrit Code Review
commit ba2289d82a
10 changed files with 841 additions and 317 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
api-ref/src/docbkx/ch_compute-v2.1.xml
View File

@ -374,6 +374,14 @@
href="../wadls/compute-api/src/v2.1/wadl/os-remote-consoles-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v2.1-os-security-groups">
<title>Security groups (os-security-groups)</title>
<para>Lists, shows information for, creates, and deletes security
groups.</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-security-groups-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v2.1ext-server-diagnostics">
<title>Server diagnostics (os-server-diagnostics)</title>
<para>Gets the usage data for a server.</para>
@ -381,6 +389,23 @@
href="../wadls/compute-api/src/v2.1/wadl/os-server-diagnostics-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v2.1os-server-groups">
<title>Server groups (os-server-groups)</title>
<para>Lists, shows information for, creates, and deletes server
groups.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/src/v2.1/wadl/os-server-groups-v2.1.wadl#os-server-groups">
<wadl:method href="#listServerGroups"/>
<wadl:method href="#createServerGroup"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2.1/wadl/os-server-groups-v2.1.wadl#ServerGroup_id">
<wadl:method href="#showServerGroup"/>
<wadl:method href="#deleteServerGroup"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="os-server-usage-v2.1">
<title>Server usage (os-server-usage)</title>
<para>

6
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-security-groups/security-groups-create-resp.json
View File

@ -1,8 +1,8 @@
{
"security_group": {
"description": "description",
"id": 2,
"name": "test",
"description": "default",
"id": 1,
"name": "default",
"rules": [],
"tenant_id": "openstack"
}

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

@ -514,7 +514,7 @@
</para>
</wadl:doc>
</param>
<param name="fixed_ips " style="plain" required="false"
<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"
@ -562,7 +562,7 @@
</para>
</wadl:doc>
</param>
<param name="injected_file_path_bytes " style="plain"
<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"
@ -705,7 +705,7 @@
</para>
</wadl:doc>
</param>
<param name="fixed_ips " style="plain" required="true"
<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"
@ -753,7 +753,7 @@
</para>
</wadl:doc>
</param>
<param name="injected_file_path_bytes " style="plain"
<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"
@ -919,4 +919,110 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY serverGroupParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security groups object">
<para>Security groups object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Rules object">
<para>A rules object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="tenant_id" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Tenant ID">
<para>The tenant ID.</para>
</wadl:doc>
</param>'>
<!ENTITY serverGroupsParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="server_groups" required="true"
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 <code>server_groups</code> object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="id" required="true"
type="csapi:uuid">
<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 server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="name" required="true"
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 name of the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="policies" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A list of policies associated with the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="members" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A list of members in the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="metadata" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Associated metadata key-and-value pairs.</para>
</wadl:doc>
</param>'>
<!-- For v2.1 x-compute-request-id -->
<!ENTITY x-compute-request-idHeader '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Compute-Request-ID" style="header" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Returns a unique identifier to provide tracking for the request.
The request-id associated with the request appears in the log lines for
that request. By default, the middleware configuration ensures the
request_id appears in the log files.
</para>
</wadl:doc>
</param>'>

235
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-security-groups-v2.1.wadl Normal file
View File

@ -0,0 +1,235 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<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:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
<resources base="https://servers.api.openstack.com"
xml:id="os-security-groups-v2.1">
<resource id="v2.1" path="//v2.1">
<resource path="os-security-groups" id="os-security-groups2">
<method href="#listSecGroups" />
<method href="#createSecGroup" />
<resource id="security_group_id" path="{security_group_id}">
<method href="#showSecGroup" />
<method href="#deleteSecGroup" />
</resource>
</resource>
<resource id="Servers" path="servers">
<resource path="{server_id}" id="server_id">
<resource path="os-security-groups" id="os-security-groups">
<method href="#listSecGroupsByServer" />
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="listSecGroups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List security groups">
<para role="shortdesc">Lists security groups.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List security groups: JSON response">
<xsdxt:code href="../api_samples/os-security-groups/security-groups-list-get-resp.json" />
</wadl:doc>
<param name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security groups object">
<para>Security groups object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Rules object">
<para>A rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
<method name="GET" id="listSecGroupsByServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List security groups by server">
<para role="shortdesc">Lists security groups for a
specified server.</para>
</wadl:doc>
<response status="200">
<param name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security groups object">
<para>Security groups object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group rules object">
<para>A security group rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List security groups by server: JSON response">
<xsdxt:code href="../api_samples/os-security-groups/security-groups-list-get-resp.json" />
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="showSecGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show security group information">
<para role="shortdesc">Shows information for a specified
security group.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show security group: JSON response">
<xsdxt:code href="../api_samples/os-security-groups/security-groups-get-resp.json" />
</wadl:doc>
<param name="security_group" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group object">
<para>Security group object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group rules object">
<para>A security group rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
<method name="POST" id="createSecGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create security group">
<para role="shortdesc">Creates a security group.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create security group: JSON request">
<xsdxt:code href="../api_samples/os-security-groups/security-group-add-post-req.json" />
</wadl:doc>
<param name="addSecurityGroup" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Add security group">
<para>
Specify the <code>addSecurityGroup</code> action in the
request body.
</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create security group: JSON response">
<xsdxt:code href="../api_samples/os-security-groups/security-groups-create-resp.json" />
</wadl:doc>
<param name="security_group" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group object">
<para>Security group object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group rules object">
<para>A security group rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
<method name="DELETE" id="deleteSecGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete security group">
<para role="shortdesc">Deletes a specified security
group.</para>
</wadl:doc>
<response status="202" />
</method>
</application>

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

@ -0,0 +1,164 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://servers.api.openstack.com"
xml:id="os-server-groups-v2.1">
<resource id="version" type="#VersionDetails" path="//v2">
<resource id="os-server-groups"
path="os-server-groups">
<method href="#listServerGroups"/>
<method href="#createServerGroup"/>
<resource path="{ServerGroup_id}"
id="ServerGroup_id">
<param
xmlns="http://wadl.dev.java.net/2009/02"
name="ServerGroup_id" style="template">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The server group
ID.</para></wadl:doc>
</param>
<method href="#showServerGroup"/>
<method href="#deleteServerGroup"/>
</resource>
</resource>
</resource>
</resources>
<method name="POST" id="createServerGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create server group">
<para role="shortdesc">Creates a server group.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-post-req.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-post-req.xml"
/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The server group name. A non-empty
string with no leading or trailing spaces.
Maximum length is 255
characters.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="policies" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A list of one or more policy names to
associate with the server group. The list
must contain at least one policy
name.</para>
<para>Each policy name must be a non-empty
string with no leading or trailing spaces.
Maximum length is 255
characters.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-post-resp.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-post-resp.xml"
/>
</wadl:doc> &serverGroupParameters; </representation>
</response>
</method>
<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>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-list-resp.json"
/>
</wadl:doc>
</representation>
</response>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-list-resp.xml"
/>
</wadl:doc> &serverGroupsParameters; </representation>
</response>
</method>
<method name="GET" id="showServerGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show server group details">
<para role="shortdesc">Shows details for a specified
server group.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-get-resp.json"
/>
</wadl:doc>
</representation>
</response>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-get-resp.xml"
/>
</wadl:doc> &serverGroupParameters; </representation>
</response>
</method>
<method name="DELETE" id="deleteServerGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete server group">
<para role="shortdesc">Deletes a specified server
group.</para>
</wadl:doc>
<response status="204"/>
<!-- Common and GET Faults --> &commonFaults; &getFaults;
</method>
</application>

2
api-ref/src/wadls/compute-api/src/v2.1/wadl/server-metadata.wadl → api-ref/src/wadls/compute-api/src/v2.1/wadl/server-metadata-v2.1.wadl
View File

@ -11,7 +11,7 @@
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
<resources base="https://servers.api.openstack.com"
xml:id="os-server-metadata-v2.1">
xml:id="server-metadata-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="servers" path="servers">
<resource id="server_metadata" path="metadata" type="#ServerMetadataDetails">

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

@ -660,7 +660,7 @@
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="fixed_ips " style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02" name="fixed_ips" style="plain"
required="false"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -705,7 +705,7 @@
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="injected_file_path_bytes " style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02" name="injected_file_path_bytes" style="plain"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -824,7 +824,7 @@
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="fixed_ips " style="plain" required="true"
<param xmlns="http://wadl.dev.java.net/2009/02" name="fixed_ips" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -866,7 +866,7 @@
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="injected_file_path_bytes " style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02" name="injected_file_path_bytes" style="plain"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -966,6 +966,49 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY serverGroupParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security groups object">
<para>Security groups object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Rules object">
<para>A rules object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="tenant_id" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Tenant ID">
<para>The tenant ID.</para>
</wadl:doc>
</param>'>
<!ENTITY serverGroupsParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="server_groups" required="true"
type="xsd:string">
@ -1015,61 +1058,7 @@
<para>Associated metadata key-and-value pairs.</para>
</wadl:doc>
</param>'>
<!ENTITY serverGroupParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="server_group" required="true"
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 <code>server_group</code> places
VMs in a grouping based on common
characteristics, so that you can apply
policies to groups or categorize servers
for scheduling purposes.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="id" required="true"
type="csapi:uuid">
<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 server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="name" required="true"
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 name of the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="policies" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A list of policies associated with the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="members" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A list of members in the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="metadata" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Associated metadata key-and-value pairs.</para>
</wadl:doc>
</param>'>
<!ENTITY unshelveAction '
<!ENTITY unshelveAction '
<param xmlns="http://wadl.dev.java.net/2009/02" name="unshelve" style="plain" type="xsd:string"
required="true" id="os-unshelve">
<wadl:doc xmlns="http://docbook.org/ns/docbook"

88
api-ref/src/wadls/compute-api/src/v2/ext/os-admin-actions.wadl
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2015 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@ -42,8 +42,6 @@
<method href="#os-migrateLive"/>
<method href="#os-resetState"/>
<method href="#evacuate"/>
<method href="#addSecurityGroup"/>
<method href="#removeSecurityGroup"/>
<method href="#addFloatingIP"/>
</resource>
</resource>
@ -602,81 +600,6 @@
</representation>
</response>
</method>
<method name="POST" id="addSecurityGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add security group">
<para role="shortdesc">Assigns a specified security group
to a specified server.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Add security group: JSON request">
<xsdxt:code
href="../api_samples/os-security-groups/security-group-add-post-req.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<param name="addSecurityGroup" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Add security group action"
><para>Specify the
<code>addSecurityGroup</code> action
in the request body.</para></wadl:doc>
</param>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Name"><para>The name of
the security group to assign to the
server.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200"/>
</method>
<method name="POST" id="removeSecurityGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Remove security group">
<para role="shortdesc">Removes a specified security group
from a specified server.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Remove security group: JSON request">
<xsdxt:code
href="../api_samples/os-security-groups/security-group-remove-post-req.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<param name="removeSecurityGroup" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Remove security group action"
><para>Specify the
<code>removeSecurityGroup</code>
action in the request
body.</para></wadl:doc>
</param>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Name"><para>The name of
the security group to remove from the
server.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200"/>
</method>
<method name="POST" id="addFloatingIP">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add floating IP address">
@ -718,15 +641,6 @@
with the instance.</para></wadl:doc>
</param>
</representation>
<!-- <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Add floating IP address: XML request">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-add-floating-ip.xml"
/>
</wadl:doc>
</representation> -->
</request>
<response status="200"/>
</method>

300
api-ref/src/wadls/compute-api/src/v2/ext/os-security-groups.wadl
View File

@ -1,13 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02" xmlns:csapi="http://docs.openstack.org/compute/api/v1.1" xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
<resources base="https://servers.api.openstack.com/" xml:id="os-security-groups-v2">
<!-- (C) 2013-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
<resources base="https://servers.api.openstack.com/"
xml:id="os-security-groups-v2">
<resource id="version" path="//v2">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The unique identifier of the tenant or
account.</para>
<para>
The unique identifier of the tenant or account.
</para>
</wadl:doc>
</param>
<resource path="os-security-groups" id="os-security-groups2">
@ -15,10 +27,12 @@
<method href="#createSecGroup" />
<resource id="security_group_id" path="{security_group_id}">
<param name="security_group_id" style="template" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The
unique identifier of the security
group.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Security group ID">
<para>
The unique identifier of the security group.
</para>
</wadl:doc>
</param>
<method href="#showSecGroup" />
@ -29,8 +43,9 @@
<resource path="{server_id}" id="server_id">
<param name="server_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Server ID">
<para>The UUID for the server of
interest to you.</para>
<para>
The UUID for the server of interest to you.
</para>
</wadl:doc>
</param>
<resource path="os-security-groups" id="os-security-groups">
@ -46,126 +61,99 @@
<para role="shortdesc">Lists security groups.</para>
</wadl:doc>
<response status="200">
<param name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security groups object">
<para>Security groups object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Rules object">
<para>A rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List security groups: JSON response">
<xsdxt:code href="../api_samples/os-security-groups/security-groups-list-get-resp.json" />
</wadl:doc>
&serverGroupParameters;
</representation>
</response>
</method>
<method name="GET" id="listSecGroupsByServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List security groups by server">
<para role="shortdesc">Lists security groups for a
specified server.</para>
<para role="shortdesc">
Lists security groups for a specified server.
</para>
</wadl:doc>
<response status="200">
<param name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security groups object">
<para>Security groups object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group rules object">
<para>A security group rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List security groups by server: JSON response">
<xsdxt:code href="../api_samples/os-security-groups/security-groups-list-get-resp.json" />
</wadl:doc>
<param name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security groups object">
<para>Security groups object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group rules object">
<para>A security group rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
<method name="GET" id="showSecGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show security group information">
<para role="shortdesc">Shows information for a specified
security group.</para>
<para role="shortdesc">
Shows information for a specified security group.
</para>
</wadl:doc>
<response status="200">
<param name="security_group" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group object">
<para>Security group object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group rules object">
<para>A security group rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show security group: JSON response">
<xsdxt:code href="../api_samples/os-security-groups/security-groups-get-resp.json" />
</wadl:doc>
<param name="security_group" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group object">
<para>Security group object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group rules object">
<para>A security group rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
@ -174,73 +162,73 @@
<para role="shortdesc">Creates a security group.</para>
</wadl:doc>
<request>
<param name="addSecurityGroup" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Add security group">
<para>
Specify the
<code>addSecurityGroup</code>
action in the request body.
</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create security group: JSON request">
<xsdxt:code href="../api_samples/os-security-groups/security-group-add-post-req.json" />
</wadl:doc>
<param name="addSecurityGroup" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Add security group">
<para>
Specify the <code>addSecurityGroup</code> action in the
request body.
</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<param name="security_group" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group object">
<para>Security group object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group rules object">
<para>A security group rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create security group: JSON response">
<xsdxt:code href="../api_samples/os-security-groups/security-groups-create-resp.json" />
</wadl:doc>
<param name="security_group" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group object">
<para>Security group object.</para>
</wadl:doc>
</param>
<param name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Security group rules object">
<para>A security group rules object.</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
<method name="DELETE" id="deleteSecGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete security group">
<para role="shortdesc">Deletes a specified security
group.</para>
<para role="shortdesc">
Deletes a specified security group.
</para>
</wadl:doc>
<response status="202" />
</method>

115
api-ref/src/wadls/compute-api/src/v2/ext/os-server-groups.wadl
View File

@ -1,7 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:db="http://docbook.org/ns/docbook"
@ -32,8 +36,7 @@
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The server group
ID.</para></wadl:doc>
<para>The server group ID.</para></wadl:doc>
</param>
<method href="#showServerGroup"/>
<method href="#deleteServerGroup"/>
@ -104,7 +107,57 @@
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-post-resp.xml"
/>
</wadl:doc> &serverGroupParameters; </representation>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
style="plain" name="server_group"
required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
A <code>server_group</code> groups VMs based on
common characteristics so that you can apply
policies to groups or categorize servers for
scheduling purposes.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="id" required="true"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The ID for the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="name" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The name of the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="policies" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A list of policies associated with the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="members" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A list of members in the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="metadata" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Associated metadata key-and-value pairs.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
<method name="GET" id="listServerGroups">
@ -155,7 +208,57 @@
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-get-resp.xml"
/>
</wadl:doc> &serverGroupParameters; </representation>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
style="plain" name="server_group"
required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
A <code>server_group</code> places VMs in a grouping
based on common characteristics, so that you can
apply policies to groups or categorize servers for
scheduling purposes.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="id" required="true"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The ID for the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="name" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The name of the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="policies" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A list of policies associated with the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="members" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A list of members in the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="metadata" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Associated metadata key-and-value pairs.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
<method name="DELETE" id="deleteServerGroup">