10 Commits

Author SHA1 Message Date
Chhavi Agarwal
7310676502 Remove skip_validation_flag to False by default
Remove the skip_validation to force quota
validation.
Closes-bug: #1735337

Change-Id: Ib9596ac3ecc57a4f825b7d7118014e2ac14b2473
2017-12-06 07:08:17 -05:00
TommyLike
f70288d3e4 Add documentation for API 'validate_setup_for_nested_quota_use'
Documentation for API 'validate_setup_for_nested_quota_use' is
missing. Fix it.

Change-Id: Ica3d468856bad045c2bdd30a0f86924cc0aeb572
2017-10-11 16:04:36 +08:00
Sean McGinnis
fffdac20c2 api-ref: Make v3 enclosing objects consistent
Some request details provided information about the other
JSON value while others didn't. To make things consistent
and to make sure API consumers understand how the requests
need to be structured, this adds missing instances. It also
reorders some parameter lists to be a little more logical,
so even though we can't show the nested nature of some of
these, it at least doesn't show inner values before outer
ones.

This also corrects many errors seen while going through
the API ref. This is by no means exhaustive, and is already
somewhat out of the scope for this patch, so it is expected
that there are some (many) cases that are not addressed by
this patch. Those will be fixed with ongoing effort in
future patches.

Partial-bug: #1713517
Change-Id: I30964ba8d829778fd01174d639d44ba07e4b77a6
2017-09-01 09:54:34 -05:00
TommyLike
5551408fa3 Add API document for quota usage.
This patch adds a new API document for quota usage
as it has different response with quota show.

Change-Id: I0a55056f0962743015fec31ce2785aaf482c184d
2017-08-01 15:39:01 +08:00
wangxiyuan
107d080476 [Api-ref] Update quota-set APIs ref
The api-ref for quota-set is totally wrong. This patch updated
it to keep the same with Cinder's behavior.

Change-Id: Ib71d53e920a867ff080c929672f3120a639e3a28
Closes-bug: #1696347
2017-06-29 09:22:22 +08:00
Andrey Volkov
8235e6e1e2 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
2017-05-23 14:48:48 +00:00
Andrey Volkov
cf8eee3f5b 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
2017-03-07 14:55:55 +03:00
Nicholas Jones
aa9cabdb42 Fix Block Storage API reference nesting
Modifies heading levels in .inc files to allow nested display in
table of contents. Table of contents depth has been changed to allow
this.

Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
2017-02-09 08:37:27 -06:00
wangxiyuan
144ddd5a4c [api-ref]Change tenant to project
Keystone API v2 was deprecated in Mitaka and uses "project"
instead of "tenant" in V3 now.

This patch change the "tenant" to "project" in Cinder API v3 doc.

Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-26 23:18:32 +08:00
Mark T. Voelker
931e2f8161 Create v3 API Reference
The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref
was ever created.  This is problematic for end users and would hinder
the v3 API from being included in DefCore Interoperability Guidelines
somewhere down the line (since one of DefCore's Criteria[1] is that a
Capability be well documented).  This patch creates an API ref for v3.
It also adds a header to the v2 index to show that it is SUPPORTED,
whereas v3 is CURRENT.

[1]
http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77

Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e
Closes-Bug: #1616072
2016-09-19 14:33:01 -04:00