Merge "Nova - add os-security-group-rules to v2 and v2.1"

This commit is contained in:
Jenkins 2015-08-23 03:50:46 +00:00 committed by Gerrit Code Review
commit 67619315c1
8 changed files with 552 additions and 10 deletions

View File

@ -618,6 +618,25 @@
href="../wadls/compute-api/src/v2/ext/os-quota-sets.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="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/ext/os-security-groups.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-security-group-rules">
<title>Rules for security group (os-security-group-rules)</title>
<para>
Creates and deletes security group rules.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-security-group-rules.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-security-group-default-rules">
<title>Rules for default security group
(os-security-group-default-rules)</title>
@ -629,16 +648,6 @@
href="../wadls/compute-api/src/v2/ext/os-security-group-default-rules.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="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/ext/os-security-groups.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-server-groups">
<title>Server groups (os-server-groups)</title>
<para>

View File

@ -549,6 +549,15 @@
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="os-security-group-rules-v2.1">
<title>Rules for security group (os-security-group-rules)</title>
<para>
Creates and deletes security group rules.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-security-group-rules-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-server-groups-v2.1">
<title>Server groups (os-server-groups)</title>
<para>

View File

@ -0,0 +1,9 @@
{
"security_group_rule": {
"from_port": "443",
"ip_protocol": "tcp",
"to_port": "443",
"cidr": "0.0.0.0/0",
"parent_group_id": "48700ff3-30b8-4e63-845f-a79c9633e9fb"
}
}

View File

@ -0,0 +1,13 @@
{
"security_group_rule": {
"id": "2d021cf1-ce4b-4292-994f-7a785d62a144",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"parent_group_id": "48700ff3-30b8-4e63-845f-a79c9633e9fb",
"to_port": 443,
"ip_protocol": "tcp",
"group": {},
"from_port": 443
}
}

View File

@ -0,0 +1,240 @@
<?xml version="1.0" encoding="UTF-8"?>
<!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-group-rules-v2.1">
<resource id="v2.1" path="//v2.1">
<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 ID of the tenant.
</para>
</wadl:doc>
</param>
<resource path="os-security-group-rules"
id="os-security-group-rules2">
<method href="#createSecGroupRule" />
<resource id="security_group_rule_id"
path="{security_group_rule_id}">
<param name="security_group_rule_id"
style="template" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Security group ID">
<para>
The ID of the security group rule.
</para>
</wadl:doc>
</param>
<method href="#deleteSecGroupRule" />
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="POST" id="createSecGroupRule">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create security group rule">
<para role="shortdesc">
Creates a rule for a specified 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 rule: JSON request">
<xsdxt:code href="../api_samples/os-security-group-rules/security-group-rules-create-req.json" />
</wadl:doc>
<param name="security_group_rule" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Security group rule object in request">
<para>
A <code>security_group_rule</code> object.
</para>
</wadl:doc>
</param>
<param name="parent_group_id" style="plain"
type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Security group rule ID in request">
<para>
Security group ID.
</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>
The IP protocol: ICMP, TCP, or UDP.
</para>
</wadl:doc>
</param>
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>
Port at start of range.
</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>
Port at end of range.
</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>
The CIDR for address range.
</para>
</wadl:doc>
</param>
<param name="group_id" style="plain" type="csapi:UUID"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Group ID">
<para>
Source security group ID.
</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 rule: JSON response">
<xsdxt:code href="../api_samples/os-security-group-rules/security-group-rules-create-resp.json" />
</wadl:doc>
<param name="security_group_rule" style="plain"
type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Security group rule object in response">
<para>
A <code>security_group_rule</code> object.
</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>
The IP protocol: ICMP, TCP, or UDP.
</para>
</wadl:doc>
</param>
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>
Port at start of range.
</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>
Port at end of range.
</para>
</wadl:doc>
</param>
<param name="ip_range" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP range object">
<para>
An <code>ip_range</code> object.
</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>
The CIDR for address range.
</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 rule ID in response">
<para>
The security group ID.
</para>
</wadl:doc>
</param>
<param name="group" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Group object">
<para>
A <code>group</code> object. Includes the tenant
ID and the source security group name.
</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID">
<para>
The ID of the tenant who owns the source security
group.
</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="Name">
<para>
The source security group name.
</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
<method name="DELETE" id="deleteSecGroupRule">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Delete security group rule">
<para role="shortdesc">
Deletes a specified security group rule.
</para>
</wadl:doc>
<response status="202" />
</method>
</application>

View File

@ -0,0 +1,9 @@
{
"security_group_rule": {
"from_port": "443",
"ip_protocol": "tcp",
"to_port": "443",
"cidr": "0.0.0.0/0",
"parent_group_id": "48700ff3-30b8-4e63-845f-a79c9633e9fb"
}
}

View File

@ -0,0 +1,13 @@
{
"security_group_rule": {
"id": "2d021cf1-ce4b-4292-994f-7a785d62a144",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"parent_group_id": "48700ff3-30b8-4e63-845f-a79c9633e9fb",
"to_port": 443,
"ip_protocol": "tcp",
"group": {},
"from_port": 443
}
}

View File

@ -0,0 +1,240 @@
<?xml version="1.0" encoding="UTF-8"?>
<!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-group-rules-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 ID of the tenant.
</para>
</wadl:doc>
</param>
<resource path="os-security-group-rules"
id="os-security-group-rules2">
<method href="#createSecGroupRule" />
<resource id="security_group_rule_id"
path="{security_group_rule_id}">
<param name="security_group_rule_id"
style="template" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Security group ID">
<para>
The ID of the security group rule.
</para>
</wadl:doc>
</param>
<method href="#deleteSecGroupRule" />
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="POST" id="createSecGroupRule">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create security group rule">
<para role="shortdesc">
Creates a rule for a specified 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 rule: JSON request">
<xsdxt:code href="../api_samples/os-security-group-rules/security-group-rules-create-req.json" />
</wadl:doc>
<param name="security_group_rule" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Security group rule object in request">
<para>
A <code>security_group_rule</code> object.
</para>
</wadl:doc>
</param>
<param name="parent_group_id" style="plain"
type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Security group rule ID in request">
<para>
Security group ID.
</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>
The IP protocol: ICMP, TCP, or UDP.
</para>
</wadl:doc>
</param>
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>
Port at start of range.
</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>
Port at end of range.
</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>
The CIDR for address range.
</para>
</wadl:doc>
</param>
<param name="group_id" style="plain" type="csapi:UUID"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Group ID">
<para>
Source security group ID.
</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 rule: JSON response">
<xsdxt:code href="../api_samples/os-security-group-rules/security-group-rules-create-resp.json" />
</wadl:doc>
<param name="security_group_rule" style="plain"
type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Security group rule object in response">
<para>
A <code>security_group_rule</code> object.
</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>
The IP protocol: ICMP, TCP, or UDP.
</para>
</wadl:doc>
</param>
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>
Port at start of range.
</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>
Port at end of range.
</para>
</wadl:doc>
</param>
<param name="ip_range" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP range object">
<para>
An <code>ip_range</code> object.
</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>
The CIDR for address range.
</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 rule ID in response">
<para>
The security group ID.
</para>
</wadl:doc>
</param>
<param name="group" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Group object">
<para>
A <code>group</code> object. Includes the tenant
ID and the source security group name.
</para>
</wadl:doc>
</param>
<param name="tenant_id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID">
<para>
The ID of the tenant who owns the source security
group.
</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="Name">
<para>
The source security group name.
</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
<method name="DELETE" id="deleteSecGroupRule">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Delete security group rule">
<para role="shortdesc">
Deletes a specified security group rule.
</para>
</wadl:doc>
<response status="202" />
</method>
</application>