openstack/cinder
Code Issues Proposed changes
b6f9932f9c
cinder/api-ref/source/index.rst

23 lines
367 B
ReStructuredText
Raw Normal View History

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 16:55:32 +02:00
=================
Block Storage API
=================
Contents:
Clean up api-ref index page We had an extra section that had a useless index link and a link to the search page. To make search easier to find, moved that up to the top and got rid of the index link. Change-Id: I65d7a8930b7bb7db2f994fc615ff621956397e83
2017-09-27 14:11:59 -05:00
API content can be searched using the :ref:`search`.
Add microversion history to api-ref This pulls in our microversion history document into the api-ref to make it easier for api consumers to discover the history of API changes. Change-Id: I9033a48e3f60199b60a904c8cf028f4a1e037ec3 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2018-09-18 14:59:37 -05:00
Details for each microversion change can be found in the
:doc:`REST API Version History <api_microversion_history>` documentation.
.. toctree::
:hidden:
api_microversion_history
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 16:55:32 +02:00
.. toctree::
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-02 15:56:50 -06:00
:maxdepth: 2
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 16:55:32 +02:00
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-17 01:12:40 -04:00
v3/index
Re-order api-ref home page index Since the v2 API is deprecated, put it in the index after the v3 API which is current, since as a user the first thing I want to see is the currently supported API reference, not the deprecated stuff I shouldn't be using anyway. Change-Id: I760533ca693cb8f678a6031e07789cd68f11bc47
2017-04-18 16:07:28 -04:00
v2/index
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 16:55:32 +02:00
Copy Permalink