openstack/api-site
Code Issues Proposed changes

Merge "Fix response parameters table of "List/Show security group rule""

Browse Source
This commit is contained in:
Jenkins
2015-03-05 16:35:19 +00:00
committed by Gerrit Code Review
parent 06eb69493d f96e8cffaf
commit 59999fa8cd
1 changed files with 45 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
api-ref/src/wadls/netconn-api/src/security-groups.wadl
View File

@@ -310,6 +310,16 @@
group rule.</para> group rule.</para>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="api_samples/rules-security-groups-list-get-req-json-http.txt"
/>
</wadl:doc>
</representation>
</request>
<response status="200">
<param required="true" name="direction" style="plain" <param required="true" name="direction" style="plain"
type="xsd:string"> type="xsd:string">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
@@ -328,6 +338,12 @@
and addresses represented in CIDR must match the ingress or and addresses represented in CIDR must match the ingress or
egress rules.</wadl:doc> egress rules.</wadl:doc>
</param> </param>
<param required="true" name="id"
style="plain" type="csapi:uuid">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">The security
group rule ID.</wadl:doc>
</param>
<param required="true" name="security_group_id" <param required="true" name="security_group_id"
style="plain" type="csapi:uuid"> style="plain" type="csapi:uuid">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
@@ -335,7 +351,7 @@
group ID to associate with this security group group ID to associate with this security group
rule.</wadl:doc> rule.</wadl:doc>
</param> </param>
<param required="false" name="port_range_min" <param required="true" name="port_range_min"
style="plain" type="xsd:int"> style="plain" type="xsd:int">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">The minimum xmlns="http://docbook.org/ns/docbook">The minimum
@@ -346,7 +362,7 @@
protocol is ICMP, this value must be an ICMP protocol is ICMP, this value must be an ICMP
type.</wadl:doc> type.</wadl:doc>
</param> </param>
<param required="false" name="port_range_max" <param required="true" name="port_range_max"
style="plain" type="xsd:int"> style="plain" type="xsd:int">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">The maximum xmlns="http://docbook.org/ns/docbook">The maximum
@@ -356,14 +372,14 @@
protocol is ICMP, this value must be an ICMP protocol is ICMP, this value must be an ICMP
type.</wadl:doc> type.</wadl:doc>
</param> </param>
<param required="false" name="protocol" style="plain" <param required="true" name="protocol" style="plain"
type="xsd:string"> type="xsd:string">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">The protocol xmlns="http://docbook.org/ns/docbook">The protocol
that is matched by the security group rule. Valid that is matched by the security group rule. Valid
values are null, tcp, udp, and icmp.</wadl:doc> values are null, tcp, udp, and icmp.</wadl:doc>
</param> </param>
<param required="false" name="remote_group_id" <param required="true" name="remote_group_id"
style="plain" type="csapi:uuid"> style="plain" type="csapi:uuid">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">The remote xmlns="http://docbook.org/ns/docbook">The remote
@@ -371,7 +387,7 @@
rule. You can specify either <option>remote_group_id</option> or rule. You can specify either <option>remote_group_id</option> or
<option>remote_ip_prefix</option> in the request body.</wadl:doc> <option>remote_ip_prefix</option> in the request body.</wadl:doc>
</param> </param>
<param required="false" name="remote_ip_prefix" <param required="true" name="remote_ip_prefix"
style="plain" type="csapi:uuid"> style="plain" type="csapi:uuid">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">The remote xmlns="http://docbook.org/ns/docbook">The remote
@@ -381,16 +397,15 @@
attribute matches the specified IP prefix as the attribute matches the specified IP prefix as the
source IP address of the IP packet.</wadl:doc> source IP address of the IP packet.</wadl:doc>
</param> </param>
<representation mediaType="application/json"> <param required="true" name="tenant_id"
style="plain" type="csapi:uuid">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">The
<xsdxt:code ID of the tenant who owns the security group rule.
href="api_samples/rules-security-groups-list-get-req-json-http.txt" Only administrative users can specify a tenant ID other
/> than their own.</wadl:doc>
</wadl:doc> </param>
</representation> <representation
</request>
<response status="200"> <representation
mediaType="application/json"> mediaType="application/json">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
@@ -656,6 +671,12 @@
and addresses represented in CIDR must match the ingress or and addresses represented in CIDR must match the ingress or
egress rules.</wadl:doc> egress rules.</wadl:doc>
</param> </param>
<param required="true" name="id"
style="plain" type="csapi:uuid">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">The security
group rule ID.</wadl:doc>
</param>
<param required="true" name="security_group_id" <param required="true" name="security_group_id"
style="plain" type="csapi:uuid"> style="plain" type="csapi:uuid">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
@@ -708,7 +729,16 @@
or <option>remote_ip_prefix</option> in the request body. This or <option>remote_ip_prefix</option> in the request body. This
attribute matches the specified IP prefix as the attribute matches the specified IP prefix as the
source IP address of the IP packet.</wadl:doc> source IP address of the IP packet.</wadl:doc>
</param><representation </param>
<param required="false" name="tenant_id"
style="plain" type="csapi:uuid">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">The
ID of the tenant who owns the security group rule.
Only administrative users can specify a tenant ID other
than their own.</wadl:doc>
</param>
<representation
mediaType="application/json"> mediaType="application/json">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">