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 .. index:: API Reference
   6
   7 .. _doc-apiref:
   8
   9 REST API Reference
  10 ==================
  11
  12 .. note::
  13    Some high level groupings are introduced below with references to
  14    REST API offered by the various components.
  15
  16 User Interfaces
  17 ---------------
  18
  19 .. toctree::
  20    :maxdepth: 1
  21    :titlesonly:
  22
  23    CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst>
  24    SDC - Service Design and Creation <../../../submodules/sdc.git/docs/offeredapis.rst>
  25    VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/offeredapis.rst>
  26
  27 Platform Components
  28 -------------------
  29
  30 .. toctree::
  31    :maxdepth: 1
  32    :titlesonly:
  33
  34    APPC - Application Controller <../../../submodules/appc.git/docs/index.rst>
  35    DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst>
  36    Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst>
  37    Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst>
  38    SDNC - SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/offeredapis.html>
  39    SO - Service Orchestration <../../../submodules/so.git/docs/api/offered_consumed_apis.rst>
  40    VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
  41
  42 Common Services
  43 ---------------
  44
  45 .. toctree::
  46    :maxdepth: 1
  47    :titlesonly:
  48
  49    AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
  50    AAI ESR <../../../submodules/aai/esr-server.git/docs/offeredapis.rst>
  51    DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
  52    ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst>
  53    Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
  54    MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
  55    Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
  56    MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/offeredapis.rst>
  57    OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/offeredapis.rst>
  58    VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/offeredapis.rst>
  59
  60 SDK
  61 ---
  62
  63 .. toctree::
  64    :maxdepth: 1
  65    :titlesonly:
  66
  67    VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst>