Add CPS in release notes, API, Architecture and Component pages

[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..c251416 100644 (file)
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -2,8 +2,72 @@
    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:
+
+* :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-clamp:master_index>`
+* :ref:`Portal<onap-portal:offeredapis>`
+* :ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>`
+* :ref:`VID - Virtual Infrastructure Deployment<onap-vid:offeredapis>`
+
+Platform Components
+-------------------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+* :ref:`APPC - Application Controller<onap-appc:appc_lcm_api_guide>`
+* :ref:`DCAE - Data Collection Analytics and Events<onap-dcaegen2:offeredapis>`
+* :ref:`Holmes - Alarm Correlation<onap-holmes-rule-management:offeredapis>`
+* :ref:`Policy<onap-policy-parent:offeredapis>`
+* :ref:`SDNC - SDN Controller<onap-sdnc-oam:offeredapis>`
+* :ref:`SO - Service Orchestration<onap-so:offeredapis>`
+* :ref:`VFC - Virtual Function Controller<onap-vfc-nfvo-lcm:master_index>`
+* :ref:`CDS - Controller Design Studio<onap-ccsdk-cds:offeredapis>`
+
+Common Services
+---------------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+* :ref:`AAF - Application Authorization Framework<onap-aaf-sms:offeredapis>`
+* :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>`
+* :ref:`AAI ESR - AAI External System Register<onap-aai-esr-server:offeredapis>`
+* :ref:`CPS - Configuration Persistence Service<onap-cps:design>`
+* :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-dbcapi:offeredapis>`
+* :ref:`DMAAP DR - Data Management as a Platform (Data Router)<onap-dmaap-datarouter:master_index>`
+* :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:offeredapis>`
+* :ref:`ExtAPI- External API NBI - NorthBound API<onap-externalapi-nbi:offeredapis>`
+* :ref:`Modeling Parsers<onap-modeling-toscaparsers:offeredapis>`
+* :ref:`MSB - Micro Services Bus<onap-msb-apigateway:offeredapis>`
+* :ref:`Multi Cloud<onap-multicloud-framework:offeredapis>`
+* :ref:`MUSIC - Multi-site State Coordination Service<onap-music:offeredapis>`
+* :ref:`OPTF - Optimization Framework<onap-optf-osdf:offeredapis>`
+
+SDK
+---
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+* :ref:`VNF Software Development Kit<onap-vnfsdk-model:offeredapis>`