[api-ref]Cinder API Documentation for quota is wrong

Bug #1415214 reported by frédéric rossi
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Cinder
Fix Released
Medium
Andrey Volkov

Bug Description

In the Cinder API v2 Documentation, the section "Quota sets extension (os-quota-sets)" has many detail descriptions that are
 copy/paste from the nova API v2 extensions Documentation - section "Quota sets (os-quota-sets)"

As a consequence, the way to manage quotas in Cinder is not well documented.

Tags: api
affects: swift → cinder
Chris Friesen (cbf123)
affects: cinder → openstack-api-site
Changed in openstack-api-site:
assignee: nobody → Vilobh Meshram (vilobhmm)
Anne Gentle (annegentle)
Changed in openstack-api-site:
status: New → Confirmed
importance: Undecided → Medium
Atsushi SAKAI (sakaia)
tags: added: cinder
Revision history for this message
Anne Gentle (annegentle) wrote :

Is this still something you can work on Vilobh?

Atsushi SAKAI (sakaia)
summary: - Cinder API Documentation for quota is wrong
+ [api-ref]Cinder API Documentation for quota is wrong
affects: openstack-api-site → cinder
Revision history for this message
Sheel Rana (ranasheel2000) wrote :

Taken this bug ahead as there seems no activity since long..
I will submit patch soon...

Changed in cinder:
assignee: Vilobh Meshram (vilobhmm) → Sheel Rana (ranasheel2000)
Revision history for this message
Sheel Rana (ranasheel2000) wrote :

Dear Atsushi Sakai and Anne Gentle,

In case you come across any such existing bug in api-site for cinder, you can directly assign to me as I am going to update/clean whole API-Ref this week for cinder.
Thanks!!

Revision history for this message
Matthew Edmonds (edmondsw) wrote :

The os-quota-class-sets APIs seem to be missing entirely, and the os-quota-sets/​{tenant_id}​/​{user_id}​ APIs don't seem to actually exist in the code. I assume these are 2 of the things that this bug is supposed to fix, but wanted to state them clearly to make sure they're both noticed.

tags: added: api
removed: cinder
Revision history for this message
Matthew Edmonds (edmondsw) wrote :

actually I see this is specific to os-quota-sets, so I opened a new defect for os-quota-class-sets: https://bugs.launchpad.net/nova/+bug/1602400

I still expect the os-quota-sets/​{tenant_id}​/​{user_id}​ issue will be addressed here.

Revision history for this message
Cao ShuFeng (caosf-fnst) wrote :

Someone still work on this?

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

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

Changed in cinder:
assignee: Sheel Rana (ranasheel2000) → Andrey Volkov (avolkov)
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (master)

Reviewed: https://review.openstack.org/406001
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=cf8eee3f5b6ac8e9800587fd9fcc09efdfba5f7c
Submitter: Jenkins
Branch: master

commit cf8eee3f5b6ac8e9800587fd9fcc09efdfba5f7c
Author: Andrey Volkov <email address hidden>
Date: Fri Dec 2 11:25:05 2016 +0300

    api-ref cleanup: remove quotas user related calls

    os-quota-sets API call doesn't provide an ability to work with a user. PUT
    and DELETE methods return "Bad key" error message when user_id is used.
    GET method just ignores user_id key. In addition, there is not table for
    storing user related limits as in nova.

    This change removes the following calls from v1, v2, v3 API descriptions:
    - Show quotas for user
    - Update quotas for user
    - Delete quotas for user
    - Show quota details for user

    Partial-Bug: #1415214
    DocImpact

    Change-Id: Ib38f12132f8c4a1f4177e2450e734fffa400dad4

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/406056
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=8235e6e1e27bc6832095fb5c36957c162b7be8b1
Submitter: Jenkins
Branch: master

commit 8235e6e1e27bc6832095fb5c36957c162b7be8b1
Author: Andrey Volkov <email address hidden>
Date: Fri Dec 2 12:17:08 2016 +0300

    api-ref cleanup: required flag for tenants

    Current url scheme doesn't allow to skip admin_tenant_id
    or tenant_id params. This change marks them as required
    in api-ref. Get default quotas for a project signature
    was changed on correct also.

    Partial-Bug: #1415214

    Change-Id: I0c528d1c49346477b608a12f8f35ee6d47404bd3

Changed in cinder:
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.