openstack/api-site
Code Issues Proposed changes

Merge "VPNaaS Endpoint Group API"

Browse Source
This commit is contained in:
Jenkins
2015-10-11 14:59:35 +00:00
committed by Gerrit Code Review
parent fe19096b6f 6f44e6da46
commit 317187a24e
8 changed files with 365 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
api-ref/src/wadls/netconn-api/src/api_samples/vpn/vpn-endpoint-group-create-req.json Normal file
View File

@@ -0,0 +1,10 @@
{
"endpoint_group": {
"endpoints": [
"10.2.0.0/24",
"10.3.0.0/24"
],
"type": "cidr",
"name": "peers"
}
}

13
api-ref/src/wadls/netconn-api/src/api_samples/vpn/vpn-endpoint-group-create-res.json Normal file
View File

@@ -0,0 +1,13 @@
{
"endpoint_group": {
"description": "",
"tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
"endpoints": [
"10.2.0.0/24",
"10.3.0.0/24"
],
"type": "cidr",
"id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
"name": "peers"
}
}

25
api-ref/src/wadls/netconn-api/src/api_samples/vpn/vpn-endpoint-group-list-res.json Normal file
View File

@@ -0,0 +1,25 @@
{
"endpoint_groups": [
{
"description": "",
"tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
"endpoints": [
"a3da778c-adfb-46db-88b3-d2ce53290a89"
],
"type": "subnet",
"id": "6bf34c7c-864c-4948-a6d4-db791669f9d4",
"name": "locals"
},
{
"description": "",
"tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
"endpoints": [
"10.2.0.0/24",
"10.3.0.0/24"
],
"type": "cidr",
"id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
"name": "peers"
}
]
}

13
api-ref/src/wadls/netconn-api/src/api_samples/vpn/vpn-endpoint-group-show-res.json Normal file
View File

@@ -0,0 +1,13 @@
{
"endpoint_group": {
"description": "",
"tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
"endpoints": [
"10.2.0.0/24",
"10.3.0.0/24"
],
"type": "cidr",
"id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
"name": "peers"
}
}

5
api-ref/src/wadls/netconn-api/src/api_samples/vpn/vpn-endpoint-group-update-req.json Normal file
View File

@@ -0,0 +1,5 @@
{
"endpoint_group": {
"description": "New description"
}
}

13
api-ref/src/wadls/netconn-api/src/api_samples/vpn/vpn-endpoint-group-update-res.json Normal file
View File

@@ -0,0 +1,13 @@
{
"endpoint_group": {
"description": "New description",
"tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
"endpoints": [
"10.2.0.0/24",
"10.3.0.0/24"
],
"type": "cidr",
"id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
"name": "peers"
}
}

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

@@ -4505,7 +4505,8 @@ router.</para>
<para>
The lifetime of the security association. The lifetime consists of a
unit and integer value. You can omit either the unit or value
portion of the lifetime.
portion of the lifetime. Default unit is seconds and default value
is 3600.
</para>
</wadl:doc>
</param>
@@ -4515,8 +4516,10 @@ router.</para>
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Units for lifetime of the security association. Default is
seconds.
The units for the lifetime of the security association. The lifetime
consists of a unit and integer value. You can omit either the unit
or value portion of the lifetime. Default unit is seconds and
default value is 3600.
</para>
</wadl:doc>
</param>
@@ -4526,7 +4529,10 @@ router.</para>
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Lifetime value, as a positive integer. Default is 3600 seconds.
The lifetime value, as a positive integer. The lifetime consists of
a unit and integer value. You can omit either the unit or value
portion of the lifetime. Default unit is seconds and default value
is 3600.
</para>
</wadl:doc>
</param>'>
@@ -4574,7 +4580,9 @@ router.</para>
<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 IKE policy.</para>
<para>
Human-readable description for the IKE policy.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@@ -4679,23 +4687,8 @@ router.</para>
</wadl:doc>
</param>'>
<!ENTITY ipsecRequestParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
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 IPSec policy. Does
not have to be unique.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
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 IPSec policy.</para>
</wadl:doc>
</param>
&ipsec_policy_nameRequestParameter;
&ipsec_policy_descriptionRequestParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="transform_protocol" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -4821,8 +4814,10 @@ router.</para>
<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 IPSec policy. Does
not have to be unique.</para>
<para>
Human-readable name for the IPSec policy. Does not have to be
unique.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@@ -4830,7 +4825,9 @@ router.</para>
<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 IPSec policy.</para>
<para>
Human-readable description for the IPSec policy.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@@ -4918,6 +4915,136 @@ router.</para>
<para>Lifetime value, as a positive integer. Default is 3600 seconds.</para>
</wadl:doc>
</param>'>
<!ENTITY vpnEndpointGroupCreateRequestParams '
<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 VPN endpoint group. Only administrative users can specify a
tenant ID other than their own.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="type" 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 type of the endpoints in the group. A valid value is
<code>subnet</code>, <code>cidr</code>, <code>network</code>,
<code>router</code>, or <code>vlan</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="endpoints" 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 endpoints of the same type, for the endpoint group.
The values will depend on type specified.
</para>
</wadl:doc>
</param>'>
<!ENTITY vpnEndpointGroupRequestParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
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 VPN endpoint group. Does not have to be
unique.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
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 VPN endpoint group.
</para>
</wadl:doc>
</param>'>
<!ENTITY vpnEndpointGroupListResponseParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="endpoint_groups" 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>VPN endpoint group objects.</para>
</wadl:doc>
</param>'>
<!ENTITY vpnEndpointGroupResponseParams '
<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 VPN endpoint group.</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 VPN endpoint group. Only administrative users can specify a
tenant ID other than their own.
</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 VPN endpoint group. 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 VPN endpoint group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="type" 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 type of the endpoints in the group. A valid value is
<code>subnet</code>, <code>cidr</code>, <code>network</code>,
<code>router</code>, or <code>vlan</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="endpoints" 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>
A list of endpoints of the same type for the endpoint group.
Theses values depend on the specified type.
</para>
</wadl:doc>
</param>'>
<!ENTITY connCreateRequestParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:uuid">
@@ -4993,8 +5120,10 @@ router.</para>
<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 IPSec connection. Does
not have to be unique.</para>
<para>
Human-readable name for the IPSec connection. Does not have to
be unique.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
@@ -5002,7 +5131,9 @@ router.</para>
<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 IPSec connection.</para>
<para>
Human-readable description for the IPSec connection.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@@ -5144,25 +5275,8 @@ router.</para>
</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 IPSec connection. 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 IPSec connection.</para>
</wadl:doc>
</param>
&ipsec_conn_nameRequestParameter;
&ipsec_conn_descriptionRequestParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="peer_address" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -5971,3 +6085,49 @@ router.</para>
</para>
</wadl:doc>
</param>'>
<!ENTITY ipsec_conn_nameRequestParameter '
<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 IPSec connection. Does not have to be
unique.
</para>
</wadl:doc>
</param>'>
<!ENTITY ipsec_conn_descriptionRequestParameter '
<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 IPSec connection.
</para>
</wadl:doc>
</param>'>
<!ENTITY ipsec_policy_nameRequestParameter '
<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 IPSec policy. Does not have to be
unique.
</para>
</wadl:doc>
</param>'>
<!ENTITY ipsec_policy_descriptionRequestParameter '
<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 IPSec policy.
</para>
</wadl:doc>
</param>'>

80
api-ref/src/wadls/netconn-api/src/os-vpnaasv2.0-ext.wadl
View File

@@ -3,7 +3,7 @@
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entites with xmllint -->
<!-- You can resolve the entities with xmllint -->
<!-- -->
<!-- xmllint -noent os-vpnaasv2.0-ext.wadl -->
<!--*******************************************************-->
@@ -71,6 +71,22 @@
<method href="#deleteIPSecPolicy"/>
</resource>
</resource>
<resource id="VpnEndpointGroups" path="endpointgroups">
<method href="#listVpnEndpointGroups"/>
<method href="#createVpnEndpointGroup"/>
<resource path="{endpoint_group_id}" id="endpoint_group_id">
<param name="endpoint_group_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="VPN endpoint group ID">The
UUID for the VPN endpoint group.</wadl:doc>
</param>
<method href="#showVpnEndpointGroup"/>
<method href="#updateVpnEndpointGroup"/>
<method href="#deleteVpnEndpointGroup"/>
</resource>
</resource>
<resource id="IPSecSiteConnections" path="ipsecsiteconnections">
<method href="#listIPSecSiteConnections"/>
<method href="#createIPSecSiteConnection"/>
@@ -293,6 +309,68 @@
<para>Removes the IPSec policy specified in the request.</para>
</wadl:doc>
<response status="204"/>&fault401; &fault404; &fault409;</method>
<!-- VPN endpoint group -->
<method name="POST" id="createVpnEndpointGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create VPN endpoint group">
<para role="shortdesc">Creates a VPN endpoint group.</para>
<para>
The endpoint group contains one or more endpoints of a specific
type that you can use to create a VPN connections.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/vpn/vpn-endpoint-group-create-req.json"/>
</wadl:doc> &vpnEndpointGroupRequestParams; &vpnEndpointGroupCreateRequestParams; </representation>
</request>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/vpn/vpn-endpoint-group-create-res.json"/>
</wadl:doc> &vpnEndpointGroupResponseParams; </representation>
</response>&fault400; &fault401;</method>
<method name="GET" id="listVpnEndpointGroups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List VPN endpoint groups">
<para role="shortdesc">Lists VPN endpoint groups.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/vpn/vpn-endpoint-group-list-res.json"/>
</wadl:doc> &vpnEndpointGroupListResponseParams; &vpnEndpointGroupResponseParams; </representation>
</response> &fault401; &fault403;</method>
<method name="GET" id="showVpnEndpointGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show VPN endpoint group">
<para role="shortdesc">Shows details for a specified VPN endpoint group.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/vpn/vpn-endpoint-group-show-res.json"/>
</wadl:doc> &vpnEndpointGroupResponseParams; </representation>
</response> &fault401; &fault403; &fault404;</method>
<method name="PUT" id="updateVpnEndpointGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update VPN endpoint group">
<para role="shortdesc">Updates settings for a specified VPN endpoint group.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/vpn/vpn-endpoint-group-update-req.json"/>
</wadl:doc> &vpnEndpointGroupRequestParams; </representation>
</request>
<response status="200"><representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/vpn/vpn-endpoint-group-update-res.json"/>
</wadl:doc> &vpnEndpointGroupResponseParams; </representation>
</response> &fault400; &fault401; &fault404;</method>
<method name="DELETE" id="deleteVpnEndpointGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove VPN endpoint group">
<para role="shortdesc">Removes a specified VPN endpoint group.</para>
</wadl:doc>
<response status="204"/>&fault401; &fault404; &fault409;</method>
<!-- IPSec site-to-site connection -->
<method name="POST" id="createIPSecSiteConnection">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create IPSec connection">