11 Commits

Author SHA1 Message Date
wangxiyuan
a71b838aad Api-ref: Add doc for update backup
Cinder added updating backup support in V3.9.

This patch added related api-ref.

Change-Id: I537cb609240e3bcfa130a116e1912d1b660a21f8
Closes-bug: #1607388
2017-06-07 02:07:30 +00:00
ghanshyam
b817ad2225 Fix api-ref for POST backup for optional name
name attribute in create backup request is optional but
api-ref does not say so.
- https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=create-a-backup-detail#backups-backups

Change-Id: I9ac456382ac8d3a27256762e3a56bd784abda201
Closes-Bug: #1678005
2017-05-28 16:43:33 -05:00
liuyamin
551c2963a0 Add the missing parameters in the api-ref of ext-backups.inc
Add "snapshot_id" and "data_timestamp" and "volume_name" to
the response parameters and error response code in the api-ref of
ext-backups.inc.

Change-Id: I2e3a6c737a74816e5e56b5a435a73e0bf501bec8
Closes-bug: #1676693
2017-05-22 14:01:27 +08: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
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
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
Sean McGinnis
7592c8e0d1 [api-ref] Correct status code of backup delete
Current doc states "Error repsonse codes:204". This should actually
by "Normal response code" and be 202 (Accepted) vs 204 (No Content).

Change-Id: I6e3855b2d1280de3e0fe6b5638feb54e9dfa4c10
Closes-bug: #1598237
2016-11-30 09:22:00 +00: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