9 Commits

Author SHA1 Message Date
Jenkins
bb9692cb2c Merge "Add missing and incorrect response and error codes in cinder api-ref" 2017-04-11 04:15:55 +00:00
wangxiyuan
4339f17ac5 [api-ref] Update snapshot/volume's metadata api-ref
Volume/Snapshot contains two kinds API for it's metadata: POST/PUT

POST is used for creatng or replacing the volume/snapshot's
metadata items that match keys. It doesn't modify items that
are not in the request.

PUT is used for replacing all the volume/snapshot's metadata
with the key-value pairs in the request.

Cinder's api-ref description is wrong. This patch fixed the
description and added the missing POST/PUT request.

Change-Id: I51128d32c9f70ba57d7d4cf0634a16ca566db95f
2017-03-27 14:33:05 +08:00
wangzhenyu
f242907f01 Add missing and incorrect response and error codes in cinder api-ref
Closes-bug: 1674161

Change-Id: I963f0aa7de6c3df95c1341cac15da178032db1d3
2017-03-20 14:52:24 +00: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
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