[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
This commit is contained in:
zhiguo.li 2017-10-24 09:41:13 +08:00 committed by Tom Barron
parent a7cf5117bc
commit 7ebbf8dd75
8 changed files with 50 additions and 8 deletions

View File

@ -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.

View File

@ -11,6 +11,8 @@
"cidr": null,
"project_id": "16e1ab15c35a457e9c2b2aa189f544e1",
"network_type": null,
"description": null
"description": null,
"gateway": null,
"mtu": null
}
}

View File

@ -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
}
}

View File

@ -11,6 +11,8 @@
"cidr": null,
"project_id": "16e1ab15c35a457e9c2b2aa189f544e1",
"network_type": null,
"description": null
"description": null,
"gateway" :null,
"mtu": null
}
}

View File

@ -11,6 +11,8 @@
"cidr": null,
"project_id": "16e1ab15c35a457e9c2b2aa189f544e1",
"network_type": null,
"description": "descr"
"description": "descr",
"gateway": null,
"mtu": null
}
}

View File

@ -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
}
}

View File

@ -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
}
]
}

View File

@ -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
----------------