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 link below:
  19
  20 :download:`CPS Rest OpenApi Specification <api/swagger/cps/openapi.yaml>`
  21
  22 :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>`
  23
  24 View Offered APIs
  25 -----------------
  26
  27 The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS).
  28 The OAS 3, which is based on the original "Swagger Specification", is being widely used in API developments.
  29
  30 Specification can be accessed using following URI:
  31
  32 .. code-block:: bash
  33
  34   http://<hostname>:<port>/v3/api-docs?group=cps-docket
  35
  36 Additionally, the Swagger User Interface can be found at the following URI. The component may be changed between CPS-Core
  37 and CPS-NCMP using the drop down table in the top right:
  38
  39 .. code-block:: bash
  40
  41   http://<hostname>:<port>/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/
  42
  43 Consumed APIs
  44 -------------
  45
  46 CPS Core uses API's from the following ONAP components
  47
  48 * DMI-Plugin: REST based interface which is used to provide integration
  49   and allow the DMI registry API's have access to the corresponding NCMP API's within CPS Core.
  50   More information on the DMI Plugins offered APIs can be found on the `DMI Plugin's Design Page <https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin/en/latest/design.html>`_.
  51
  52 CPS Path
  53 ========
  54
  55 Several CPS APIs use the cps-path (or cpsPath in Java API) parameter.
  56 The CPS Path is described in detail in :doc:`cps-path`.