From 7ebbf8dd753b27df916fc7252700e3b4cf1d37bf Mon Sep 17 00:00:00 2001 From: "zhiguo.li" Date: Tue, 24 Oct 2017 09:41:13 +0800 Subject: [PATCH] [Doc] Add 'gateway' and 'mtu' in share network api-ref The attributes "gateway" and "mtu" are already added in Shared File Systems API since version 2.18 and 2.20. This patch provides description about them in response parameters, and adds them to response examples. Change-Id: I55e3a04453a9edd20b5ca4e1627ae8c3ae5601cc --- api-ref/source/parameters.yaml | 14 ++++++++++++++ ...hare-network-add-security-service-response.json | 4 +++- .../samples/share-network-create-response.json | 4 +++- ...e-network-remove-security-service-response.json | 4 +++- .../samples/share-network-show-response.json | 4 +++- .../samples/share-network-update-response.json | 4 +++- .../share-networks-list-detailed-response.json | 12 +++++++++--- api-ref/source/share-networks.inc | 12 ++++++++++++ 8 files changed, 50 insertions(+), 8 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 012ce6840d..1dc1956a60 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -2806,6 +2806,13 @@ share_network_description_request: in: body required: false type: string +share_network_gateway: + description: | + The gateway of a share network. + in: body + required: true + type: string + min_version: 2.18 share_network_id: description: | The share network ID. @@ -2848,6 +2855,13 @@ share_network_id_6: in: body required: true type: string +share_network_mtu: + description: + The MTU value of a share network. + in: body + required: true + type: integer + min_version: 2.20 share_network_name: description: | The name of a share network. diff --git a/api-ref/source/samples/share-network-add-security-service-response.json b/api-ref/source/samples/share-network-add-security-service-response.json index acc0d336c2..6a40160a1d 100644 --- a/api-ref/source/samples/share-network-add-security-service-response.json +++ b/api-ref/source/samples/share-network-add-security-service-response.json @@ -11,6 +11,8 @@ "cidr": null, "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", "network_type": null, - "description": null + "description": null, + "gateway": null, + "mtu": null } } diff --git a/api-ref/source/samples/share-network-create-response.json b/api-ref/source/samples/share-network-create-response.json index 84dead1752..adb8a595a1 100644 --- a/api-ref/source/samples/share-network-create-response.json +++ b/api-ref/source/samples/share-network-create-response.json @@ -11,6 +11,8 @@ "cidr": null, "project_id": "e10a683c20da41248cfd5e1ab3d88c62", "network_type": null, - "description": "This is my share network" + "description": "This is my share network", + "gateway": null, + "mtu": null } } diff --git a/api-ref/source/samples/share-network-remove-security-service-response.json b/api-ref/source/samples/share-network-remove-security-service-response.json index acc0d336c2..ca42cd61d2 100644 --- a/api-ref/source/samples/share-network-remove-security-service-response.json +++ b/api-ref/source/samples/share-network-remove-security-service-response.json @@ -11,6 +11,8 @@ "cidr": null, "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", "network_type": null, - "description": null + "description": null, + "gateway" :null, + "mtu": null } } diff --git a/api-ref/source/samples/share-network-show-response.json b/api-ref/source/samples/share-network-show-response.json index 00d2c93e39..c8a9e76693 100644 --- a/api-ref/source/samples/share-network-show-response.json +++ b/api-ref/source/samples/share-network-show-response.json @@ -11,6 +11,8 @@ "cidr": null, "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", "network_type": null, - "description": "descr" + "description": "descr", + "gateway": null, + "mtu": null } } diff --git a/api-ref/source/samples/share-network-update-response.json b/api-ref/source/samples/share-network-update-response.json index 75cc817831..f5e11d6904 100644 --- a/api-ref/source/samples/share-network-update-response.json +++ b/api-ref/source/samples/share-network-update-response.json @@ -11,6 +11,8 @@ "cidr": null, "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", "network_type": null, - "description": "i'm adding a description" + "description": "i'm adding a description", + "gateway": null, + "mtu": null } } diff --git a/api-ref/source/samples/share-networks-list-detailed-response.json b/api-ref/source/samples/share-networks-list-detailed-response.json index 53147d752f..98d64e6fa9 100644 --- a/api-ref/source/samples/share-networks-list-detailed-response.json +++ b/api-ref/source/samples/share-networks-list-detailed-response.json @@ -12,7 +12,9 @@ "cidr": null, "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", "network_type": null, - "description": "descr" + "description": "descr", + "gateway": null, + "mtu": null }, { "name": "net_my", @@ -26,7 +28,9 @@ "cidr": null, "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", "network_type": null, - "description": "desecr" + "description": "desecr", + "gateway": null, + "mtu": null }, { "name": null, @@ -40,7 +44,9 @@ "cidr": null, "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", "network_type": null, - "description": null + "description": null, + "gateway": null, + "mtu": null } ] } diff --git a/api-ref/source/share-networks.inc b/api-ref/source/share-networks.inc index 37d229ad1c..9544fd89f5 100644 --- a/api-ref/source/share-networks.inc +++ b/api-ref/source/share-networks.inc @@ -128,6 +128,8 @@ Response parameters - description: share_network_description - created_at: share_network_created_at - updated_at: share_network_updated_at + - gateway: share_network_gateway + - mtu: share_network_mtu Response example ---------------- @@ -182,6 +184,8 @@ Response parameters - description: share_network_description - created_at: share_network_created_at - updated_at: share_network_updated_at + - gateway: share_network_gateway + - mtu: share_network_mtu Response example ---------------- @@ -247,6 +251,8 @@ Response parameters - description: share_network_description - created_at: share_network_created_at - updated_at: share_network_updated_at + - gateway: share_network_gateway + - mtu: share_network_mtu Response example ---------------- @@ -310,6 +316,8 @@ Response parameters - description: share_network_description - created_at: share_network_created_at - updated_at: share_network_updated_at + - gateway: share_network_gateway + - mtu: share_network_mtu Response example ---------------- @@ -373,6 +381,8 @@ Response parameters - description: share_network_description - created_at: share_network_created_at - updated_at: share_network_updated_at + - gateway: share_network_gateway + - mtu: share_network_mtu Response example ---------------- @@ -441,6 +451,8 @@ Response parameters - description: share_network_description - created_at: share_network_created_at - updated_at: share_network_updated_at + - gateway: share_network_gateway + - mtu: share_network_mtu Response example ----------------