yahoo-eng-team team mailing list archive
-
yahoo-eng-team team
-
Mailing list archive
-
Message #69549
[Bug 1728557] Re: placement-api-ref: wrong parameter order
Reviewed: https://review.openstack.org/516233
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=0965e7ae6e17c4413571792c7e3a13e8f11400d6
Submitter: Zuul
Branch: master
commit 0965e7ae6e17c4413571792c7e3a13e8f11400d6
Author: Takashi NATSUME <natsume.takashi@xxxxxxxxxxxxx>
Date: Mon Oct 30 18:42:47 2017 +0900
[placement] Fix parameter order in placement API ref
Optional parameters should be after required paramenters.
Parameters added in microversions should be after
original parameters.
So fix them.
Change-Id: I5e3f5df5601d3747debed273e09a8b9b18046a96
Closes-Bug: #1728557
** Changed in: nova
Status: In Progress => Fix Released
--
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1728557
Title:
placement-api-ref: wrong parameter order
Status in OpenStack Compute (nova):
Fix Released
Bug description:
Nova API reference guideline(*1) says:
------------------------------------------
3. Order the fields as follows
1. header
2. path
3. query
4. body
1. top level object (i.e. server)
2. required fields
3. optional fields
4. fields added in microversions (by the microversion they were added)
------------------------------------------
Optional fields should be after required fields.
But request bodies of the following APIs do not follows the guideline.
They are reference for placement API, but it should be fixed for consistency.
- PUT /resource_providers/{uuid}/inventories
- PUT /resource_providers/{uuid}/inventories/{resource_class}
*1: https://wiki.openstack.org/wiki/NovaAPIRef
To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1728557/+subscriptions
References