[api-ref]Neutron API reference is inconsistent and differs from implementation
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
neutron |
Fix Released
|
Medium
|
Unassigned |
Bug Description
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://
404s
* Section http://
* "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/
- 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://
* "GET /v2.0/networks" aka "List networks"
- parameter "shared" is ignored as a filter
* Section http://
* "POST /v2.0/routers" aka "Create router"
- Description states "router:external" and "external_
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.
description: | updated |
no longer affects: | neutron |
Changed in openstack-api-site: | |
assignee: | nobody → Edgar Magana (emagana) |
tags: | added: neutron |
affects: | openstack-api-site → neutron |
summary: |
- Neutron API reference is inconsistent and differs from implementation + [api-ref]Neutron API reference is inconsistent and differs from + implementation |
Changed in neutron: | |
assignee: | Edgar Magana (emagana) → Umair Ahmad (umairr) |
Changed in neutron: | |
assignee: | Umair Ahmad (umairr) → nobody |
Changed in neutron: | |
assignee: | nobody → bhavana Kappala (bhavan) |
Changed in neutron: | |
assignee: | bhavana Kappala (bhavan) → nobody |
* Section http:// developer. openstack. org/api- ref-networking- v2.html# layer3 {router_ id}/add_ router_ interface" aka "Add interface to router"
* "PUT /v2.0/routers/
- "If you specify a subnet ID in the request body", "If you specify a port ID in the request body"
but no parameters "subnet_id", port_id in table of request parameters