openstack/api-site
Code Issues Proposed changes

Merge "request_id is missing in the request param"

Browse Source
This commit is contained in:
Jenkins 2015-11-22 18:05:29 +00:00 committed by Gerrit Code Review
commit d0788c7158
2 changed files with 118 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -77,9 +77,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Returns a unique request ID that provides tracking for the
request. Provider must configure middleware to provide the request
ID.
A unique request ID that provides tracking for the request. Provider
must configure middleware to provide the request ID.
</para>
</wadl:doc>
</param>'>
@ -265,8 +264,8 @@
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.
A fixed IPv4 address for the NIC. Valid with a
<code>neutron</code> or <code>nova-networks</code> network.
</para>
</wadl:doc>
</param>
@ -329,7 +328,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Describes a path to the device for the volume that you want to use to
A path to the device for the volume that you want to use to
boot the server.
</para>
</wadl:doc>
@ -342,7 +341,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The source type for the volume. A valid value is <code>blank</code>,
The source type of the volume. A valid value is <code>blank</code>,
<code>snapshot</code>, <code>volume</code>, or <code>image</code>.
</para>
</wadl:doc>
@ -1007,7 +1006,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The reservation ID for the server.
The reservation ID of the server.
</para>
</wadl:doc>
</param>'>
@ -1026,7 +1025,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="adminPass">
<para>The administrative password for the server.</para>
<para>The administrative password of the server.</para>
</wadl:doc>
</param>'>
<!ENTITY metadataRequestParameter '
@ -1165,7 +1164,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="adminPass">
<para>
The administrative password for the server.
The administrative password of the server.
</para>
</wadl:doc>
</param>
@ -1175,7 +1174,7 @@
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>
The server ID.
The UUID of the server.
</para>
</wadl:doc>
</param>
@ -1226,7 +1225,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID for the host.
The UUID of the host.
</para>
</wadl:doc>
</param>'>
@ -1238,7 +1237,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID for the server.
The UUID of the server.
</para>
</wadl:doc>
</param>'>
@ -1249,8 +1248,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The image ID and links for the image
for your server instance.
<para>
The image ID and links for the image for your server instance.
</para>
</wadl:doc>
</param>'>
@ -1261,9 +1260,9 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The flavor ID and links for the flavor
for your server instance. A flavor is a combination of memory,
disk size, and CPUs.
<para>
The flavor ID and links for the flavor for your server instance. A
flavor is a combination of memory, disk size, and CPUs.
</para>
</wadl:doc>
</param>'>
@ -1472,7 +1471,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The tenant ID in a multi-tenancy cloud.</para>
<para>The UUID of the tenant in a multi-tenancy cloud.</para>
</wadl:doc>
</param>'>
<!ENTITY user_idResponseParameter '
@ -1495,7 +1494,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The tenant ID in a multi-tenancy cloud.
The UUID of the tenant in a multi-tenancy cloud.
</para>
</wadl:doc>
</param>'>
@ -1506,7 +1505,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the snapshot.</para>
<para>The UUID of the snapshot.</para>
</wadl:doc>
</param>'>
<!-- statusRequestParameter -->
@ -1529,7 +1528,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The flavor ID.</para>
<para>The UUID of the flavor.</para>
</wadl:doc>
</param>'>
<!-- keypairNameRequestParameter -->
@ -1569,7 +1568,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The cell ID.</para>
<para>The UUID of the cell.</para>
</wadl:doc>
</param>'>
<!ENTITY agentBuildIdRequestParameter '
@ -1578,7 +1577,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The agent build ID.</para>
<para>The UUID of the agent build.</para>
</wadl:doc>
</param>'>
<!ENTITY dnsEntryRequestParameter '
@ -1605,7 +1604,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the floating IP address.</para>
<para>The UUID of the floating IP address.</para>
</wadl:doc>
</param>'>
<!ENTITY instanceIdRequestParameter '
@ -1614,7 +1613,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the instance.</para>
<para>The UUID of the instance.</para>
</wadl:doc>
</param>'>
<!ENTITY networkIdRequestParameter '
@ -1623,7 +1622,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the network.</para>
<para>The UUID of the network.</para>
</wadl:doc>
</param>'>
<!-- networkLabelRequestParameter -->
@ -1653,7 +1652,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the hypervisor.</para>
<para>The UUID of the hypervisor.</para>
</wadl:doc>
</param>'>
<!ENTITY classIdRequestParameter '
@ -1662,7 +1661,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the quota class.</para>
<para>The UUID of the quota class.</para>
</wadl:doc>
</param>'>
<!ENTITY securityGroupIdRequestParameter '
@ -1671,7 +1670,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the security group.</para>
<para>The UUID of the security group.</para>
</wadl:doc>
</param>'>
<!ENTITY certificateIdRequestParameter '
@ -1680,7 +1679,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The certificate ID.</para>
<para>The UUID of the certificate.</para>
</wadl:doc>
</param>'>
<!ENTITY flavorExtraSpecKeyParameter '
@ -1699,7 +1698,17 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The UUID for the server.</para>
<para>The UUID of the server.</para>
</wadl:doc>
</param>'>
<!-- requestIdRequestParameter -->
<!ENTITY requestIdRequestParameter '
<param name="request_id" style="template" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the request.</para>
</wadl:doc>
</param>'>
<!-- consoleIdRequestParameter -->
@ -1709,7 +1718,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID for the console.</para>
<para>The UUID of the console.</para>
</wadl:doc>
</param>'>
<!-- keyRequestParameter -->
@ -1857,8 +1866,11 @@
Addresses information is hidden for any server in a state set in the
<code>osapi_hide_server_address_states</code> configuration option. By
default, servers in <code>building</code> state hide their addresses
information. See <link
xlink:href="http://docs.openstack.org/liberty/config-reference/content/list-of-compute-config-options.html">nova.conf - configuration options</link>.
information.
</para>
<para>
See
<link xlink:href="http://docs.openstack.org/liberty/config-reference/content/list-of-compute-config-options.html">nova.conf - configuration options</link>.
</para>
</wadl:doc>
</param>'>
@ -2008,7 +2020,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the minimum disk space in GB.</para>
<para>Integer value of the minimum disk space, in GB.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
@ -2049,7 +2061,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the minimum disk space in GB.</para>
<para>Integer value of the minimum disk space, in GB.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
@ -2147,8 +2159,8 @@
<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 quota set.
<para>
The ID of the quota set.
</para>
</wadl:doc>
</param>
@ -2337,8 +2349,8 @@
<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 quota set.
<para>
The ID of the quota set.
</para>
</wadl:doc>
</param>
@ -2523,7 +2535,7 @@
<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>
<para>The UUID of the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="name" required="true"
@ -2571,71 +2583,77 @@
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.
A unique ID for tracking the request. The request ID associated with the
request appears in the log lines for that request. By default, the
middleware configuration ensures that the request ID appears in the log
files.
</para>
</wadl:doc>
</param>'>
<!ENTITY securityGroupRequestParameters '
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
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:csapi="http://docs.openstack.org/compute/api/v2"
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:csapi="http://docs.openstack.org/compute/api/v2"
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:csapi="http://docs.openstack.org/compute/api/v2"
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:csapi="http://docs.openstack.org/compute/api/v2"
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:csapi="http://docs.openstack.org/compute/api/v2"
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:csapi="http://docs.openstack.org/compute/api/v2"
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 UUID of the security group.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
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:csapi="http://docs.openstack.org/compute/api/v2"
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:csapi="http://docs.openstack.org/compute/api/v2"
<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:csapi="http://docs.openstack.org/compute/api/v2"
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.</para>
</wadl:doc>
</param>'>
<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>'>
<!ENTITY securityGroupsObjectParameter '
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
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>'>
<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 securityGroupObjectParameter '
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="security_group" style="plain" type="xsd:string" required="true">
@ -2659,7 +2677,7 @@
<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>
<para>The UUID of the security group.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
@ -2886,7 +2904,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The service ID.</para>
<para>The UUID of the service.</para>
</wadl:doc>
</param>'>
<!ENTITY serviceStateResponseParameter '

1
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-instance-actions-v2.1.wadl
View File

@ -23,6 +23,7 @@
&serverIdRequestParameter;
<method href="#returnactionlist"/>
<resource id="request_id" path="{request_id}">
&requestIdRequestParameter;
<method href="#returninstancedata"/>
</resource>
</resource>