12 Commits

Author SHA1 Message Date
TommyLike
663c4e383f Correct 'os-show_image_metadata' API document
The 'os-show_image_metadata' API is outdated.
Rewrite the document, also correct the response
codes for image metadata's create/delete APIs.

Change-Id: I50a5b3571973564b8b5010b412d94303866e8dcd
2017-08-02 08:55:46 +08:00
TommyLike
4a1d7cc17f Add missing api-ref documents for group type specs
Added the missing api-ref documents for group specs APIs.

Change-Id: I6c04ec9c073bc227a34a502b42ffd615e689a241
2017-07-18 01:07:09 +00:00
wangxiyuan
95115ae7ab api-ref: add list manageable resource API
This patch did:
1. Add list manageable volumes API doc.
2. Add create and list manageable snapshots API doc.

Change-Id: Iccffb69b0ffb220f43258ee4c47d5d8964ae7836
Closes-bug: #1590977
2017-05-23 09:51:28 +08:00
TommyLike
8fcb809509 Add 'resource_filters' API to support generalized filtering
This patch adds ``resource_filters`` API to retrieve
configured resource filters.

APIImpact

Partial: blueprint generalized-filtering-for-cinder-list-resource
Depends-On: ff3d41b15abb2915de87830980147be51e5da971

Change-Id: I387268b277c46c72624a3d3b5eabf03724a7a847
2017-05-20 10:33:21 +08:00
Matt Riedemann
e13256469d Re-arrange v3 API reference
This applies an order to the v3 API reference documents.

The idea being how does a new user come into and use the API
and what APIs should they see first when getting started.
Naturally they need to know about versions and microversions
that are avaible. Then they might need to know about volume
types before creating a volume. Once they create a volume
and know the basics of working with volumes, they can start
to take some actions on volumes. After that it's just kind
of a random free for all of APIs and the only order applied
to the rest is sorting alphabetically by title.

Change-Id: I8956de3e6907582f7115430eb959813a13e87a49
2017-05-03 09:32:06 -05:00
Jenkins
ae1df67883 Merge "Add attachment API doc" 2017-05-03 00:31:04 +00:00
TommyLike
5c19a66950 Add attachment API doc
Add attachment API related Docs, please note we
use 'instance_uuid' in the request and 'instance' in
the response to represent the same thing 'server_id'.

DocImpact

Change-Id: I8bd5a9061af2b47fd227e8cf2f48f80f271bde14
2017-04-21 10:30:41 +08:00
Jenkins
0842264377 Merge "Adds API documentation for list and show hosts." 2017-04-11 04:16:03 +00:00
TommyLike
5545524142 [Doc] Add documentation for messages API.
Add documentation in v3 for messages API.

Change-Id: I6f9886c98eec4bb33fa1b4ad5b51a35a36762bfe
2017-03-23 20:22:49 +08:00
luqitao
7a3d344717 Adds API documentation for list and show hosts.
Adds v2 and v3 API documentation for list all hosts and show host details.

Change-Id: I43791fded823cd931c2d77a11fa502b2cb5f0105
Closes-Bug: #1558257
2017-03-14 05:36:24 -04: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
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