From 65841d4514a1c4c44749ed18a4f72bf1e8c64866 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Sat, 26 Oct 2013 18:44:07 +0900 Subject: [PATCH] Correct bulk subnet-create JSON example Add examples of bulk create responses Move the examples of bulk create requests to separate files Change-Id: Ia546b797b640b5827f75bf80237e1e62cac8b303 Closes-Bug: #1191694 --- v2.0/neutron-api-guide.xml | 73 +++++++++++-------------- v2.0/samples/network-post-req-bulk.json | 12 ++++ v2.0/samples/network-post-res-bulk.json | 22 ++++++++ v2.0/samples/port-post-req-bulk.json | 22 ++++++++ v2.0/samples/port-post-res-bulk.json | 47 ++++++++++++++++ v2.0/samples/subnet-post-req-bulk.json | 14 +++++ v2.0/samples/subnet-post-res-bulk.json | 40 ++++++++++++++ 7 files changed, 188 insertions(+), 42 deletions(-) create mode 100644 v2.0/samples/network-post-req-bulk.json create mode 100644 v2.0/samples/network-post-res-bulk.json create mode 100644 v2.0/samples/port-post-req-bulk.json create mode 100644 v2.0/samples/port-post-res-bulk.json create mode 100644 v2.0/samples/subnet-post-req-bulk.json create mode 100644 v2.0/samples/subnet-post-res-bulk.json diff --git a/v2.0/neutron-api-guide.xml b/v2.0/neutron-api-guide.xml index 7b1ec3a..a0f6ac0 100644 --- a/v2.0/neutron-api-guide.xml +++ b/v2.0/neutron-api-guide.xml @@ -1579,20 +1579,16 @@ Accept: application/json Bulk Create Networks: JSON Request POST v2.0/networks.json - Content-Type: application/json Accept: application/json - { -"networks": [ - { - "name": "sample_network_1", - "admin_state_up": false - }, - { - "name": "sample_network_2", - "admin_state_up": false - }] -} + + + + Bulk Create Networks: JSON Response + HTTP/1.1 201 OK +Content-Type: application/json; charset=UTF-8 + + The bulk create operation is always atomic. Either all or no networks in the request body @@ -1707,7 +1703,6 @@ content-type: application/json } -
Delete Network @@ -1853,12 +1848,11 @@ Accept: application/json List Subnets: JSON Request GET v2.0/subnets.json - Accept: application/json List Subnets: JSON Response - +
@@ -2018,29 +2012,14 @@ Accept: application/json POST /v2.0/subnets Content-Type: application/json Accept: application/json - { - "subnet":{ - "allocation_pools":[ - { - "end":"10.0.3.254", - "start":"10.0.3.2" - } - ], - "cidr":"10.0.3.0/24", - "dns_nameservers":[ - - ], - "enable_dhcp":true, - "gateway_ip":"10.0.3.1", - "host_routes":[ - - ], - "ip_version":4, - "name":"", - "network_id":"1a6f6006-9e0b-4f99-984c-96787ae66363", - "tenant_id":"f667b69e4d6749749ef3bcba7251d9ce" - } -} + + + + Bulk Create Subnets: JSON Response + HTTP/1.1 201 OK +Content-Type: application/json; charset=UTF-8 + + The bulk create operation is always atomic. Either all subnets or no subnets in the @@ -2494,10 +2473,20 @@ accept: application/json This operation enables you to create several ports in a single request. Specify a list of ports in the request body. - + + Bulk Create Ports: JSON Request + POST /v2.0/ports +Content-Type: application/json +Accept: application/json + + + + Bulk Create Ports: JSON Response + HTTP/1.1 201 OK +Content-Type: application/json; charset=UTF-8 + + + The &APIv2; always guarantees the atomic completion of the bulk operation. diff --git a/v2.0/samples/network-post-req-bulk.json b/v2.0/samples/network-post-req-bulk.json new file mode 100644 index 0000000..b948dd1 --- /dev/null +++ b/v2.0/samples/network-post-req-bulk.json @@ -0,0 +1,12 @@ +{ + "networks": [ + { + "admin_state_up": true, + "name": "sample_network_1" + }, + { + "admin_state_up": false, + "name": "sample_network_2" + } + ] +} diff --git a/v2.0/samples/network-post-res-bulk.json b/v2.0/samples/network-post-res-bulk.json new file mode 100644 index 0000000..5397dc4 --- /dev/null +++ b/v2.0/samples/network-post-res-bulk.json @@ -0,0 +1,22 @@ +{ + "networks": [ + { + "admin_state_up": true, + "id": "e6031bc2-901a-4c66-82da-f4c32ed89406", + "name": "sample_network_1", + "shared": false, + "status": "ACTIVE", + "subnets": [], + "tenant_id": "d19231fc08ec4bc4829b668040d34512" + }, + { + "admin_state_up": false, + "id": "64239a54-dcc4-4b39-920b-b37c2144effa", + "name": "sample_network_2", + "shared": false, + "status": "ACTIVE", + "subnets": [], + "tenant_id": "d19231fc08ec4bc4829b668040d34512" + } + ] +} diff --git a/v2.0/samples/port-post-req-bulk.json b/v2.0/samples/port-post-req-bulk.json new file mode 100644 index 0000000..c0567c6 --- /dev/null +++ b/v2.0/samples/port-post-req-bulk.json @@ -0,0 +1,22 @@ +{ + "ports": [ + { + "admin_state_up": true, + "device_id": "24df1d04-d5cb-41e1-8de5-61ed77c558df", + "name": "port1", + "network_id": "64239a54-dcc4-4b39-920b-b37c2144effa", + "security_groups": [ + "dbc107f4-afcd-4d5a-9352-f68f82241d5b" + ] + }, + { + "admin_state_up": false, + "name": "port2", + "network_id": "e6031bc2-901a-4c66-82da-f4c32ed89406", + "security_groups": [ + "8bf3f7cc-8471-40b1-815f-9da47e79775b", + "dbc107f4-afcd-4d5a-9352-f68f82241d5b" + ] + } + ] +} diff --git a/v2.0/samples/port-post-res-bulk.json b/v2.0/samples/port-post-res-bulk.json new file mode 100644 index 0000000..3ecfb52 --- /dev/null +++ b/v2.0/samples/port-post-res-bulk.json @@ -0,0 +1,47 @@ +{ + "ports": [ + { + "admin_state_up": true, + "allowed_address_pairs": [], + "device_id": "24df1d04-d5cb-41e1-8de5-61ed77c558df", + "device_owner": "", + "fixed_ips": [ + { + "ip_address": "10.56.4.2", + "subnet_id": "b0e7435c-1512-45fb-aa9e-9a7c5932fb30" + } + ], + "id": "4fa2a5b2-d758-449d-80d6-dff31df9e91e", + "mac_address": "fa:16:3e:63:b0:82", + "name": "port1", + "network_id": "64239a54-dcc4-4b39-920b-b37c2144effa", + "security_groups": [ + "dbc107f4-afcd-4d5a-9352-f68f82241d5b" + ], + "status": "DOWN", + "tenant_id": "d19231fc08ec4bc4829b668040d34512" + }, + { + "admin_state_up": false, + "allowed_address_pairs": [], + "device_id": "", + "device_owner": "", + "fixed_ips": [ + { + "ip_address": "192.168.199.2", + "subnet_id": "0468a7a7-290d-4127-aedd-6c9449775a24" + } + ], + "id": "d3c059b8-40fd-489a-8d17-97bde9370987", + "mac_address": "fa:16:3e:86:09:06", + "name": "port2", + "network_id": "e6031bc2-901a-4c66-82da-f4c32ed89406", + "security_groups": [ + "8bf3f7cc-8471-40b1-815f-9da47e79775b", + "dbc107f4-afcd-4d5a-9352-f68f82241d5b" + ], + "status": "DOWN", + "tenant_id": "d19231fc08ec4bc4829b668040d34512" + } + ] +} diff --git a/v2.0/samples/subnet-post-req-bulk.json b/v2.0/samples/subnet-post-req-bulk.json new file mode 100644 index 0000000..0bb8460 --- /dev/null +++ b/v2.0/samples/subnet-post-req-bulk.json @@ -0,0 +1,14 @@ +{ + "subnets": [ + { + "cidr": "192.168.199.0/24", + "ip_version": 4, + "network_id": "e6031bc2-901a-4c66-82da-f4c32ed89406" + }, + { + "cidr": "10.56.4.0/22", + "ip_version": 4, + "network_id": "64239a54-dcc4-4b39-920b-b37c2144effa" + } + ] +} diff --git a/v2.0/samples/subnet-post-res-bulk.json b/v2.0/samples/subnet-post-res-bulk.json new file mode 100644 index 0000000..f9f7ea9 --- /dev/null +++ b/v2.0/samples/subnet-post-res-bulk.json @@ -0,0 +1,40 @@ +{ + "subnets": [ + { + "allocation_pools": [ + { + "end": "192.168.199.254", + "start": "192.168.199.2" + } + ], + "cidr": "192.168.199.0/24", + "dns_nameservers": [], + "enable_dhcp": true, + "gateway_ip": "192.168.199.1", + "host_routes": [], + "id": "0468a7a7-290d-4127-aedd-6c9449775a24", + "ip_version": 4, + "name": "", + "network_id": "e6031bc2-901a-4c66-82da-f4c32ed89406", + "tenant_id": "d19231fc08ec4bc4829b668040d34512" + }, + { + "allocation_pools": [ + { + "end": "10.56.7.254", + "start": "10.56.4.2" + } + ], + "cidr": "10.56.4.0/22", + "dns_nameservers": [], + "enable_dhcp": true, + "gateway_ip": "10.56.4.1", + "host_routes": [], + "id": "b0e7435c-1512-45fb-aa9e-9a7c5932fb30", + "ip_version": 4, + "name": "", + "network_id": "64239a54-dcc4-4b39-920b-b37c2144effa", + "tenant_id": "d19231fc08ec4bc4829b668040d34512" + } + ] +}