[api] entries in parameters.yaml have unclear name

Bug #1610777 reported by Anh Tran
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Wishlist
Anh Tran

Bug Description

Currently, so hard to maintain and fix the wrong parameters.
For example, 'List services' API: http://developer.openstack.org/api-ref/identity/v3/index.html?expanded=list-services-detail#list-services
Almost parameters of this API are wrong (Used parameters of other APIs).
So we need to correct them.
But the problem is that amost parameters have unclear name.
For example, in parameters.yaml of v3 APIs, there are unclear name:
name_1
name_2
name_3
name_n
...
interface_1
interface_2
...

We should rename all of them and correct them in API site.

Anh Tran (trananhkma)
Changed in keystone:
assignee: nobody → Anh Tran (trananhkma)
Changed in keystone:
status: New → In Progress
Revision history for this message
Anh Tran (trananhkma) wrote :
Revision history for this message
Henry Nash (henry-nash) wrote :

Agreed! I have already done a few of these - if you look at the v3 roles.inc, I used the naming scheme of

<paramater name>_query
<paramater name>_path
<paramater name>response_body
<paramater name>request_body
<paramater name>request_update_body

for the various places a give parameter might appear, and need different text and/or whether it was required or not.

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

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

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

Reviewed: https://review.openstack.org/351598
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=9a520bcfa88c4757407383e257759910ce7772a1
Submitter: Jenkins
Branch: master

commit 9a520bcfa88c4757407383e257759910ce7772a1
Author: Anh Tran <email address hidden>
Date: Fri Aug 5 15:30:07 2016 +0700

    api-ref: Correcting V3 Services APIs

    Correcting all parameters of services APIs.
    http://developer.openstack.org/api-ref/identity/v3/index.html?expanded=#list-services
    Rename parameters for more easy to maintain.

    Change-Id: I9819c19032c93bab9a613bf94b4b95dda722ced9
    Partial-Bug: #1610777

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/351600
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=6919253c8f6244148520c58e73c56953fa6c1773
Submitter: Jenkins
Branch: master

commit 6919253c8f6244148520c58e73c56953fa6c1773
Author: Anh Tran <email address hidden>
Date: Fri Aug 5 16:11:21 2016 +0700

    api-ref: Correcting V3 Endpoints APIs

    Correcting all parameters of Show/Create/List/Update/Delete APIs.
    http://developer.openstack.org/api-ref/identity/v3/index.html?#show-endpoint-details

    Change-Id: Iea796c4cd475bd0bb2879f4810abf9a645ff58ea
    Partial-Bug: #1610777

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/352260
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=8d5926a96226b6af3614f7d63080034cab227b52
Submitter: Jenkins
Branch: master

commit 8d5926a96226b6af3614f7d63080034cab227b52
Author: Anh Tran <email address hidden>
Date: Mon Aug 8 14:48:09 2016 +0700

    api-ref: Correcting V3 Domain config APIs

    Correcting parameters of APIs.
    http://developer.openstack.org/api-ref/identity/v3/index.html#domain-configuration

    Change-Id: Ia36dd13f813d3cf718a1d3bf9a7f4be482a1ce0a
    Partial-Bug: #1610777

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/352291
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=b3c838153fd8b4fcc8a7de8a917128f6f6b93fab
Submitter: Jenkins
Branch: master

commit b3c838153fd8b4fcc8a7de8a917128f6f6b93fab
Author: Anh Tran <email address hidden>
Date: Mon Aug 8 16:30:13 2016 +0700

    api-ref: Correcting V3 Authentication APIs

    http://developer.openstack.org/api-ref/identity/v3/index.html#authentication-and-token-management

    Change-Id: I17a3a974c36c0992c681100833f0443963edbf69
    Partial-Bug: #1610777

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/351636
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=ceaa09dcd75eeec2da6e47da5b3b527263e078fa
Submitter: Jenkins
Branch: master

commit ceaa09dcd75eeec2da6e47da5b3b527263e078fa
Author: Anh Tran <email address hidden>
Date: Fri Aug 5 17:24:26 2016 +0700

    api-ref: Correcting V3 Policies APIs

    Fixed in Create/List/Show/Update APIs.
    http://developer.openstack.org/api-ref/identity/v3/index.html#policies

    Change-Id: Ia3e4caf80c783ac2213444e9d6fecf39018187d8
    Partial-Bug: #1610777

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/352683
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=9241aeb485783e74d9bcf3d5d1501e8ceeeaf697
Submitter: Jenkins
Branch: master

commit 9241aeb485783e74d9bcf3d5d1501e8ceeeaf697
Author: Anh Tran <email address hidden>
Date: Tue Aug 9 09:56:14 2016 +0700

    api-ref: Correcting V3 Credentials APIs

    Correcting all parameters of Credentials APIs.
    http://developer.openstack.org/api-ref/identity/v3/index.html#credentials
    Rename parameters for more easy to maintain.

    Change-Id: I811558a646d41d2594777b4601fa223d13e193e7
    Partial-Bug: #1610777

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

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

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

Reviewed: https://review.openstack.org/353855
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=e4a82b3da1be6ddc44a162a27f615089f2e30567
Submitter: Jenkins
Branch: master

commit e4a82b3da1be6ddc44a162a27f615089f2e30567
Author: Anh Tran <email address hidden>
Date: Thu Aug 11 11:00:34 2016 +0700

    api-ref: Renaming parameters of V3-ext APIs

    Change-Id: I7f0ab81e3f8c0799bbcbbcd5a849603d7c2bde3a
    Partial-Bug: #1610777

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/352690
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=729c989c3e2e670f0be0bf8d08a034ac61956937
Submitter: Jenkins
Branch: master

commit 729c989c3e2e670f0be0bf8d08a034ac61956937
Author: Anh Tran <email address hidden>
Date: Tue Aug 9 10:32:20 2016 +0700

    api-ref: Correcting V3 OS-INHERIT APIs

    Correcting all parameters of OS-INHERIT APIs.
    http://developer.openstack.org/api-ref/identity/v3/index.html#os-inherit-api
    Finish on V3 APIs.

    Change-Id: I670130a2f874e1921ecdc8c06d756ece79505d50
    Partial-Bug: #1610777

Revision history for this message
Steve Martinelli (stevemar) wrote : Re: api-ref: Almost parametes in parameters.yaml have unclear name

This was completed by Anh Tran: https://review.openstack.org/#/q/owner:%22Anh+Tran%22+project:openstack/keystone

If anything else lingers we can clean them up individually

tags: added: api-ref
summary: - api-ref: Almost parametes in parameters.yaml have unclear name
+ [api] entries in parameters.yaml have unclear name
Changed in keystone:
importance: Undecided → Medium
status: In Progress → Fix Released
milestone: none → newton-3
importance: Medium → Wishlist
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Duplicates of this bug

Other bug subscribers