docs/design.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2021 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _design:
   7
   8
   9 CPS Design
  10 ##########
  11
  12 .. toctree::
  13    :maxdepth: 1
  14
  15 Offered APIs
  16 ============
  17
  18 CPS supports the public APIs listed in the following sections.
  19
  20 CPS-Core
  21 --------
  22
  23 CPS-Core functionality.
  24
  25 :download:`CPS Rest OpenApi Specification <api/swagger/cps/openapi.yaml>`
  26
  27 CPS-NCMP
  28 --------
  29
  30 XNF data access and module information.
  31
  32 :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>`
  33
  34 CPS-NCMP-Inventory
  35 ------------------
  36
  37 DMI-Plugin Inventory.
  38
  39 :download:`CPS NCMP RestOpenApi Inventory Specification <api/swagger/ncmp/openapi-inventory.yaml>`
  40
  41 View Offered APIs
  42 -----------------
  43
  44 The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS).
  45 The OAS 3, which is based on the original "Swagger Specification", is being widely used in API developments.
  46
  47 Specification can be accessed using following URI:
  48
  49 .. code-block:: bash
  50
  51   http://<hostname>:<port>/v3/api-docs?group=cps-docket
  52
  53 Additionally, the Swagger User Interface can be found at the following URI. The component may be changed between CPS-Core, CPS-NCMP
  54 and CPS-NCMP-Inventory using the drop down table in the top right:
  55
  56 .. code-block:: bash
  57
  58   http://<hostname>:<port>/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/
  59
  60 Consumed APIs
  61 =============
  62
  63 CPS Core uses API's from the following ONAP components
  64
  65 * DMI-Plugin: REST based interface which is used to provide integration
  66   and allow the DMI registry API's have access to the corresponding NCMP API's within CPS Core.
  67   More information on the DMI-Plugins offered APIs can be found on the :ref:`DMI-Plugin's Design Page <onap-cps-ncmp-dmi-plugin:design>`.
  68
  69 CPS Path
  70 ========
  71
  72 Several CPS APIs use the cps-path (or cpsPath in Java API) parameter.
  73 The CPS Path is described in detail in :doc:`cps-path`.