Merge "Add "update security group" to Compute v2 and Networking v2"

2015-09-16 09:44:38 +00:00 · 2015-09-16 09:44:38 +00:00 · 13ef545c20
commit 13ef545c20
parent f0268133d8 73fbcef039
7 changed files with 238 additions and 53 deletions
--- a/api-ref/src/docbkx/ch_compute-v2-ext.xml
+++ b/api-ref/src/docbkx/ch_compute-v2-ext.xml
@ -621,12 +621,25 @@
    <section xml:id="os-security-groups">
        <title>Security groups (os-security-groups)</title>
        <para>
-            Lists, shows information for, creates, and deletes security
-            groups.
+            Lists, lists by server, creates, shows information for, updates,
+            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"/>
+        <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
+            <wadl:resource href="../wadls/compute-api/src/v2/ext/os-security-groups.wadl#os-security-groups2">
+               <wadl:method href="#listSecGroups" />
+            </wadl:resource>
+            <wadl:resource href="../wadls/compute-api/src/v2/ext/os-security-groups.wadl#os-security-groups">
+                <wadl:method href="#listSecGroupsByServer" />
+            </wadl:resource>
+            <wadl:resource href="../wadls/compute-api/src/v2/ext/os-security-groups.wadl#os-security-groups2">
+               <wadl:method href="#createSecGroup" />
+            </wadl:resource>
+            <wadl:resource href="../wadls/compute-api/src/v2/ext/os-security-groups.wadl#security_group_id">
+                <wadl:method href="#showSecGroup" />
+                <wadl:method href="#updateSecGroup" />
+                <wadl:method href="#deleteSecGroup" />
+            </wadl:resource>
+        </wadl:resources>
    </section>
    <section xml:id="os-security-group-rules">
        <title>Rules for security group (os-security-group-rules)</title>
--- a/api-ref/src/docbkx/ch_netconn-v2-ext.xml
+++ b/api-ref/src/docbkx/ch_netconn-v2-ext.xml
@ -120,9 +120,11 @@
        </wadl:resources>
    </section>
    <section xml:id="security_groups">
-        <title>Security groups and rules (security-groups)</title>
-        <para>Lists, creates, shows information for, and deletes security groups and security group
-            rules.</para>
+        <title>Security groups (security-groups)</title>
+        <para>
+            Lists, creates, shows information for, updates, and deletes
+            security groups.
+        </para>
        <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
            <wadl:resource href="../wadls/netconn-api/src/security-groups.wadl#security_groups">
                <wadl:method href="#listSecGroups"/>
@ -130,8 +132,18 @@
            </wadl:resource>
            <wadl:resource href="../wadls/netconn-api/src/security-groups.wadl#security_group_id">
                <wadl:method href="#getSecGroup"/>
+                <wadl:method href="#updateSecGroup"/>
                <wadl:method href="#deleteSecGroup"/>
            </wadl:resource>
+        </wadl:resources>
+    </section>
+    <section xml:id="security_group-ruless">
+        <title>Security group rules (security-group-rules)</title>
+        <para>
+            Lists, creates, shows information for, and deletes security group
+            rules.
+        </para>
+        <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
            <wadl:resource
                href="../wadls/netconn-api/src/security-groups.wadl#security_groups_rules">
                <wadl:method href="#listSecGroupRules"/>
--- a/api-ref/src/wadls/compute-api/src/v2/common.ent
+++ b/api-ref/src/wadls/compute-api/src/v2/common.ent
@ -1776,7 +1776,8 @@
            project.
        </para>
    </wadl:doc>
-</param><param xmlns="http://wadl.dev.java.net/2009/02"
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
    name="maxPersonality" style="plain" required="true"
    type="xsd:int">
    <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1787,7 +1788,8 @@
            supplied on server build and rebuild for the project.
        </para>
    </wadl:doc>
-</param><param xmlns="http://wadl.dev.java.net/2009/02"
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
    name="maxPersonalitySize" style="plain" required="true"
    type="xsd:int">
    <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1799,7 +1801,8 @@
            set additional per-image personality limits.
        </para>
    </wadl:doc>
-</param><param xmlns="http://wadl.dev.java.net/2009/02"
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
    name="maxSecurityGroupRules" style="plain" required="true"
    type="xsd:int">
    <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1810,7 +1813,8 @@
            the project.
        </para>
    </wadl:doc>
-</param><param xmlns="http://wadl.dev.java.net/2009/02"
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
    name="maxSecurityGroups" style="plain" required="true"
    type="xsd:int">
    <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1820,7 +1824,8 @@
            The maximum number of security groups per server for the project.
        </para>
    </wadl:doc>
-</param><param xmlns="http://wadl.dev.java.net/2009/02"
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
    name="maxServerMeta" style="plain" required="true"
    type="xsd:int">
    <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1831,7 +1836,8 @@
            per server for the project.
        </para>
    </wadl:doc>
-</param><param xmlns="http://wadl.dev.java.net/2009/02"
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
    name="maxTotalCores" style="plain" required="true"
    type="xsd:int">
    <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1840,7 +1846,8 @@
        <para>
            The maximum number of cores for the project.</para>
        </wadl:doc>
-</param><param xmlns="http://wadl.dev.java.net/2009/02"
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
    name="maxTotalFloatingIps" style="plain" required="true"
    type="xsd:int">
    <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1867,7 +1874,8 @@
            The maximum number of servers at any one time for the project.
        </para>
    </wadl:doc>
-</param><param xmlns="http://wadl.dev.java.net/2009/02"
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
    name="maxTotalKeypairs" style="plain" required="true"
    type="xsd:int">
    <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1876,7 +1884,8 @@
        <para>
            The maximum number of key pairs per server for the project.</para>
        </wadl:doc>
-</param><param xmlns="http://wadl.dev.java.net/2009/02"
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
    name="maxTotalRAMSize" style="plain" required="true"
    type="xsd:int">
    <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1887,7 +1896,8 @@
            time for the project.
        </para>
        </wadl:doc>
-</param><param xmlns="http://wadl.dev.java.net/2009/02"
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
    name="maxServerGroups" style="plain" required="true"
    type="xsd:int">
    <wadl:doc xmlns="http://docbook.org/ns/docbook"
--- a/api-ref/src/wadls/netconn-api/src/api_samples/security-groups-update-req.json
+++ b/api-ref/src/wadls/netconn-api/src/api_samples/security-groups-update-req.json
@ -0,0 +1,6 @@
+{
+    "security_group": {
+        "name": "mysecgroup",
+        "description": "my security group"
+    }
+}
--- a/api-ref/src/wadls/netconn-api/src/api_samples/security-groups-update-resp.json
+++ b/api-ref/src/wadls/netconn-api/src/api_samples/security-groups-update-resp.json
@ -0,0 +1,9 @@
+{
+    "security_group": {
+        "rules": [],
+        "tenant_id": "a52cdb9cc7854a39a23d3af73a40899e",
+        "id": "01fbade5-b664-42f6-83ae-4e214f4263fa",
+        "name": "mysecgroup",
+        "description": "my security group"
+    }
+}
--- a/api-ref/src/wadls/netconn-api/src/common.ent
+++ b/api-ref/src/wadls/netconn-api/src/common.ent
@ -3,11 +3,40 @@
         in every request. -->
 <!ENTITY commonFaults '
 <response xmlns="http://wadl.dev.java.net/2009/02">
-    <representation mediaType="application/xml"
-        element="csapi:computeFault"/>
-    <representation mediaType="application/json"/>
+   <representation mediaType="application/xml" element="csapi:computeFault"/>
+   <representation mediaType="application/json"/>
+</response>
+<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
+   <representation mediaType="application/xml" element="csapi:serviceUnavailable"/>
+   <representation mediaType="application/json"/>
+</response>
+<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
+   <representation mediaType="application/xml" element="csapi:badRequest"/>
+   <representation mediaType="application/json"/>
+</response>
+<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
+   <representation mediaType="application/xml" element="csapi:unauthorized"/>
+   <representation mediaType="application/json"/>
+</response>
+<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
+   <representation mediaType="application/xml" element="csapi:forbidden"/>
+   <representation mediaType="application/json"/>
+</response>
+<response status="405" xmlns="http://wadl.dev.java.net/2009/02">
+   <representation mediaType="application/xml" element="csapi:badMethod"/>
+   <representation mediaType="application/json"/>
+</response>
+<response status="413" xmlns="http://wadl.dev.java.net/2009/02">
+   <representation mediaType="application/xml" element="csapi:overLimit"/>
+   <representation mediaType="application/json"/>
 </response>'>
-  <!ENTITY fault503 '
+<!-- Faults on GET -->
+<!ENTITY getFaults '
+<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
+   <representation mediaType="application/xml" element="csapi:itemNotFound"/>
+   <representation mediaType="application/json"/>
+</response>'>
+<!ENTITY fault503 '
 <response status="503" xmlns="http://wadl.dev.java.net/2009/02">
    <representation mediaType="application/xml"
        element="csapi:serviceUnavailable"/>
@ -5792,3 +5821,65 @@ router.</para>
        </para>
    </wadl:doc>
 </param>'>
+<!ENTITY securityGroupObjectParameter '
+<param xmlns="http://wadl.dev.java.net/2009/02"
+      name="security_group" 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 object">
+      <para>
+         A <code>security_group</code> object.
+      </para>
+   </wadl:doc>
+</param>'>
+<!ENTITY securityGroupsObjectParameter '
+<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>'>
+<!ENTITY securityGroupResponseParameters '
+<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="csapi:UUID"
+ 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="tenant_id" 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="Tenant ID">
+    <para>
+       The tenant.
+    </para>
+ </wadl:doc>
+</param>'>
+
--- a/api-ref/src/wadls/netconn-api/src/security-groups.wadl
+++ b/api-ref/src/wadls/netconn-api/src/security-groups.wadl
@ -18,39 +18,40 @@
    <resources base="https://servers.api.openstack.com/"
        xml:id="security-groups-v2.0">
        <resource id="version" path="//v2.0">
-                <resource id="security_groups" path="security-groups">
-                    <method href="#listSecGroups"/>
-                    <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://www.w3.org/1999/xhtml"
-                                xml:lang="EN">The unique identifier of
-                                the security group.</wadl:doc>
-                        </param>
-                        <method href="#getSecGroup"/>
-                        <method href="#deleteSecGroup"/>
-                    </resource>
+            <resource id="security_groups" path="security-groups">
+                <method href="#listSecGroups"/>
+                <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://www.w3.org/1999/xhtml"
+                            xml:lang="EN">The unique identifier of
+                            the security group.</wadl:doc>
+                    </param>
+                    <method href="#getSecGroup"/>
+                    <method href="#updateSecGroup"/>
+                    <method href="#deleteSecGroup"/>
                </resource>
-                <resource id="security_groups_rules"
-                    path="security-group-rules">
-                    <method href="#listSecGroupRules"/>
-                    <method href="#createSecGroupRule"/>
-                    <resource path="{rules-security-groups-id}"
-                        id="rules-security-groups-id">
-                        <param name="rules-security-groups-id"
-                            style="template" type="csapi:uuid">
-                            <wadl:doc
-                                xmlns="http://www.w3.org/1999/xhtml"
-                                xml:lang="EN">The unique identifier of
-                                the security group rule.</wadl:doc>
-                        </param>
-                        <method href="#getSecGroupRule"/>
-                        <method href="#deleteSecGroupRule"/>
-                    </resource>
+            </resource>
+            <resource id="security_groups_rules"
+                path="security-group-rules">
+                <method href="#listSecGroupRules"/>
+                <method href="#createSecGroupRule"/>
+                <resource path="{rules-security-groups-id}"
+                    id="rules-security-groups-id">
+                    <param name="rules-security-groups-id"
+                        style="template" type="csapi:uuid">
+                        <wadl:doc
+                            xmlns="http://www.w3.org/1999/xhtml"
+                            xml:lang="EN">The unique identifier of
+                            the security group rule.</wadl:doc>
+                    </param>
+                    <method href="#getSecGroupRule"/>
+                    <method href="#deleteSecGroupRule"/>
                </resource>
+            </resource>
        </resource>
    </resources>
    <method name="GET" id="listSecGroups">
@ -157,6 +158,49 @@
            </representation>
        </response> &fault401; &fault404;
    </method>
+    <method name="PUT" id="updateSecGroup">
+      <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update security group">
+         <para role="shortdesc">
+            Updates a specified security group.
+         </para>
+      </wadl:doc>
+      <request>
+         <representation mediaType="application/json">
+            <wadl:doc xmlns="http://docbook.org/ns/docbook"
+               xml:lang="EN" title="Update security group: JSON request">
+               <xsdxt:code href="api_samples/security-groups-update-req.json" />
+            </wadl:doc>
+            <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="Update security group: JSON response">
+               <xsdxt:code href="api_samples/security-groups-update-resp.json" />
+            </wadl:doc>
+            &securityGroupObjectParameter;
+            &securityGroupResponseParameters;
+         </representation>
+      </response> &commonFaults; &getFaults;
+   </method>
    <method name="DELETE" id="deleteSecGroup">
        <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
            title="Delete security group">