openstack/api-site
Code Issues Proposed changes

Merge "Fix description of security_groups attribute for create servers"

Browse Source
This commit is contained in:
Jenkins
2014-04-21 13:22:59 +00:00
committed by Gerrit Code Review
parent cc617c0fb1 3867d191d0
commit 4aeee6c53e
4 changed files with 46 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
api-ref/src/wadls/compute-api/src/v2/api_samples/server-post-req.json
View File

@@ -9,6 +9,14 @@
{
"uuid":"d32019d3-bc6e-4319-9c1d-6722fc136a22"
}
],
"security_groups":[
{
"name":"default"
},
{
"name":"another-secgroup-name"
}
]
}
}

4
api-ref/src/wadls/compute-api/src/v2/api_samples/server-post-req.xml
View File

@@ -20,4 +20,8 @@
<networks>
<network uuid="0ef47ac7-6797-4e01-8a47-ed26ec3aaa56"/>
</networks>
<security_groups>
<security_group name="default"/>
<security_group name="another-secgroup-name"/>
</security_groups>
</server>

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

@@ -151,19 +151,30 @@
<option value="ALL"/>
</param>'>
<!-- Server Create Parameters -->
<!ENTITY serverCreateParameters '<param xmlns="http://wadl.dev.java.net/2009/02"
name="security_group" style="query" required="true"
<!ENTITY serverCreateParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="security_groups" style="plain" 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>The name of the security
group. If blank, the server is created in the
xml:lang="EN"><para>A <code>security_groups</code>
object.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="security_group" style="plain" 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>One or more
<code>security_group</code> objects.
Specify the name of the security group in the
<code>name</code> attribute. If you omit
this attribute, the server is created in the
<code>default</code> security
group.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="user_data" style="query" required="false"
name="user_data" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@@ -172,11 +183,11 @@
encoded.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_zone" style="query"
name="availability_zone" style="plain"
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>The availability zone in which
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The availability zone in which
to launch the server.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
@@ -214,8 +225,8 @@
name="networks" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>networks</code> object. By default,
the server instance is provisioned with all
isolated networks for the tenant.</para>
@@ -238,8 +249,8 @@
name="uuid" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>To provision the server instance with a NIC
for a <code>nova-network</code> network,
specify the UUID in the <code>uuid</code>
@@ -252,8 +263,8 @@
name="port" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>To provision the server instance with a NIC
for a <code>neutron</code> network, specify
the UUID in the <code>port</code> attribute in
@@ -266,8 +277,8 @@
name="fixed_ip" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A fixed IPv4 address for the NIC. Valid with
a <code>neutron</code> or
<code>nova-networks</code> network.</para>
@@ -291,7 +302,8 @@
size of the metadata key and value is 255
bytes each.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="personality" style="plain" required="false"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="personality" style="plain" required="false"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"

6
api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl
View File

@@ -414,8 +414,10 @@
title="Create server">
<para role="shortdesc">Creates a server.</para>
</wadl:doc>
<request> &serverCreateParameters; <representation
mediaType="application/xml" element="csapi:server"> </representation>
<request>
&serverCreateParameters;
<representation mediaType="application/xml"
element="csapi:server"> </representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">