Create API reference page 79/22379/1
authorEric Debeau <eric.debeau@orange.com>
Mon, 6 Nov 2017 20:33:21 +0000 (20:33 +0000)
committerEric Debeau <eric.debeau@orange.com>
Mon, 6 Nov 2017 20:35:25 +0000 (20:35 +0000)
Change-Id: Ia6945fd05a94155f17d2f16dfdb75c1ae8577caf
ISSUE-ID: DOC-152
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
docs/guides/onap-developer/apiref/index.rst

index bad2793..277dd15 100644 (file)
@@ -7,3 +7,45 @@
 API Reference
 =============
 
+.. note::
+   Some high level groupings are introduced below with references to
+   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/Virtual Function Controller.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>
+   SDNC - SDN Controller <../../../submodules/sdnc/northbound.git/docs/offeredapis.rst>
+   SO - Service Orchestrator <../../../submodules/so.git/docs/offered_consumed_apis.rst>
+   VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
+
+Common Services
+---------------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   AAF - Application Authorization Framework <../../../submodules/aaf/authz.git/docs/AAF-API-Documentation/AAF-API-Documentation.rst>
+   AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
+   DMaaP - Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/message-router/message-router.rst>
+   MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
+   Multi VIM/Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>