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
- API offered by the various components.
+ REST API offered by the various components.
User Interfaces
---------------
: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>
+* :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-parent:clamp-label>`
+* :ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>`
Platform Components
-------------------
: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>
+* :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
---------------
: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>
+* :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>`
+* :ref:`CPS - Configuration Persistence Service<onap-cps:design>`
+* :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-buscontroller: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:`MSB - Micro Services Bus<onap-msb-apigateway:offeredapis>`
+* :ref:`Multi Cloud<onap-multicloud-framework:offeredapis>`
+* :ref:`OPTF - Optimization Framework<onap-optf-osdf:offeredapis>`