[Doc] Fix parameters in share network api-ref

* Change description parameter 'required' attr value
  from true to false.
* Add neutron_net_id and neutron_subnet_id in share
  network update API request parameter.

Closes-bug: #1727145
Change-Id: Iedde7a2a674a60e760b47d5eb2973f42d79223d1
This commit is contained in:
zhongjun 2017-10-25 11:33:02 +08:00 committed by zhongjun
parent c86e7658af
commit 3dba4d4715
3 changed files with 21 additions and 10 deletions

View File

@ -1661,10 +1661,10 @@ neutron_net_id:
in: body
required: true
type: string
neutron_net_id_1:
neutron_net_id_request:
description: |
The UUID of a neutron network when setting up a share network
with neutron. Specify both a neutron network and a neutron
The UUID of a neutron network when setting up or updating a share
network with neutron. Specify both a neutron network and a neutron
subnet that belongs to that neutron network.
in: body
required: false
@ -1675,10 +1675,10 @@ neutron_subnet_id:
in: body
required: true
type: string
neutron_subnet_id_1:
neutron_subnet_id_request:
description: |
The UUID of the neutron subnet when setting up a share network
with neutron. Specify both a neutron network and a neutron
The UUID of the neutron subnet when setting up or updating a share
network with neutron. Specify both a neutron network and a neutron
subnet that belongs to that neutron network.
in: body
required: false
@ -2457,6 +2457,12 @@ share_network_description:
in: body
required: true
type: string
share_network_description_request:
description: |
The share network description.
in: body
required: false
type: string
share_network_id:
description: |
The share network ID.

View File

@ -1,5 +1,8 @@
{
"share_network": {
"neutron_net_id": "998b42ee-2cee-4d36-8b95-67b5ca1f2109",
"neutron_subnet_id": "53482b62-2c84-4a53-b6ab-30d9d9800d06",
"name": "update my network",
"description": "i'm adding a description"
}
}

View File

@ -178,10 +178,10 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- neutron_net_id: neutron_net_id_1
- neutron_subnet_id: neutron_subnet_id_1
- neutron_net_id: neutron_net_id_request
- neutron_subnet_id: neutron_subnet_id_request
- name: share_network_name_request
- description: share_network_description
- description: share_network_description_request
Request example
---------------
@ -341,7 +341,9 @@ Request
- tenant_id: tenant_id_path
- share_network_id: share_network_id_path
- name: share_network_name_request
- description: share_network_description
- description: share_network_description_request
- neutron_net_id: neutron_net_id_request
- neutron_subnet_id: neutron_subnet_id_request
Request example
---------------