From 24bdf4009b217f34f95f800a0458a5cf4d0f8fde Mon Sep 17 00:00:00 2001 From: Ihar Hrachyshka Date: Thu, 31 Aug 2017 13:36:09 -0700 Subject: [PATCH] Document the new net-mtu-writable extension The extension was added in Pike. This patch is intended for backport. Closes-Bug: #1710083 Change-Id: Ie747df83e62b3c1d433441ab0a7c00b6b54ce5d4 --- api-ref/source/v2/networks.inc | 11 +++++++++-- .../v2/samples/networks/network-create-request.json | 3 ++- .../v2/samples/networks/network-create-response.json | 2 +- .../networks/network-multi-create-response.json | 1 + .../v2/samples/networks/network-update-request.json | 3 ++- .../v2/samples/networks/network-update-response.json | 2 +- 6 files changed, 16 insertions(+), 6 deletions(-) diff --git a/api-ref/source/v2/networks.inc b/api-ref/source/v2/networks.inc index d50315d58..e94601952 100644 --- a/api-ref/source/v2/networks.inc +++ b/api-ref/source/v2/networks.inc @@ -50,13 +50,17 @@ a VLAN transparecy of the network. 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. -MTU extension -============= +MTU extensions +============== The ``net-mtu`` extension allows plug-ins to expose the MTU that is guaranteed to pass through the data path of the segments in the network. This extension introduces a read-only ``mtu`` attribute. +A newer ``net-mtu-writable`` extension enhances ``net-mtu`` in that now the +``mtu`` attribute is available for write (both when creating as well as +updating networks). + DNS integration =============== @@ -158,6 +162,7 @@ Request - network: network - admin_state_up: network-admin_state_up-request - dns_domain: dns_domain-request + - mtu: mtu-request - name: network-name-request - port_security_enabled: network-port_security_enabled-request - provider:network_type: provider:network_type @@ -352,6 +357,7 @@ Request - network: network - admin_state_up: network-admin_state_up-request - dns_domain: dns_domain-request + - mtu: mtu-request - name: network-name-request - port_security_enabled: network-port_security_enabled-request - project_id: project_id-request @@ -454,6 +460,7 @@ Request - networks: networks - admin_state_up: network-admin_state_up-request - dns_domain: dns_domain-request + - mtu: mtu-request - name: network-name-request - port_security_enabled: network-port_security_enabled-request - project_id: project_id-request diff --git a/api-ref/source/v2/samples/networks/network-create-request.json b/api-ref/source/v2/samples/networks/network-create-request.json index 9cb5998f2..47773c6cb 100644 --- a/api-ref/source/v2/samples/networks/network-create-request.json +++ b/api-ref/source/v2/samples/networks/network-create-request.json @@ -3,6 +3,7 @@ "name": "sample_network", "admin_state_up": true, "dns_domain": "my-domain.org.", - "qos_policy_id": "6a8454ade84346f59e8d40665f878b2e" + "qos_policy_id": "6a8454ade84346f59e8d40665f878b2e", + "mtu": 1400 } } diff --git a/api-ref/source/v2/samples/networks/network-create-response.json b/api-ref/source/v2/samples/networks/network-create-response.json index 35f34d31b..e71d3087b 100644 --- a/api-ref/source/v2/samples/networks/network-create-response.json +++ b/api-ref/source/v2/samples/networks/network-create-response.json @@ -8,7 +8,7 @@ "created_at": "2016-03-08T20:19:41", "dns_domain": "my-domain.org.", "id": "4e8e5957-649f-477b-9e5b-f1f75b21c03c", - "mtu": 1500, + "mtu": 1400, "name": "net1", "port_security_enabled": true, "project_id": "9bacb3c5d39d41a79512987f338cf177", diff --git a/api-ref/source/v2/samples/networks/network-multi-create-response.json b/api-ref/source/v2/samples/networks/network-multi-create-response.json index 44a17b847..26e9526e6 100644 --- a/api-ref/source/v2/samples/networks/network-multi-create-response.json +++ b/api-ref/source/v2/samples/networks/network-multi-create-response.json @@ -5,6 +5,7 @@ "name": "net1", "admin_state_up": true, "dns_domain": "", + "mtu": 1500, "project_id": "9bacb3c5d39d41a79512987f338cf177", "tenant_id": "9bacb3c5d39d41a79512987f338cf177", "qos_policy_id": "6a8454ade84346f59e8d40665f878b2e", diff --git a/api-ref/source/v2/samples/networks/network-update-request.json b/api-ref/source/v2/samples/networks/network-update-request.json index 63ee48c2b..759d8f633 100644 --- a/api-ref/source/v2/samples/networks/network-update-request.json +++ b/api-ref/source/v2/samples/networks/network-update-request.json @@ -2,6 +2,7 @@ "network": { "dns_domain": "my-domain.org.", "name": "sample_network_5_updated", - "qos_policy_id": "6a8454ade84346f59e8d40665f878b2e" + "qos_policy_id": "6a8454ade84346f59e8d40665f878b2e", + "mtu": 1300 } } diff --git a/api-ref/source/v2/samples/networks/network-update-response.json b/api-ref/source/v2/samples/networks/network-update-response.json index 1c6e5c452..2912fcde6 100644 --- a/api-ref/source/v2/samples/networks/network-update-response.json +++ b/api-ref/source/v2/samples/networks/network-update-response.json @@ -8,7 +8,7 @@ "created_at": "2016-03-08T20:19:41", "dns_domain": "my-domain.org.", "id": "1f370095-98f6-4079-be64-6d3d4a6adcc6", - "mtu": 1500, + "mtu": 1300, "name": "sample_network_5_updated", "port_security_enabled": true, "project_id": "4fd44f30292945e481c7b8a0c8908869",