Add tox environment for spellcheck

[doc.git] / docs / guides / onap-developer / apiref / index.rst

diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index bad2793..34dc24e 100644 (file)
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -2,8 +2,62 @@
    International License. http://creativecommons.org/licenses/by/4.0
    Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
+.. index:: API Reference
+
 .. _doc-apiref:
 
-API Reference
-=============
+REST API Reference
+==================
+
+.. note::
+   Some high level groupings are introduced below with references to
+   REST API offered by the various components.
+
+User Interfaces
+---------------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst>
+   SDC - Service Design and Creation <../../../submodules/sdc.git/docs/offeredapis.rst>
+   VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/offeredapis.rst>
+
+Platform Components
+-------------------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   APPC - Application Controller <../../../submodules/appc.git/docs/index.rst>
+   DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst>
+   Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst>
+   Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst>
+   SO - Service Orchestration <../../../submodules/so.git/docs/offered_consumed_apis.rst>
+   VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
+   NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst>
+
+Common Services
+---------------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
+   DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
+   Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
+   MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
+   MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
+   Music <../../../submodules/music.git/docs/offeredapis.rst>
+
+SDK
+---
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
 
+   VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst>