openstack
/
cinder
Code Issues Proposed changes

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
This commit is contained in:
Matt Riedemann 2017-04-18 16:32:19 -04:00 committed by Sean McGinnis
parent ad56443ecb
commit e13256469d
1 changed files with 25 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
api-ref/source/v3/index.rst
View File

@ -6,29 +6,42 @@ Block Storage API V3 (CURRENT)
.. rest_expand_all::
.. First thing we want to see is the version discovery document.
.. include:: api-versions.inc
.. include:: volumes-v3-versions.inc
.. Next top-level thing could be listing extensions available on this endpoint.
.. include:: volumes-v3-extensions.inc
.. To create a volume, I might need a volume type, so list those next.
.. include:: volumes-v3-types.inc
.. include:: volume-type-access.inc
.. Now my primary focus is on volumes and what I can do with them.
.. include:: volumes-v3-volumes.inc
.. include:: volumes-v3-volumes-actions.inc
.. List the other random volume APIs in just alphabetical order.
.. include:: os-vol-image-meta-v3.inc
.. include:: volume-manage.inc
.. include:: volumes-v3-snapshots.inc
.. include:: os-vol-transfer-v3.inc
.. Now the other random things in alphabetical order.
.. include:: attachments.inc
.. include:: os-vol-pool-v3.inc
.. include:: ext-backups.inc
.. include:: ext-backups-actions-v3.inc
.. include:: capabilities-v3.inc
.. include:: os-cgsnapshots-v3.inc
.. include:: consistencygroups-v3.inc
.. include:: os-cgsnapshots-v3.inc
.. include:: groups.inc
.. include:: group-snapshots.inc
.. include:: group-types.inc
.. include:: hosts.inc
.. include:: limits.inc
.. include:: messages.inc
.. include:: os-vol-image-meta-v3.inc
.. include:: os-vol-pool-v3.inc
.. include:: os-vol-transfer-v3.inc
.. include:: qos-specs-v3-qos-specs.inc
.. quota-sets should arguably live closer to limits, but that would mess up
our nice alphabetical ordering
.. include:: quota-sets.inc
.. include:: volume-manage.inc
.. include:: volume-type-access.inc
.. include:: volumes-v3-extensions.inc
.. include:: volumes-v3-snapshots.inc
.. include:: volumes-v3-types.inc
.. include:: volumes-v3-versions.inc
.. include:: volumes-v3-volumes-actions.inc
.. include:: volumes-v3-volumes.inc