The parameters of share network update API are not correct in API-Ref doc

Bug #1727145 reported by zhongjun
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Shared File Systems Service (Manila)
Fix Released
Undecided
zhongjun

Bug Description

 manila help share-network-update
usage: manila share-network-update [--neutron-net-id <neutron-net-id>]
                                   [--neutron-subnet-id <neutron-subnet-id>]
                                   [--name <name>]
                                   [--description <description>]
                                   <share-network>

Update share network data.

Positional arguments:
  <share-network> Name or ID of share network to update.

Optional arguments:
  --neutron-net-id <neutron-net-id>, --neutron-net_id <neutron-net-id>, --neutron_net_id <neutron-net-id>, --neutron_net-id <neutron-net-id>
                        Neutron network ID. Used to set up network for share
                        servers. This option is deprecated and will be
                        rejected in newer releases of OpenStack Manila.
  --neutron-subnet-id <neutron-subnet-id>, --neutron-subnet_id <neutron-subnet-id>, --neutron_subnet_id <neutron-subnet-id>, --neutron_subnet-id <neutron-subnet-id>
                        Neutron subnet ID. Used to set up network for share
                        servers. This subnet should belong to specified
                        neutron network.
  --name <name> Share network name.
  --description <description>
                        Share network description.

https://developer.openstack.org/api-ref/shared-file-system/#update-share-network

Request¶
Name In Type Description
tenant_id path string The tenant ID in a multi-tenancy cloud.
share_network_id path string The UUID of the share network.
name (Optional) body string The name of a share network.
description body string The share network description.

zhongjun (jun-zhongjun)
summary: - The share network update API parameter is not correct in API-Ref doc
+ The parameters of share network update API are not correct in API-Ref
+ doc
Changed in manila:
assignee: nobody → zhongjun (jun-zhongjun)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to manila (master)

Reviewed: https://review.openstack.org/514901
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=3dba4d4715396362a5f311b15beaf4432a030a82
Submitter: Zuul
Branch: master

commit 3dba4d4715396362a5f311b15beaf4432a030a82
Author: zhongjun <email address hidden>
Date: Wed Oct 25 11:33:02 2017 +0800

    [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

Changed in manila:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/manila 6.0.0.0b2

This issue was fixed in the openstack/manila 6.0.0.0b2 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.