← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1613151] [NEW] api-ref: Almost parametes in parameters.yaml have unclear name

 

Public bug reported:

Currently, the format of some parameters is: <paramater name>_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 name>
resource_<paramater name>_path
resource_<paramater name>_query
resource_<paramater name>_notRequired

for more easer to maintain.

** Affects: neutron
     Importance: Undecided
     Assignee: Anh Tran (trananhkma)
         Status: New

** Changed in: neutron
     Assignee: (unassigned) => Anh Tran (trananhkma)

** Description changed:

- Currently, the format of some parameters is: <paramater name>_<number>.
+ Currently, the format of some parameters is: <paramater name>_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:
- <paramater name>
- <paramater name>_path
- <paramater name>_query
- <paramater name>_notRequired
+ resource_<paramater name>
+ resource_<paramater name>_path
+ resource_<paramater name>_query
+ resource_<paramater name>_notRequired
  
  for more easer to maintain.

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to neutron.
https://bugs.launchpad.net/bugs/1613151

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

Status in neutron:
  New

Bug description:
  Currently, the format of some parameters is: <paramater name>_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 name>
  resource_<paramater name>_path
  resource_<paramater name>_query
  resource_<paramater name>_notRequired

  for more easer to maintain.

To manage notifications about this bug go to:
https://bugs.launchpad.net/neutron/+bug/1613151/+subscriptions


Follow ups