13 Commits

Author SHA1 Message Date
lihaijing
ba9eaf27af Api-ref: add 'all_tenants' API query option
Cinder REST API allows one to use a special query parameter
named "all_tenants" to list resources from all projects (tenants)
through the REST API:

`/v3/{project_id}/volumes/detail?all_tenants=1`

However, this option is hardly documented anywhere besides
`/v3/{project_id}/volumes/summary`. So add them.

Change-Id: Ia9cc9e20c3b333a054c90f07e952b61dfad8529e
Closes-Bug: #1743800
2018-02-07 01:11:49 +00:00
junboli
03d4539247 Fix incorrect description in api ref
most places use description of backup, such as groups,
consistency groups, snapshots .etc, this is incorrect
this patch is to correct them.

Change-Id: I079f0351c93b5f19e87a42b4b0b84ff086b83820
2017-12-26 15:06:18 +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
Sean McGinnis
127c8b5ab5 api-ref: Add group replication APIs
Add APIs introduced for group replication.

Also corrected a few incorrectly referenced group ID
body parameters while I was at it.

Closes-bug: 1700882
Change-Id: I253099072dba9fb6b03f562466aad0ff36b4052f
2017-08-27 09:49:19 -05:00
TommyLike
5c90bd64fe Add documentation for invalid filter keys
Now cinder will raise 400 if invalid filter
keys are specified, Update the corresponding
list APIs.

DocImpact
Depends-On: ff3d41b15abb2915de87830980147be51e5da971

Change-Id: I8419b374d7f743e7e9fc88e31c8c4f7d9470059b
2017-05-17 09:11:27 +08:00
lihaijing
e3288824c1 api-ref: fix rest method error in reset group and group-snapshot status.
In Block Storage API V3, reset group and group-snapshot status
actually use 'POST' method not 'PUT' mothod.

Change-Id: I1eb1f5576bfb0dc4c68e0067f8fa0453f1d3b9db
Closes-bug: #1676252
2017-03-27 11:19:58 +08:00
TommyLike
0059340be0 [Doc] Add missing parameter in v3 resource documentation
We have introduced a filter, sorter and pagination
in listing APIs. Adding the missing parameters
in api-ref.

Change-Id: Id32fb09ba659e2ba83910d37018de9e18302d5b6
2017-03-20 08:04:15 +00:00
TommyLike
085d44ba78 [4/4]Reset generic volume group and group snapshot statuses
Currently the administrator could only reset the generic group
status by db operation(include snapshots), this change intends
to add new admin actions to achieve these.

The patch list:
    1. group API [1].
    2. snapshot API [2].
    3. cinder client [3].
    4. documentation(this).

[1] 92bbacdcef302b09d85618644e1dfc4511841274
[2] 70171dc2ff6b085db90228d98638047bfc6984ba
[3] 9820cb6f38b6a68351776c333e5deacd38c5afc9

Partial-Implements: blueprint reset-cg-and-cgs-status

Change-Id: I9b985349ccb61e51a91d47d94393b68d901ac738
2017-02-13 19:38:22 +08: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
Jenkins
49ee50c6f6 Merge "[api-ref]Change tenant to project" 2017-02-05 22:26:37 +00: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
Gorka Eguileor
bc7c001d76 Fix api-ref status parameter
In the api ref most of our references to the status parameter are wrong,
since they are all referencing `status`, which in most cases is:

 status:
   description: |
     The ``status`` of the consistency group snapshot.

This patch fixes this by referencing the right status parameter.

TrivialFix

Change-Id: I3f76ad10bacd8c75f742efc3ff3395a7effc31b5
2017-01-26 13:28:42 +01:00
xing-yang
0e8ebbdf82 Add API Reference for groups
This patch adds API reference for group types,
groups, and group snapshots.

Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-08-02 18:04:58 -04:00