Discrepancy between bulk operation doc and implementation

Bug #1093538 reported by Salvatore Orlando
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Expired
Undecided
Unassigned

Bug Description

It seems that the bulk operations are not implemented as documented.
For instance, check create networks: http://docs.openstack.org/api/openstack-network/2.0/content/bulk_create_networks.html

Doc states that the request body should be in the following format:

{
"networks": [
   {
     "name": "sample_network_1",
     "admin_state_up": false
   },
   {
     "name": "sample_network_2",
     "admin_state_up": false
   }]
}

But actually the request body is submitted as follows:
{
"networks": [
   {
     "network":
           {
             "name": "sample_network_1",
              "admin_state_up": false
           },
    }
    { "network":
          {
            "name": "sample_network_2",
            "admin_state_up": false
          }
    }]
}

This could be a dob bug, a Quantum API bug, or both.

If we deem the way described in the documentation to be the correct one, than we need to do a non backward-compatible change in the Quantum API. One might argue however that this change is not backward incompatible as the API was wrong in the first place, and the fix should be backported to folsom.

Allowing both ways for specifying a bulk request is also feasible, but in general we should avoid supporting several ways of doing the same thing unless:
- it is not likely to cause confusion on end users
- does not require different code paths to be maintained

Tags: api
tags: added: api
Changed in quantum:
status: New → Confirmed
Revision history for this message
Cedric Brandily (cbrandily) wrote :

This bug is > 365 days without activity. We are unsetting assignee and milestone and setting status to Incomplete in order to allow its expiry in 60 days.

If the bug is still valid, then update the bug status.

Changed in neutron:
assignee: Salvatore Orlando (salvatore-orlando) → nobody
status: Confirmed → Incomplete
Revision history for this message
Launchpad Janitor (janitor) wrote :

[Expired for neutron because there has been no activity for 60 days.]

Changed in neutron:
status: Incomplete → Expired
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.