[api-ref] Missing parameters in list share networks API documentation

Bug #1945711 reported by Carlos Eduardo
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Shared File Systems Service (Manila)
Fix Released
Low
Carlos Eduardo

Bug Description

The Manila API reference for share networks is not showing all parameters that can be used in order to filter out share networks while listing them.

https://docs.openstack.org/api-ref/shared-file-system/?expanded=list-back-end-storage-pools-detail,list-share-networks-detail#id253

It only mentions 4 parameters:
- project_id
- all_tenants
- name~
- description~

Instead, the documentation should list all parameters allowed, being:
- name and name~
- description and description~
- created_since
- created_before
- security-service
- neutron_net_id
- neutron_subnet_id
- network_type
- segmentation_id
- cidr
- ip_version

Changed in manila:
assignee: nobody → Carlos Eduardo (silvacarlose)
tags: added: api-ref doc low-hanging-fruit
Changed in manila:
importance: Undecided → Low
Revision history for this message
Goutham Pacha Ravi (gouthamr) wrote :

Thanks carlos - this would help when building tooling on top of the API, like https://review.opendev.org/c/openstack/openstacksdk/+/797176

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to manila (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/manila/+/812213

Changed in manila:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to manila (master)

Reviewed: https://review.opendev.org/c/openstack/manila/+/812213
Committed: https://opendev.org/openstack/manila/commit/b82175f30d50a8a88ffaeafff6d47f322ee4f43c
Submitter: "Zuul (22348)"
Branch: master

commit b82175f30d50a8a88ffaeafff6d47f322ee4f43c
Author: silvacarloss <email address hidden>
Date: Fri Oct 1 16:05:35 2021 -0300

    [api-ref] Fix missing parameters in share network list

    Share network list API referece was missing some filter parametes.
    Add the missing parameters so users can be aware of all the options
    available to query share networks.

    Closes-Bug: #1945711
    Change-Id: I21b4f48d0c41f052aca1d7dcd0f1b640cfa3084a

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

This issue was fixed in the openstack/manila 16.0.0.0rc1 release candidate.

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.