openstack/api-site
Code Issues Proposed changes

Update pool operations to show provider attribute

Browse Source 
Closes-Bug: #1223835

Change-Id: I649032d22f5abb2691ed44ba13a3edb9064e1abe
author: diane fleming
This commit is contained in:
Diane Fleming 2014-05-05 11:17:32 -07:00
parent 8ef8103a30
commit d7a061430e
16 changed files with 185 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/src/wadls/netconn-api/src/api_samples/Member-post-req.json
View File

@ -2,7 +2,7 @@
"member":{
"protocol_port":"8080",
"address":"10.0.0.5",
"pool_id":"7803631d-f181-4500-b3a2-1b68ba2a75fd",
"pool_id":"e019fadf-5083-40ad-9480-4553343995b6",
"admin_state_up":true
}
}

6
api-ref/src/wadls/netconn-api/src/api_samples/Member-post-resp.json
View File

@ -4,10 +4,10 @@
"protocol_port":8080,
"weight":1,
"admin_state_up":true,
"tenant_id":"4fd44f30292945e481c7b8a0c8908869",
"pool_id":"7803631d-f181-4500-b3a2-1b68ba2a75fd",
"tenant_id":"5ef70662f8b34079a6eddb8da9d75fe8",
"pool_id":"e019fadf-5083-40ad-9480-4553343995b6",
"address":"10.0.0.5",
"status_description":null,
"id":"48a471ea-64f1-4eb6-9be7-dae6bbe40a0f"
"id":"a1a5aeb5-b3b6-4313-b6c2-904d764f0f75"
}
}

15
api-ref/src/wadls/netconn-api/src/api_samples/Pool-put-update-resp.json
View File

@ -2,19 +2,24 @@
"pool":{
"status":"PENDING_UPDATE",
"lb_method":"ROUND_ROBIN",
"protocol":"TCP",
"protocol":"HTTP",
"description":"",
"health_monitors":[
],
"subnet_id":"8032909d-47a1-4715-90af-5153ffe39861",
"tenant_id":"83657cfcdfe44cd5920adaf26c48ceea",
"subnet_id":"b338d9c6-beec-4404-8e1a-b608c324a8ad",
"tenant_id":"5ef70662f8b34079a6eddb8da9d75fe8",
"admin_state_up":true,
"name":"SuperPool",
"name":"my-updated-pool",
"health_monitors_status":[
],
"members":[
],
"id":"61b1f87a-7a21-4ad3-9dda-7f81d249944f",
"provider":"haproxy",
"status_description":null,
"id":"e019fadf-5083-40ad-9480-4553343995b6",
"vip_id":null
}
}

0
api-ref/src/wadls/netconn-api/samples/extension.json → api-ref/src/wadls/netconn-api/src/api_samples/extension.json
View File

0
api-ref/src/wadls/netconn-api/samples/extension.xml → api-ref/src/wadls/netconn-api/src/api_samples/extension.xml
View File

0
api-ref/src/wadls/netconn-api/samples/extensions.json → api-ref/src/wadls/netconn-api/src/api_samples/extensions.json
View File

0
api-ref/src/wadls/netconn-api/samples/extensions.xml → api-ref/src/wadls/netconn-api/src/api_samples/extensions.xml
View File

21
api-ref/src/wadls/netconn-api/src/api_samples/member-get-resp.json
View File

@ -2,23 +2,14 @@
"members":[
{
"status":"ACTIVE",
"protocol_port":8080,
"weight":1,
"admin_state_up":true,
"tenant_id":"83657cfcdfe44cd5920adaf26c48ceea",
"pool_id":"72741b06-df4d-4715-b142-276b6bce75ab",
"address":"10.0.0.4",
"protocol_port":80,
"id":"701b531b-111a-4f21-ad85-4795b7b12af6"
},
{
"status":"ACTIVE",
"weight":1,
"admin_state_up":true,
"tenant_id":"83657cfcdfe44cd5920adaf26c48ceea",
"pool_id":"72741b06-df4d-4715-b142-276b6bce75ab",
"address":"10.0.0.3",
"protocol_port":80,
"id":"beb53b4d-230b-4abd-8118-575b8fa006ef"
"tenant_id":"5ef70662f8b34079a6eddb8da9d75fe8",
"pool_id":"e019fadf-5083-40ad-9480-4553343995b6",
"address":"10.0.0.5",
"status_description":null,
"id":"a1a5aeb5-b3b6-4313-b6c2-904d764f0f75"
}
]
}

23
api-ref/src/wadls/netconn-api/src/api_samples/pool-get-detail-resp.json
View File

@ -5,18 +5,21 @@
"protocol":"HTTP",
"description":"",
"health_monitors":[
"466c8345-28d8-4f84-a246-e04380b0461d",
"5d4b5228-33b0-4e60-b225-9b727c1a20e7"
],
"subnet_id":"8032909d-47a1-4715-90af-5153ffe39861",
"tenant_id":"83657cfcdfe44cd5920adaf26c48ceea",
"subnet_id":"b338d9c6-beec-4404-8e1a-b608c324a8ad",
"tenant_id":"5ef70662f8b34079a6eddb8da9d75fe8",
"admin_state_up":true,
"name":"app_pool",
"members":[
"701b531b-111a-4f21-ad85-4795b7b12af6",
"beb53b4d-230b-4abd-8118-575b8fa006ef"
"name":"my-pool",
"health_monitors_status":[
],
"id":"72741b06-df4d-4715-b142-276b6bce75ab",
"vip_id":"4ec89087-d057-4e2c-911f-60a3b47ee304"
"members":[
],
"provider":"haproxy",
"status_description":null,
"id":"e019fadf-5083-40ad-9480-4553343995b6",
"vip_id":null
}
}

6
api-ref/src/wadls/netconn-api/src/api_samples/pool-post-req.json
View File

@ -1,9 +1,9 @@
{
"pool":{
"subnet_id":"8032909d-47a1-4715-90af-5153ffe39861",
"subnet_id":"b338d9c6-beec-4404-8e1a-b608c324a8ad",
"lb_method":"ROUND_ROBIN",
"protocol":"TCP",
"name":"NewPool",
"protocol":"HTTP",
"name":"my-pool",
"admin_state_up":true
}
}

17
api-ref/src/wadls/netconn-api/src/api_samples/pool-post-resp.json
View File

@ -1,20 +1,25 @@
{
"pool":{
"status":"PENDING_CREATE",
"lb_method":"STATIC_IP",
"protocol":"TCP",
"lb_method":"ROUND_ROBIN",
"protocol":"HTTP",
"description":"",
"health_monitors":[
],
"subnet_id":"8032909d-47a1-4715-90af-5153ffe39861",
"tenant_id":"83657cfcdfe44cd5920adaf26c48ceea",
"subnet_id":"b338d9c6-beec-4404-8e1a-b608c324a8ad",
"tenant_id":"5ef70662f8b34079a6eddb8da9d75fe8",
"admin_state_up":true,
"name":"NewPool",
"name":"my-pool",
"health_monitors_status":[
],
"members":[
],
"id":"a224402b-794b-4c0c-9d08-d95640a6f5a1",
"provider":"haproxy",
"status_description":null,
"id":"e019fadf-5083-40ad-9480-4553343995b6",
"vip_id":null
}
}

2
api-ref/src/wadls/netconn-api/src/api_samples/pool-put-update.req.json
View File

@ -1,5 +1,5 @@
{
"pool":{
"name":"SuperPool"
"name":"my-updated-pool"
}
}

23
api-ref/src/wadls/netconn-api/src/api_samples/pools-get-resp.json
View File

@ -6,19 +6,22 @@
"protocol":"HTTP",
"description":"",
"health_monitors":[
"466c8345-28d8-4f84-a246-e04380b0461d",
"5d4b5228-33b0-4e60-b225-9b727c1a20e7"
],
"subnet_id":"8032909d-47a1-4715-90af-5153ffe39861",
"tenant_id":"83657cfcdfe44cd5920adaf26c48ceea",
"subnet_id":"b338d9c6-beec-4404-8e1a-b608c324a8ad",
"tenant_id":"5ef70662f8b34079a6eddb8da9d75fe8",
"admin_state_up":true,
"name":"app_pool",
"members":[
"701b531b-111a-4f21-ad85-4795b7b12af6",
"beb53b4d-230b-4abd-8118-575b8fa006ef"
"name":"my-pool",
"health_monitors_status":[
],
"id":"72741b06-df4d-4715-b142-276b6bce75ab",
"vip_id":"4ec89087-d057-4e2c-911f-60a3b47ee304"
"members":[
],
"provider":"haproxy",
"status_description":null,
"id":"e019fadf-5083-40ad-9480-4553343995b6",
"vip_id":null
}
]
}

158
api-ref/src/wadls/netconn-api/src/common.ent
View File

@ -742,7 +742,6 @@
<para>A <code>floatingip</code> object.</para>
</wadl:doc>
</param>'>
<!ENTITY router-idParameter ''>
<!ENTITY floating-network-idParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="floating_network_id" style="plain" type="csapi:uuid">
@ -1023,59 +1022,10 @@
<!-- pools -->
<!ENTITY poolResponseParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="id" style="plain" type="csapi:uuid">
name="status" 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">
<para>The unique ID for the pool.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Owner of the pool. Only an admin user can specify a tenant ID other than its own.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="vip_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">
<para>The ID of the VIP with which the pool is associated.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="name" 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">
<para>Human readable name for the pool. Does not have to be unique.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="description" 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">
<para>Human readable description for the pool.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="subnet_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID of the network to which pool members belong.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="protocol" 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">
<para>The protocol of the pool. Valid values are TCP, HTTP, or HTTPS.</para>
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The status of the pool. Indicates whether the pool is operational.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@ -1087,11 +1037,43 @@
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="members" style="plain" type="xsd:list">
name="protocol" 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">
<para>List of members that belong to the pool.</para>
<para>The protocol of the pool. Valid values are TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="description" 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">
<para>Human readable description for the pool.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="health_monitors" style="plain" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>List of health monitors that are associated with the pool.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="subnet_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID of the network to which pool members belong.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Owner of the pool. Only an admin user can specify a tenant ID other than its own.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@ -1102,10 +1084,59 @@
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="status" style="plain" type="xsd:string">
name="name" 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">
<para>The status of the pool. Indicates whether the pool is operational.</para>
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Human readable name for the pool. Does not have to be unique.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="health_monitors_status" style="plain" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>List of statuses for associated health monitors, if any.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="members" style="plain" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>List of members that belong to the pool.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="provider" 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">
<para>Provider name of the load-balancer service.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="status_description" 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">
<para>Status description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The unique ID for the pool.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="vip_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">
<para>The ID of the VIP with which the pool is associated.</para>
</wadl:doc>
</param>' >
<!ENTITY poolCreateRequestParams '
@ -1171,6 +1202,14 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The administrative state of the pool. Valid values are true (UP) or false (DOWN).</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="provider" 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">
<para>Provider name of the load-balancer service.</para>
</wadl:doc>
</param>' >
<!ENTITY poolUpdateRequestParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
@ -1577,8 +1616,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The administrative state of the member. Valid values are true (UP) or false (DOWN).</para>
</wadl:doc>
</param>
' >
</param>' >
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>

41
api-ref/src/wadls/netconn-api/src/os-layer3-ext.wadl
View File

@ -411,10 +411,10 @@ Accept: application/json</programlisting>
Reference</citetitle>.</para>
</wadl:doc>
<response status="200"> &floating-ipsParameter;
&router-idParameter; &tenant-idParameter;
&floating-network-idParameter; &fixed-ip-addressParameter;
&floating-ip-addressParameter; &port-idParameter;
&idParameter; <representation mediaType="application/json"
&tenant-idParameter; &floating-network-idParameter;
&fixed-ip-addressParameter; &floating-ip-addressParameter;
&port-idParameter; &idParameter; <representation
mediaType="application/json"
element="csapi:floatingip">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -472,11 +472,10 @@ Accept: application/json</programlisting>
floating IP, the operation returns a <code>409</code>
error code.</para>
</wadl:doc>
<request> &floating-ipParameter; &router-idParameter;
&tenant-idParameter; &floating-network-idParameter;
&fixed-ip-addressParameter; &floating-ip-addressParameter;
&port-idParameter; &idParameter; <representation
mediaType="application/json"
<request> &floating-ipParameter; &tenant-idParameter;
&floating-network-idParameter; &fixed-ip-addressParameter;
&floating-ip-addressParameter; &port-idParameter;
&idParameter; <representation mediaType="application/json"
element="csapi:floatingip">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -488,10 +487,10 @@ Accept: application/json</programlisting>
</representation>
</request>
<response status="200"> &floating-ipParameter;
&router-idParameter; &tenant-idParameter;
&floating-network-idParameter; &fixed-ip-addressParameter;
&floating-ip-addressParameter; &port-idParameter;
&idParameter; <representation mediaType="application/json"
&tenant-idParameter; &floating-network-idParameter;
&fixed-ip-addressParameter; &floating-ip-addressParameter;
&port-idParameter; &idParameter; <representation
mediaType="application/json"
element="csapi:floatingip">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -522,10 +521,10 @@ Accept: application/json</programlisting>
Accept: application/json</programlisting>
</wadl:doc>
<response status="200"> &floating-ipParameter;
&router-idParameter; &tenant-idParameter;
&floating-network-idParameter; &fixed-ip-addressParameter;
&floating-ip-addressParameter; &port-idParameter;
&idParameter; <representation mediaType="application/json"
&tenant-idParameter; &floating-network-idParameter;
&fixed-ip-addressParameter; &floating-ip-addressParameter;
&port-idParameter; &idParameter; <representation
mediaType="application/json"
element="csapi:floatingip">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -581,10 +580,10 @@ Accept: application/json</programlisting>
</representation>
</request>
<response status="200"> &floating-ipParameter;
&router-idParameter; &tenant-idParameter;
&floating-network-idParameter; &fixed-ip-addressParameter;
&floating-ip-addressParameter; &port-idParameter;
&idParameter; <representation mediaType="application/json"
&tenant-idParameter; &floating-network-idParameter;
&fixed-ip-addressParameter; &floating-ip-addressParameter;
&port-idParameter; &idParameter; <representation
mediaType="application/json"
element="csapi:floatingip">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"

10
api-ref/src/wadls/netconn-api/src/os-networks.wadl
View File

@ -160,7 +160,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List extensions: JSON response">
<xsdxt:code href="../samples/extensions.json"
<xsdxt:code href="api_samples/extensions.json"
/>
</xsdxt:sample>
</wadl:doc>
@ -169,7 +169,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List extensions: XML response">
<xsdxt:code href="../samples/extensions.xml"/>
<xsdxt:code href="api_samples/extensions.xml"
/>
</xsdxt:sample>
</wadl:doc>
</representation>
@ -185,7 +186,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get extension details: JSON response">
<xsdxt:code href="../samples/extension.json"/>
<xsdxt:code href="api_samples/extension.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation>
@ -193,7 +195,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get extension details: XML response">
<xsdxt:code href="../samples/extension.xml"/>
<xsdxt:code href="api_samples/extension.xml"/>
</xsdxt:sample>
</wadl:doc>
</representation>