yahoo-eng-team team mailing list archive

[Takashi NATSUME <natsume.takashi@xxxxxxxxxxxxx>]

Public bug reported:

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

** Affects: nova
     Importance: Undecided
     Assignee: Takashi NATSUME (natsume-takashi)
         Status: In Progress


** Tags: doc docs placement

** Tags added: placement

-- 
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):
  In Progress

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