docs/guides/onap-developer/apiref/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License. http://creativecommons.org/licenses/by/4.0
   3    Copyright 2017 AT&T Intellectual Property.  All rights reserved.
   4
   5 .. _doc-apiref:
   6
   7 REST API Reference
   8 ==================
   9
  10 .. note::
  11    Some high level groupings are introduced below with references to
  12    REST API offered by the various components.
  13
  14 User Interfaces
  15 ---------------
  16
  17 .. toctree::
  18    :maxdepth: 1
  19    :titlesonly:
  20
  21    CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst>
  22    SDC - Service Design and Creation <../../../submodules/sdc.git/docs/offeredapis.rst>
  23    VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/docs-offeredapis.rst>
  24
  25 Platform Components
  26 -------------------
  27
  28 .. toctree::
  29    :maxdepth: 1
  30    :titlesonly:
  31
  32    APPC - Application Controller <../../../submodules/appc.git/docs/index.rst>
  33    DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst>
  34    Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst>
  35    Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst>
  36    SDNC - Software Defined Network Controller <../../../submodules/sdnc/northbound.git/docs/offeredapis.rst>
  37    SO - Service Orchestration <../../../submodules/so.git/docs/offered_consumed_apis.rst>
  38    VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
  39
  40 Common Services
  41 ---------------
  42
  43 .. toctree::
  44    :maxdepth: 1
  45    :titlesonly:
  46
  47    AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
  48    DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/message-router/message-router.rst>
  49    Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
  50    MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
  51    MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
  52
  53 SDK
  54 ---
  55
  56 .. toctree::
  57    :maxdepth: 1
  58    :titlesonly:
  59
  60    VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst>