From dac0e0572e3eb213551b586c8cfa2e7d38329e57 Mon Sep 17 00:00:00 2001 From: Samriddhi Jain Date: Thu, 13 Jul 2017 19:40:07 +0530 Subject: [PATCH] Reorganised api-ref index page Currently in the keystone API documentation page located at, https://developer.openstack.org/api-ref/identity/index.html all the sections and sub-sections appear at the same depth. This makes the ordering very untidy and confusing. This patch reorganises the appearance of sections and sub-sections at the index page. Change-Id: I55ae0102236805591e653c153618dec2af510c63 --- api-ref/source/index.rst | 4 +--- api-ref/source/v2-admin/index.rst | 6 +++--- api-ref/source/v2-ext/index.rst | 6 +++--- api-ref/source/v2/index.rst | 6 +++--- api-ref/source/v3-ext/index.rst | 6 +++--- api-ref/source/v3/index.rst | 15 ++++++++++++--- 6 files changed, 25 insertions(+), 18 deletions(-) diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 92b85f9a95..d229310c04 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -9,7 +9,7 @@ Welcome to keystone's documentation! Contents: .. toctree:: - :maxdepth: 1 + :maxdepth: 2 v2/index v2-admin/index @@ -17,11 +17,9 @@ Contents: v3/index v3-ext/index - Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/api-ref/source/v2-admin/index.rst b/api-ref/source/v2-admin/index.rst index 5aa7e4c39b..acad2ac633 100644 --- a/api-ref/source/v2-admin/index.rst +++ b/api-ref/source/v2-admin/index.rst @@ -1,8 +1,8 @@ -:tocdepth: 2 +:tocdepth: 3 -===================================== +-------------------------------------- Identity Admin API v2.0 (DEPRECATED) -===================================== +-------------------------------------- .. rest_expand_all:: diff --git a/api-ref/source/v2-ext/index.rst b/api-ref/source/v2-ext/index.rst index 6b54565ffa..49321f3d40 100644 --- a/api-ref/source/v2-ext/index.rst +++ b/api-ref/source/v2-ext/index.rst @@ -1,8 +1,8 @@ -:tocdepth: 2 +:tocdepth: 3 -========================================== +------------------------------------------- Identity API v2.0 extensions (DEPRECATED) -========================================== +------------------------------------------- .. rest_expand_all:: diff --git a/api-ref/source/v2/index.rst b/api-ref/source/v2/index.rst index 714ed0dec7..0cd9f4506b 100644 --- a/api-ref/source/v2/index.rst +++ b/api-ref/source/v2/index.rst @@ -1,8 +1,8 @@ -:tocdepth: 2 +:tocdepth: 3 -=============================== +-------------------------------- Identity API v2.0 (DEPRECATED) -=============================== +-------------------------------- .. rest_expand_all:: diff --git a/api-ref/source/v3-ext/index.rst b/api-ref/source/v3-ext/index.rst index 39e19f7165..dd1c44c2cb 100644 --- a/api-ref/source/v3-ext/index.rst +++ b/api-ref/source/v3-ext/index.rst @@ -1,8 +1,8 @@ -:tocdepth: 2 +:tocdepth: 3 -====================================== +-------------------------------------- Identity API v3 extensions (CURRENT) -====================================== +-------------------------------------- This page describes these Identity API v3 extensions: diff --git a/api-ref/source/v3/index.rst b/api-ref/source/v3/index.rst index b95b04c450..96693805cf 100644 --- a/api-ref/source/v3/index.rst +++ b/api-ref/source/v3/index.rst @@ -1,8 +1,8 @@ -:tocdepth: 2 +:tocdepth: 3 -=========================== +--------------------------- Identity API v3 (CURRENT) -=========================== +--------------------------- The Identity service generates authentication tokens that permit access to the OpenStack services REST APIs. Clients obtain this token and the URL endpoints @@ -26,6 +26,7 @@ For information about Identity API protection, see `_ in the OpenStack Cloud Administrator Guide. +========================= What's New in Version 3.8 ========================= @@ -33,12 +34,14 @@ What's New in Version 3.8 - Add a ``password_expires_at`` query parameter to user list and users in group list. +========================= What's New in Version 3.7 ========================= - Addition of the ``password_expires_at`` field to the user response object. - Introduce a flag to bypass expiration and revocation checking. +========================= What's New in Version 3.6 ========================= @@ -60,6 +63,7 @@ What's New in Version 3.6 - Support ``enabled`` and ``id`` as optional attributes to filter identity providers when listing. +========================= What's New in Version 3.5 ========================= @@ -68,6 +72,7 @@ What's New in Version 3.5 - Addition of ``is_domain`` optional attribute to projects. Setting this currently has no effect, it is reserved for future use. +========================= What's New in Version 3.4 ========================= @@ -83,6 +88,7 @@ What's New in Version 3.4 - The JSON Home support now will indicate the status of resource if it is not stable and current. +========================= What's New in Version 3.3 ========================= @@ -96,6 +102,7 @@ These features are considered stable as of September 4th, 2014. targets for a token. - Addition of ``url`` optional attribute for ``regions``. +========================= What's New in Version 3.2 ========================= @@ -110,6 +117,7 @@ These features are considered stable as of January 23, 2014. provided if a particular deployment has limited the number of entries a query may return +========================= What's New in Version 3.1 ========================= @@ -124,6 +132,7 @@ These features are considered stable as of July 18, 2013. creation - Added optional bind information to token structure +========================= What's New in Version 3.0 =========================