os-quota-sets api doc is incorrect

Bug #1531903 reported by JF
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
Low
Diane Fleming

Bug Description

URL of the API page affected: http://developer.openstack.org/api-ref-compute-v2.1.html

Specifically the #os-quota-sets-v2.1 section.

In OpenStack Kilo, using the API as directed doesn't work properly. Specifically two things:

1- a PUT on /v2.1/​{tenant_id}​/os-quota-sets returns a "Not found" error.
2- a GET on /v2.1/​{tenant_id}​/os-quota-sets/detail does not return the current values of the quota, it always returns the same things as /v2.1/​{tenant_id}​/os-quota-sets/default

The correct API documentation was actually present on this page: http://developer.openstack.org/api-ref-compute-v2-ext.html

But that page was "unlinked" for some reason from your API docs and replaced with the incorrect implementation details.

The correct API usage should be as described on that page (api-ref-compute-v2), and it also works with compute-v2.1:

1- PUT should be on /v2.1/{admin-tenant-id}/os-quota-sets/{tenant-id}
2- GET should be on the same, /v2.1/{admin-tenant-id}/os-quota-sets/{tenant-id}

It is weird to have to specify the admin tenant id, but that's how the API seems to work....

I was able to find these details by debugging the openstack python client.

Tags: nova
Atsushi SAKAI (sakaia)
tags: added: nova
Revision history for this message
Atsushi SAKAI (sakaia) wrote :

Thank you for reporting.

Let me clearify. since os-quota-sets not in follows.
http://developer.openstack.org/api-ref-compute-v2.html
but exists in follows
http://developer.openstack.org/api-ref-compute-v2-ext.html
If this correct, please modify your bug description.
(you can edit bug description with pushing yellow button.)

Revision history for this message
JF (jfbibeau) wrote :

You're correct, thanks! I've corrected the bug description.

description: updated
Atsushi SAKAI (sakaia)
Changed in openstack-api-site:
status: New → Confirmed
Changed in openstack-api-site:
assignee: nobody → Diane Fleming (diane-fleming)
importance: Undecided → Low
milestone: none → mitaka
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to api-site (master)

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

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

Reviewed: https://review.openstack.org/268711
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=09deae9d7c3c66d4c850cf11fb298bdf294fffc6
Submitter: Jenkins
Branch: master

commit 09deae9d7c3c66d4c850cf11fb298bdf294fffc6
Author: Diane Fleming <email address hidden>
Date: Sat Jan 16 18:55:57 2016 -0600

    Update os-quota-sets extension

    - Add request and response parameter descriptions
    - Update URIs to show both admin_tenant_id and tenant_id

    Change-Id: Icb0c3657e3f2b46b75604b1a68db9693d023777a
    Closes-Bug: #1531903

Changed in openstack-api-site:
status: In Progress → Fix Released
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.