openstack/api-site
Code Issues Proposed changes

Fix wrong description of uuid and port parameters

Browse Source 
The current description of the uuid and port paramaters for server create state
that uuid is for nova-network and port is for neutron. In reality, uuid is for
the network uuid and port is for specifying an already existing port-id.

Change-Id: I1bf3b9d95b526c49628bb7dc715f47dcdcd4152b
Closes-Bug: #1407031
This commit is contained in:
Sam Yaple
2015-01-02 01:00:28 -06:00
parent 2843a2a554
commit 396e8cb08a
3 changed files with 45 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -248,13 +248,12 @@
<para>Optionally, you can create one or more NICs <para>Optionally, you can create one or more NICs
on the server.</para> on the server.</para>
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>nova-network</code> network, for a network, specify the UUID of the network
specify the UUID in the <code>uuid</code> in the <code>uuid</code> attribute in a
attribute in a <code>networks</code> <code>networks</code> object.</para>
object.</para>
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>neutron</code> network, specify for an already existing port, specify the
the UUID in the <code>port</code> attribute in port-id in the <code>port</code> attribute in
a <code>networks</code> object.</para> a <code>networks</code> object.</para>
<para>You can specify multiple NICs on the <para>You can specify multiple NICs on the
server.</para> server.</para>
@@ -267,11 +266,10 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>nova-network</code> network, for a network, specify the UUID of the network
specify the UUID in the <code>uuid</code> in the <code>uuid</code> attribute in a
attribute in a <code>networks</code> object. <code>networks</code> object. Required if you
Required if you omit the <code>port</code> omit the <code>port</code> attribute.</para>
attribute.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
@@ -281,8 +279,8 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>neutron</code> network, specify for an already existing port, specify the
the UUID in the <code>port</code> attribute in port-id in the <code>port</code> attribute in
a <code>networks</code> object. Required if a <code>networks</code> object. Required if
you omit the <code>uuid</code> you omit the <code>uuid</code>
attribute.</para> attribute.</para>

36
api-ref/src/wadls/volume-api/src/v1/common.ent
View File

@@ -214,21 +214,20 @@
name="networks" style="plain" type="xsd:string" name="networks" style="plain" type="xsd:string"
required="false"> required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>A <code>networks</code> object. By default, <para>A <code>networks</code> object. By default,
the server instance is provisioned with all the server instance is provisioned with all
isolated networks for the tenant.</para> isolated networks for the tenant.</para>
<para>Optionally, you can create one or more NICs <para>Optionally, you can create one or more NICs
on the server.</para> on the server.</para>
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>nova-network</code> network, for a network, specify the UUID of the network
specify the UUID in the <code>uuid</code> in the <code>uuid</code> attribute in a
attribute in a <code>networks</code> <code>networks</code> object.</para>
object.</para>
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>neutron</code> network, specify for an already existing port, specify the
the UUID in the <code>port</code> attribute in port-id in the <code>port</code> attribute in
a <code>networks</code> object.</para> a <code>networks</code> object.</para>
<para>You can specify multiple NICs on the <para>You can specify multiple NICs on the
server.</para> server.</para>
@@ -238,25 +237,24 @@
name="uuid" style="plain" type="xsd:string" name="uuid" style="plain" type="xsd:string"
required="false"> required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>nova-network</code> network, for a network, specify the UUID of the network
specify the UUID in the <code>uuid</code> in the <code>uuid</code> attribute in a
attribute in a <code>networks</code> object. <code>networks</code> object. Required if you
Required if you omit the <code>port</code> omit the <code>port</code> attribute.</para>
attribute.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="port" style="plain" type="xsd:string" name="port" style="plain" type="xsd:string"
required="false"> required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>neutron</code> network, specify for an already existing port, specify the
the UUID in the <code>port</code> attribute in port-id in the <code>port</code> attribute in
a <code>networks</code> object. Required if a <code>networks</code> object. Required if
you omit the <code>uuid</code> you omit the <code>uuid</code>
attribute.</para> attribute.</para>

36
api-ref/src/wadls/volume-api/src/v2/common.ent
View File

@@ -214,21 +214,20 @@
name="networks" style="plain" type="xsd:string" name="networks" style="plain" type="xsd:string"
required="false"> required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>A <code>networks</code> object. By default, <para>A <code>networks</code> object. By default,
the server instance is provisioned with all the server instance is provisioned with all
isolated networks for the tenant.</para> isolated networks for the tenant.</para>
<para>Optionally, you can create one or more NICs <para>Optionally, you can create one or more NICs
on the server.</para> on the server.</para>
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>nova-network</code> network, for a network, specify the UUID of the network
specify the UUID in the <code>uuid</code> in the <code>uuid</code> attribute in a
attribute in a <code>networks</code> <code>networks</code> object.</para>
object.</para>
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>neutron</code> network, specify for an already existing port, specify the
the UUID in the <code>port</code> attribute in port-id in the <code>port</code> attribute in
a <code>networks</code> object.</para> a <code>networks</code> object.</para>
<para>You can specify multiple NICs on the <para>You can specify multiple NICs on the
server.</para> server.</para>
@@ -238,25 +237,24 @@
name="uuid" style="plain" type="xsd:string" name="uuid" style="plain" type="xsd:string"
required="false"> required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>nova-network</code> network, for a network, specify the UUID of the network
specify the UUID in the <code>uuid</code> in the <code>uuid</code> attribute in a
attribute in a <code>networks</code> object. <code>networks</code> object. Required if you
Required if you omit the <code>port</code> omit the <code>port</code> attribute.</para>
attribute.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="port" style="plain" type="xsd:string" name="port" style="plain" type="xsd:string"
required="false"> required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>To provision the server instance with a NIC <para>To provision the server instance with a NIC
for a <code>neutron</code> network, specify for an already existing port, specify the
the UUID in the <code>port</code> attribute in port-id in the <code>port</code> attribute in
a <code>networks</code> object. Required if a <code>networks</code> object. Required if
you omit the <code>uuid</code> you omit the <code>uuid</code>
attribute.</para> attribute.</para>