placement-api-ref: wrong parameter order

Bug #1728557 reported by Takashi Natsume
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Undecided
Takashi Natsume

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

tags: added: placement
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

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

Changed in nova:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

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 <email address hidden>
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
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 17.0.0.0b2

This issue was fixed in the openstack/nova 17.0.0.0b2 development milestone.

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.