Cleanup unused params in parameters.yaml of api-ref

Bug #1745380 reported by Boden R
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
Undecided
Slawek Kaplonski

Bug Description

Today the neutron-lib/api-ref/source/v2/parameters.yaml has a bunch of unused params.

For example:
name_39
name_41
etc..

Any params in parameters.yaml that's not used in any .inc, is not needed and should be removed from parameters.yaml (it's dead code per say).

Tags: api-ref
Changed in neutron:
assignee: nobody → Slawek Kaplonski (slaweq)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to neutron-lib (master)

Fix proposed to branch: master
Review: https://review.openstack.org/538585

Changed in neutron:
status: New → In Progress
Revision history for this message
Boden R (boden) wrote :

Slawek thanks for this!

Food for thought; maybe we can add a tox target that checks for unused parameters.. We could run this manually on occasion or something. That's what we do with linkcheck: https://docs.openstack.org/neutron-lib/latest/contributor/releasing.html

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to neutron-lib (master)

Reviewed: https://review.openstack.org/538585
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=adefc64f21d8329ae5729d4a450b165728d29a8b
Submitter: Zuul
Branch: master

commit adefc64f21d8329ae5729d4a450b165728d29a8b
Author: Sławek Kapłoński <email address hidden>
Date: Sun Jan 28 10:34:38 2018 +0100

    [Api-ref] Cleanup parameters.yaml

    This commit:
    * removes all params defined in parameters.yaml which are
      not used in any .inc file,
    * rename "type_2" param to "vpn_endpoint_type" as it is easier to
      understand what it is,
    * remove "tenant_id" and "tenant_id-request" params and replace them
      with "project_id-body-optional" and "project_id-request" as both were
      the same

    Change-Id: I6acfc28514e3201b6035a6bbfedc08ec8e389899
    Closes-Bug: #1745380

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

This issue was fixed in the openstack/neutron-lib 1.14.0 release.

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.