12 Commits

Author SHA1 Message Date
Ken'ichi Ohmichi
c8bfb4b8eb Remove XML description from media-types
Since the commit If98db25f1f4032725444c3959acb9aad8f869802 XML
support has been removed from Cinder API. And the version API
doesn't return XML entity on media-types.
Then this patch removes the entity from sample files.

Change-Id: I782d5cf7a152647254d9a36edcc7352000139dc3
2017-03-22 11:01:35 -07:00
Eric Harney
52e0f003fb Revert "Remove v1 API reference"
The v1 API is still in the tree, even if it is off by
default and deprecated.  We need to keep documentation on
how it works at least until we remove the code.  This was
published to [1] which was the primary way to find this
information, and it is now missing.

[1] https://developer.openstack.org/api-ref/block-storage/v1/

This marks v1 as deprecated in the toctree.

This reverts commit 8139f7f108786112ec6eef47228ecbc7f54b6f47.

Change-Id: Ic9d0fcce5ca0f8455c212292664b8f9694edfce3
2017-03-15 17:04:22 -04:00
Sean McGinnis
8139f7f108 Remove v1 API reference
The v1 API has been deprecated for a long time, and we would like to
eventually be able to completely remove it. All new development should
be using v2 or v3, ideally the latter.

This removes the v1 API info from our api-ref in the hopes of further
discouraging API consumers from using the v1 API.

Change-Id: Ib14749fb6bae88e89af28493156b478c2099fd17
2017-02-25 11:44:49 -06: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
a3602906a3 Fix the api-ref CI failure
Our Api-ref CI job failed due to the change[1] in os-api-ref.

This patch fixed the issue.

[1]: I8686006339b82ed5465dd8e4d3a8b15f85ee897c

Change-Id: I00458bef8729e9ff877b4e38563f5d133de47cf5
2017-01-25 14:04:45 +00:00
Jenkins
871e292498 Merge "Removed extra xml api-ref files" 2016-10-30 00:52:32 +00:00
Jenkins
2ca6e3eed9 Merge "[api-ref] Correct response code in Cinder API v1" 2016-10-29 10:52:04 +00:00
Sheel Rana
2fa79b35ba Removed extra xml api-ref files
We have already removed xml support from cinder code
in previous release.
As per previous discussions, xml references are required
to eliminate to sync code and api-ref.

Implements : blueprint eliminate-xml-references

Change-Id: I0cb7da56306e29cff8385c784bfc3f49cd9cfddd
2016-10-18 23:37:57 +05:30
Mark T. Voelker
081e5bb35a Mark v1 as DEPRECATED in devref
The Cinder v1 API has been deprecated for a while now[1][2][3], but
the api-quick-start index still shows it as SUPPORTED.  A patch has
been submitted to fix the index page[4] but to be consistent with
the documentation for other projects[5] we should also update the v1
index page's header to clearly state it's status.

[1] https://wiki.openstack.org/wiki/ReleaseNotes/Juno#Cinder_Features
[2] http://developer.openstack.org/api-ref-blockstorage-v1.html
[3] https://review.openstack.org/#/c/309652/
[4] https://review.openstack.org/#/c/370407/
[5] Such as: http://developer.openstack.org/api-ref/identity/v2/

Change-Id: I4200767227368dc12f53e2410816b6fde375d390
Partial-Bug: #1623642
2016-09-14 16:08:09 -04:00
Ha Van Tu
e82d639e96 [api-ref] Correct response code in Cinder API v1
This patch corrects reponses code in Cinder API v1

Change-Id: I3491f0af455b30a6db66dc38ae3983e8799aa851
2016-09-08 11:53:36 +07:00
Andreas Jaeger
f589c6e2d1 Cleanup api-ref
Remove useage of old os-api-ref version and replace with current version.

Follow other repositories and merge v1 and v2 in a single document.

Note that we need to have a single document so that preview of the
document works properly in our CI.

Change-Id: I82c8b9ca317298b3dc1f7133ce8c0e9b3503730d
2016-08-27 17:13:04 +02:00
Sheel Rana
7f2131e3a1 Update api-ref path
api-ref path needs update to support uploading cinder api-refs to
developer.openstack.org/api-ref/block-storage

update includes
https://github.com/openstack/cinder/tree/master/api-ref/v2/source
to
https://github.com/openstack/cinder/tree/master/api-ref/source/v2

Depends-on: Id38dd0609c77b0d6bcd0d935a9312b0211134802

Implements: bp api-reference-to-rst

Change-Id: If3a058a95f1eaa8481a926183591ff0f4b23e97b
2016-08-27 16:58:10 +02:00