api-ref: Almost parametes in parameters.yaml have unclear name

[Anh Tran]

Currently, the format of some parameters is: <paramater>_number.
For example: https://github.com/openstack/neutron-lib/blob/master/api-ref/source/v2/parameters.yaml#L237

Therefore, so hard to maintain and fix the wrong parameters.
We need to rename these parameters to this format:
<resource>_<paramater>
<resource>_<paramater>_path
<resource>_<paramater>_query
<resource>_<paramater>_notRequired

for more easer to maintain.

[Nate Johnston (nate-johnston)]

When I look at the line you link to, all I see is the line 'address:', which starts a standard YAML dictionary. So I am not sure what you are proposing. Can you show an example of how you would change the file?

[Anh Tran (trananhkma)]

Yes, In this file, many parameters are unclear, for example:
address, address_1, address_2, name, name_1, name_2.

My proposing is that we should change to other format, example:
L237: member_address,
L244: vip_address_notRequired,
L251: vip_address,
...

network_name,
network_name_notRequired,
network_name_query,
network_name_path,
...

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[Akihiro Motoki (amotoki)]

You don't need to file a bug. Instead please refer to blueprint neutron-in-tree-api-ref.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Change abandoned by Sindhu Devale (<email address hidden>) on branch: master
Review: https://review.openstack.org/362309

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Change abandoned by Anh Tran (<email address hidden>) on branch: master
Review: https://review.openstack.org/355794

[OpenStack Infra (hudson-openstack)]

Change abandoned by Anh Tran (<email address hidden>) on branch: master
Review: https://review.openstack.org/355803

[OpenStack Infra (hudson-openstack)]

Change abandoned by Anh Tran (<email address hidden>) on branch: master
Review: https://review.openstack.org/355817

[OpenStack Infra (hudson-openstack)]

Change abandoned by Anh Tran (<email address hidden>) on branch: master
Review: https://review.openstack.org/356318

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358396
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=ff2bb7429ccb55003522650288aacfadee1d2267
Submitter: Jenkins
Branch: master

commit ff2bb7429ccb55003522650288aacfadee1d2267
Author: Anindita Das <email address hidden>
Date: Mon Aug 22 04:41:53 2016 +0000

    api-ref: Fix api-ref for service-providers

    Added request parameters for the rest_method::
    GET /v2.0/service-providers

    Change-Id: Ieb73c0634cf74e9d379ed961391053f7a7bb07c7
    Partially-Implements: blueprint neutron-in-tree-api-ref
    Partial-Bug: #1613151

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358282
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=10907011b72afda23e31dc199fb0259e6df6c92c
Submitter: Jenkins
Branch: master

commit 10907011b72afda23e31dc199fb0259e6df6c92c
Author: Anindita Das <email address hidden>
Date: Sat Aug 20 22:35:20 2016 +0000

    api-ref: Fix api-ref for subnets

    Added request/response parameters for the rest_method::
       GET /v2.0/subnets
       POST /v2.0/subnets (Create Subnet)
       POST /v2.0/subnets (Bulk Create Subnet)
       GET /v2.0/subnets/{subnet_id} (Show Subnet Details)
       PUT /v2.0/subnets/{subnet_id} (Update Subnet)
       DELETE /v2.0/subnets/{subnet_id} (Delete Subnet)

    Co-Authored-By: Akihiro Motoki <email address hidden>
    Change-Id: I7cfba70c6805161ee9e26135fe08f5075e94d755
    Partially-Implements: blueprint neutron-in-tree-api-ref
    Partial-Bug: #1613151

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358949
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=f639d3e045c30074d6e81a8983197fbbe95cf115
Submitter: Jenkins
Branch: master

commit f639d3e045c30074d6e81a8983197fbbe95cf115
Author: Anindita Das <email address hidden>
Date: Tue Aug 23 04:27:25 2016 +0000

    api-ref: Fix api-ref for lbaas-v2

    Added request/response parameters for the rest_method::
    loadbalancers
    listeners
    pools
    members
    health-monitors

    Change-Id: I73d3848b74def8f0eb018314aeaf115bc72a0afd
    Partially-Implements: blueprint neutron-in-tree-api-ref
    Partial-Bug: #1613151

[OpenStack Infra (hudson-openstack)]

Change abandoned by Armando Migliaccio (<email address hidden>) on branch: master
Review: https://review.openstack.org/357048
Reason: This review is > 4 weeks without comment, and failed Jenkins the last time it was checked. We are abandoning this for now. Feel free to reactivate the review by pressing the restore button and leaving a 'recheck' comment to get fresh test results.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/413346
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=f5620b8387659f4760ecc17ab57924b9fb9b9852
Submitter: Jenkins
Branch: master

commit f5620b8387659f4760ecc17ab57924b9fb9b9852
Author: huangtianhua <email address hidden>
Date: Wed Dec 21 09:35:26 2016 +0800

    Improve floatingip api-ref

    The improvements in this patch:
    1. adds params 'subnet_id' and 'description' for
       creation request
    2. adds params 'description', 'created_at', 'updated_at'
       and 'revision_number' for creation/show/list/update
       response
    3. improves corresponding examples

    Partially-Implements: blueprint neutron-in-tree-api-ref
    Partial-Bug: #1613151
    Change-Id: I431ae6fb5e0760df4907a131aff6f2fac41ae71d

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/411457
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=f52c8cde20243e02c04cc1945e784fd96c1a04e3
Submitter: Jenkins
Branch: master

commit f52c8cde20243e02c04cc1945e784fd96c1a04e3
Author: nanaboat <email address hidden>
Date: Thu Dec 15 18:43:51 2016 +0000

    Fix api-ref for tags

    Cleaning up request/response parameters for tags extension methods
    Cleaning up error response for tag extension methods

    Partial-Bug: #1613151
    Change-Id: I3637546401cfbda8e6a30e2a2843055011a5b821

[OpenStack Infra (hudson-openstack)]

Change abandoned by Akihiro Motoki (<email address hidden>) on branch: master
Review: https://review.openstack.org/364579
Reason: https://review.openstack.org/422870

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/355773
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=87b8d4ada3eacb8207c6ba14f6cdca4c07b790e9
Submitter: Jenkins
Branch: master

commit 87b8d4ada3eacb8207c6ba14f6cdca4c07b790e9
Author: Akihiro Motoki <email address hidden>
Date: Wed Jan 18 16:55:49 2017 +0900

    api-ref: Refactoring parameters in Networks APIs

    * Correct and add parameters and their descriptions
    * Merge network related API into a single place
      (provider, multi-provider and vlan transparency)

    Note that this patch does not touch the order of the methods
    to make it easy to check the differences. The method order
    will be updated in a follow-up patch.

    Co-Authored-By: Akihiro Motoki <email address hidden>
    Partially-Implements: blueprint neutron-in-tree-api-ref
    Partial-Bug: #1613151
    Change-Id: I7794393b8927220255eb4e033f7409794e39c666

[Akihiro Motoki (amotoki)]

The bug reported here has been improved during the api-ref cleanup effort and most parameter names are now appropriate.
The only remaining action is to remove unused parameters.

Note that the guideline of parameter naming is documented in https://etherpad.openstack.org/p/neutron-api-ref-sprint and I have a plan to move this to neutron-lib document.

[Boden R (boden)]

Can we close this out?
Seems there haven't been any updates for awhile.