yahoo-eng-team team mailing list archive

[Launchpad Bug Tracker <1418635@xxxxxxxxxxxxxxxxxx>]

You have been subscribed to a public bug:

I'm implementing modules for SaltStack (not yet on GitHub) to create entities in OpenStack Neutron and came across quite a few problems 
with the API documentation:

* Link "Filtering and Column Selection" to 
  http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html
  404s

* Section http://developer.openstack.org/api-ref-
networking-v2.html#subnets

  * "POST /v2.0/subnets" aka "Create subnet"
    - 'id' is listed to be an optional parameter but the Neutron-API in 
      Icehouse refuses to set a user-selected ID
    - parameters 'dns_nameservers' and 'host_routes' missing from 
      documentation (undocumented extensions?)

  * "GET /v2.0/subnets" aka "List subnets"
    - can't filter by "allocation_pools" or "enable_dhcp"

  * "PUT /v2.0/subnets/​{subnet_id}​" aka "Update subnet"
    - parameters "allocation_pools", "network_id", "tenant_id", "id" listed 
      as optional request parameters but Neutron-API in Icehouse returns 
      "Cannot update read-only attribute $PARAMETER"

* Section http://developer.openstack.org/api-ref-
networking-v2.html#networks

  * "GET /v2.0/networks" aka "List networks"
    - parameter "shared" is ignored as a filter

* Section http://developer.openstack.org/api-ref-
networking-v2.html#layer3

  * "POST /v2.0/routers" aka "Create router"
    - Description states "router:external" and "external_gateway_info" are 
      valid request parameters but they're not listed in the table of 
      request parameters
    - What's the parameter router described as "A router object." supposed 
      to be? A router object in JSON/XML notation inside a router object in 
      JSON/XML notation?

I'll probably add more when implementing functions for managing routers
in Neutron.

** Affects: neutron
     Importance: Medium
     Assignee: Edgar Magana (emagana)
         Status: Confirmed


** Tags: api documentation in-stable-icehouse neutron
-- 
Neutron API reference is inconsistent and differs from implementation
https://bugs.launchpad.net/bugs/1418635
You received this bug notification because you are a member of Yahoo! Engineering Team, which is subscribed to neutron.