X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdesign.rst;h=c6413c294fc4604f7edb1bf1586c77577cf6d966;hb=325ac091ddea291c5659fa6e803f132a578deb14;hp=ce419caedf290ce1a66d8474f3707475a03d8510;hpb=1ab1a5450452352ff00bee718054f10adfc5bea0;p=cps.git diff --git a/docs/design.rst b/docs/design.rst index ce419caed..c6413c294 100755 --- a/docs/design.rst +++ b/docs/design.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2021 Nordix Foundation +.. Copyright (C) 2021-2022 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _design: @@ -15,12 +15,29 @@ CPS Design Offered APIs ============ -CPS supports the public APIs listed in the link below: +CPS supports the public APIs listed in the following sections. + +CPS-Core +-------- + +CPS-Core functionality. :download:`CPS Rest OpenApi Specification ` +CPS-NCMP +-------- + +XNF data access and module information. + :download:`CPS NCMP RestOpenApi Specification ` +CPS-NCMP-Inventory +------------------ + +DMI-Plugin Inventory. + +:download:`CPS NCMP RestOpenApi Inventory Specification ` + View Offered APIs ----------------- @@ -33,24 +50,36 @@ Specification can be accessed using following URI: http://:/v3/api-docs?group=cps-docket -Additionally, the Swagger User Interface can be found at the following URI. The component may be changed between CPS-Core -and CPS-NCMP using the drop down table in the top right: +Additionally, the Swagger User Interface can be found at the following URI. The component may be changed between CPS-Core, CPS-NCMP +and CPS-NCMP-Inventory using the drop down table in the top right: .. code-block:: bash http://:/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/ Consumed APIs -------------- +============= CPS Core uses API's from the following ONAP components * DMI-Plugin: REST based interface which is used to provide integration and allow the DMI registry API's have access to the corresponding NCMP API's within CPS Core. - More information on the DMI Plugins offered APIs can be found on the `DMI Plugin's Design Page `_. + More information on the DMI-Plugins offered APIs can be found on the :ref:`DMI-Plugin's Design Page `. CPS Path ======== Several CPS APIs use the cps-path (or cpsPath in Java API) parameter. The CPS Path is described in detail in :doc:`cps-path`. + +NCMP CM Handle Querying +======================= + +The CM Handle searches endpoints can be used to query for CM Handles or CM Handle IDs. +This endpoint is described in detail in :doc:`ncmp-cmhandle-querying`. + +NCMP Inventory CM Handle Querying +================================= + +The CM Handle searches ncmp inventory endpoints can be used to query for CM Handles or CM Handle IDs. +This endpoint is described in detail in :doc:`ncmp-inventory-querying`.