Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / f027cfba276b5b56b06fe7deb9f629fd8be7d911 / . / docs / design.rst
blob: eb5f6b6e072d77c152568e516460d52574e10d4e [file] [log] [blame]
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]3.. Copyright (C) 2021 Nordix Foundation
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]4
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
Ruslan Kashapov55dc6542021-03-02 16:48:41 +0200[diff] [blame]6.. _design:
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]7
8
Ruslan Kashapov55dc6542021-03-02 16:48:41 +0200[diff] [blame]9CPS Design
10##########
11
12.. toctree::
13 :maxdepth: 1
14
15Offered APIs
16============
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]17
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]18CPS supports the public APIs listed in the following sections.
19
20CPS-Core
21--------
22
23CPS-Core functionality.
Rishi.Chail85aebca2021-02-24 15:10:58 +0000[diff] [blame]24
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]25:download:`CPS Rest OpenApi Specification <api/swagger/cps/openapi.yaml>`
26
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]27CPS-NCMP
28--------
29
30XNF data access and module information.
31
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]32:download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>`
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]33
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]34CPS-NCMP-Inventory
35------------------
36
37DMI-Plugin Inventory.
38
39:download:`CPS NCMP RestOpenApi Inventory Specification <api/swagger/ncmp/openapi-inventory.yaml>`
40
lukegleesone1308ac2021-09-30 13:36:37 +0100[diff] [blame]41View Offered APIs
42-----------------
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]43
Rishi.Chail85aebca2021-02-24 15:10:58 +0000[diff] [blame]44The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS).
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]45The OAS 3, which is based on the original "Swagger Specification", is being widely used in API developments.
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]46
Ruslan Kashapov55dc6542021-03-02 16:48:41 +0200[diff] [blame]47Specification can be accessed using following URI:
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]48
49.. code-block:: bash
50
lukegleesone1308ac2021-09-30 13:36:37 +0100[diff] [blame]51 http://<hostname>:<port>/v3/api-docs?group=cps-docket
52
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]53Additionally, the Swagger User Interface can be found at the following URI. The component may be changed between CPS-Core, CPS-NCMP
54and CPS-NCMP-Inventory using the drop down table in the top right:
lukegleesone1308ac2021-09-30 13:36:37 +0100[diff] [blame]55
56.. code-block:: bash
57
58 http://<hostname>:<port>/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/
59
60Consumed APIs
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]61=============
lukegleesone1308ac2021-09-30 13:36:37 +0100[diff] [blame]62
63CPS 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.
lukegleesonf027cfb2021-11-08 15:53:12 +0000[diff] [blame^]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>`.
ToineSiebelink98c07872021-04-20 17:33:09 +0100[diff] [blame]68
69CPS Path
70========
71
72Several CPS APIs use the cps-path (or cpsPath in Java API) parameter.
73The CPS Path is described in detail in :doc:`cps-path`.