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 :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:master_index>`
  24 :ref:`Portal<onap-portal:offeredapis>`
  25 :ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>`
  26 :ref:`VID - Virtual Infrastructure Deployment<onap-vid:offeredapis>`
  27
  28 Platform Components
  29 -------------------
  30
  31 .. toctree::
  32    :maxdepth: 1
  33    :titlesonly:
  34
  35 :ref:`APPC - Application Controller<onap-appc:appc_lcm_api_guide>`
  36 :ref:`DCAE - Data Collection Analytics and Events<onap-dcaegen2:offeredapis>`
  37 :ref:`Holmes - Alarm Correlation<onap-holmes-rule-management:offeredapis>`
  38 :ref:`Policy<onap-policy-parent:offeredapis>`
  39 :ref:`SDNC - SDN Controller<onap-sdnc-oam:offeredapis>`
  40 :ref:`SO - Service Orchestration<onap-so:offeredapis>`
  41 :ref:`VFC - Virtual Function Controller<onap-vfc-nfvo-lcm:master_index>`
  42
  43 Common Services
  44 ---------------
  45
  46 .. toctree::
  47    :maxdepth: 1
  48    :titlesonly:
  49
  50 :ref:`AAF - Application Authorization Framework<onap-aaf-sms:offeredapis>`
  51 :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>`
  52 :ref:`AAI ESR - AAI External System Register<onap-aai-esr-server:offeredapis>`
  53 :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-dbcapi:offeredapis>`
  54 :ref:`DMAAP DR - Data Management as a Platform (Data Router)<onap-dmaap-datarouter:master_index>`
  55 :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:offeredapis>`
  56 :ref:`ExtAPI- External API NBI - NorthBound API<onap-externalapi-nbi:offeredapis>`
  57 :ref:`Modeling Parsers<onap-modeling-toscaparsers:offeredapis>`
  58 :ref:`MSB - Micro Services Bus<onap-msb-apigateway:offeredapis>`
  59 :ref:`Multi Cloud<onap-multicloud-framework:offeredapis>`
  60 :ref:`MUSIC - Multi-site State Coordination Service<onap-music:offeredapis>`
  61 :ref:`OPTF - Optimization Framework<onap-optf-osdf:offeredapis>`
  62
  63 SDK
  64 ---
  65
  66 .. toctree::
  67    :maxdepth: 1
  68    :titlesonly:
  69
  70 :ref:`VNF Software Development Kit<onap-vnfsdk-model:offeredapis>`
  71
  72
  73 Some ONAP Postman collections
  74 -----------------------------
  75
  76 .. toctree::
  77    :maxdepth: 1
  78    :titlesonly:
  79
  80 :ref:`Some ONAP Postman collections<onap-integration:docs_postman>`