From 9a2ce8e9afdb3c73194482df2394e87f57068669 Mon Sep 17 00:00:00 2001 From: Pritesh Kothari Date: Thu, 7 May 2015 16:12:24 -0700 Subject: [PATCH] Add API Documentation for Vlan Transparency Extension * Add API Documentation for Vlan Transparency Extension * Add json request/response code samples Closes-Bug: #1433838 Change-Id: I54738116bca046e8e30865d1726d0e7c2527ff3a --- api-ref/src/docbkx/ch_netconn-v2-ext.xml | 45 +++++-- .../network-vlan-transparent-post-req.json | 7 + .../network-vlan-transparent-post-resp.json | 13 ++ ...orks-vlan-transparent-get-detail-resp.json | 13 ++ .../networks-vlan-transparent-resp.json | 28 ++++ api-ref/src/wadls/netconn-api/src/common.ent | 9 ++ .../os-networks-vlan-transparency-ext.wadl | 122 ++++++++++++++++++ 7 files changed, 227 insertions(+), 10 deletions(-) create mode 100644 api-ref/src/wadls/netconn-api/src/api_samples/network-vlan-transparent-post-req.json create mode 100644 api-ref/src/wadls/netconn-api/src/api_samples/network-vlan-transparent-post-resp.json create mode 100644 api-ref/src/wadls/netconn-api/src/api_samples/networks-vlan-transparent-get-detail-resp.json create mode 100644 api-ref/src/wadls/netconn-api/src/api_samples/networks-vlan-transparent-resp.json create mode 100644 api-ref/src/wadls/netconn-api/src/os-networks-vlan-transparency-ext.wadl diff --git a/api-ref/src/docbkx/ch_netconn-v2-ext.xml b/api-ref/src/docbkx/ch_netconn-v2-ext.xml index 12a54a93b..550eb186d 100644 --- a/api-ref/src/docbkx/ch_netconn-v2-ext.xml +++ b/api-ref/src/docbkx/ch_netconn-v2-ext.xml @@ -58,17 +58,17 @@ Enables administrative users to define multiple physical bindings for an OpenStack Networking network and list or show details for networks with multiple physical bindings. - You cannot update any provider attributes. If you try to do so, an + You cannot update any provider attributes. If you try to do so, an error occurs. To delete a network with multiple physical bindings, issue a normal delete network request. To define multiple physical bindings for a network, include a - segments list in the request body of a POST - /v2.0/networks request. Each element in the segments list + segments list in the request body of a POST + /v2.0/networks request. Each element in the segments list has the same structure as the provider network attributes. These attributes are - provider:network_type, - provider:physical_network, and - provider:segmentation_id. The validation rules for these + provider:network_type, + provider:physical_network, and + provider:segmentation_id. The validation rules for these attributes are the same as for the Networks provider extended attributes. You cannot use both extensions at the @@ -78,6 +78,31 @@ +
+ VLAN transparency extension (networks) + + Enables plug-ins that support VLAN transparency to deliver + VLAN-transparent trunk networks. If the service does not support VLAN + transparency and a user requests a VLAN-transparent network, the + plug-in refuses to create one and returns an appropriate + error to the user. + + + You cannot update the vlan-transparent attribute. If + you try to do so, an error occurs. + + + To delete a VLAN-transparent network, issue a normal delete + network request. + + + The ML2 plug-in currently supports this extension. With the ML2 + plug-in, you can set the vlan-transparent attribute + to either true or false. + + +
Ports binding extended attributes (ports) Lists, creates, shows information for, and updates ports. @@ -188,7 +213,7 @@ ERROR Object within the service is not working. Look - for an extra attribute called error_details + for an extra attribute called error_details for a textual explanation on the error, its cause, and possibly a solution. @@ -243,7 +268,7 @@ ERROR Object within the service is not working. Look - for an extra attribute called error_details + for an extra attribute called error_details for a textual explanation on the error, its cause, and possibly a solution. @@ -321,13 +346,13 @@
Extra routes Adds extra routes to the - router resource. + router resource. You can update a router to add a set of nexthop IPs and destination CIDRs. The nexthop IP must be a part of a subnet to which the router interfaces are connected. You can - configure the routes attribute on only + configure the routes attribute on only update operations. diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/network-vlan-transparent-post-req.json b/api-ref/src/wadls/netconn-api/src/api_samples/network-vlan-transparent-post-req.json new file mode 100644 index 000000000..3e727836f --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/network-vlan-transparent-post-req.json @@ -0,0 +1,7 @@ +{ + "network": { + "name": "net1", + "admin_state_up": true, + "vlan_transparent": true + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/network-vlan-transparent-post-resp.json b/api-ref/src/wadls/netconn-api/src/api_samples/network-vlan-transparent-post-resp.json new file mode 100644 index 000000000..0af87ca8c --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/network-vlan-transparent-post-resp.json @@ -0,0 +1,13 @@ +{ + "network": { + "status": "ACTIVE", + "subnets": [], + "name": "net1", + "admin_state_up": true, + "vlan_transparent": true, + "tenant_id": "5831268f-1f52-49a7-88d5-bc0d7a74d523", + "router:external": false, + "shared": false, + "id": "3114f6e9-f9bc-4570-a941-7329b3b9759f" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/networks-vlan-transparent-get-detail-resp.json b/api-ref/src/wadls/netconn-api/src/api_samples/networks-vlan-transparent-get-detail-resp.json new file mode 100644 index 000000000..79e1c8db6 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/networks-vlan-transparent-get-detail-resp.json @@ -0,0 +1,13 @@ +{ + "network": { + "status": "ACTIVE", + "subnets": [], + "name": "net1", + "admin_state_up": true, + "tenant_id": "e926fd5a-e9f6-4dc8-8043-a352d974ceaf", + "router:external": false, + "vlan_transparent": true, + "shared": false, + "id": "20403fe9-6c9c-48e5-9edb-c3426a955068" + } +} diff --git a/api-ref/src/wadls/netconn-api/src/api_samples/networks-vlan-transparent-resp.json b/api-ref/src/wadls/netconn-api/src/api_samples/networks-vlan-transparent-resp.json new file mode 100644 index 000000000..7f03116eb --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/api_samples/networks-vlan-transparent-resp.json @@ -0,0 +1,28 @@ +{ + "networks": [ + { + "status": "ACTIVE", + "subnets": [], + "name": "net1", + "admin_state_up": true, + "tenant_id": "e252a863-92ee-480f-8bd8-71be77089499", + "shared": false, + "router:external": false, + "vlan_transparent": true, + "id": "f5e6d63c-04a4-4b2c-8b27-a9854412d5a7" + }, + { + "status": "ACTIVE", + "subnets": [ + "3daba37a-bced-4153-a4bb-d83dcc0552d9" + ], + "name": "private", + "admin_state_up": true, + "tenant_id": "109e5fae-d976-4791-84c7-6ae0bb3896c3", + "shared": true, + "router:external": false, + "vlan_transparent": false, + "id": "37e11503-3244-49f1-b92a-9f21bab017d9" + } + ] +} diff --git a/api-ref/src/wadls/netconn-api/src/common.ent b/api-ref/src/wadls/netconn-api/src/common.ent index 94702bec2..7795dcfd0 100644 --- a/api-ref/src/wadls/netconn-api/src/common.ent +++ b/api-ref/src/wadls/netconn-api/src/common.ent @@ -248,6 +248,15 @@ A segments object that defines one or more provider segments. '> + + + + The state of the network, which is VLAN transparent (true) + or not VLAN transparent (false). +'> diff --git a/api-ref/src/wadls/netconn-api/src/os-networks-vlan-transparency-ext.wadl b/api-ref/src/wadls/netconn-api/src/os-networks-vlan-transparency-ext.wadl new file mode 100644 index 000000000..bc1a72889 --- /dev/null +++ b/api-ref/src/wadls/netconn-api/src/os-networks-vlan-transparency-ext.wadl @@ -0,0 +1,122 @@ + + + + + + + + + + + %common; + + %common_project; +]> + + + + + + + + + + + + + + The UUID for the network of interest to + you. + + + + + + + + + + + + + + + Lists networks. The response shows the VLAN transparency + attribute. + + + &networkListParameters; + &networkVlanTransparentParameters; + + + + + + + + + + + Creates a VLAN-transparent network. + + + &networkCreateParameters; + &networkVlanTransparentParameters; + + + + + + &networkListParameters; + &networkVlanTransparentParameters; + + + + + + + + + + Shows details for a specified VLAN-transparent network. + + + &networkListParameters; + &networkVlanTransparentParameters; + + + + + + + +