Merge "Update write performance test timings"

[cps.git] / docs / design.rst

diff --git a/docs/design.rst b/docs/design.rst
index 7df24ec..c6413c2 100755 (executable)
--- 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
 .. 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:
 
 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
 .. _design:


@@ -15,12 +15,29 @@ CPS Design
 Offered APIs
 ============
 
 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 <api/swagger/cps/openapi.yaml>`
 
 
 :download:`CPS Rest OpenApi Specification <api/swagger/cps/openapi.yaml>`
 

+CPS-NCMP
+--------
+
+XNF data access and module information.
+

 :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>`
 
 :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>`
 

+CPS-NCMP-Inventory
+------------------
+
+DMI-Plugin Inventory.
+
+:download:`CPS NCMP RestOpenApi Inventory Specification <api/swagger/ncmp/openapi-inventory.yaml>`
+

 View Offered APIs
 -----------------
 
 View Offered APIs
 -----------------
 


@@ -33,24 +50,36 @@ Specification can be accessed using following URI:
 
   http://<hostname>:<port>/v3/api-docs?group=cps-docket
 
 
   http://<hostname>:<port>/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://<hostname>:<port>/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/
 
 Consumed APIs
 
 .. code-block:: bash
 
   http://<hostname>:<port>/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.
 
 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 <https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin/en/latest/design.html>`_.
+  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>`.

 
 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`.
 
 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`.