Merge "Updated cmhandle registration openapi documentation"

[cps.git] / docs / design.rst

diff --git a/docs/design.rst b/docs/design.rst
index f9f12de..eb5f6b6 100755 (executable)
--- a/docs/design.rst
+++ b/docs/design.rst
@@ -9,22 +9,37 @@
 CPS Design
 ##########
 
-.. warning:: draft
-
 .. toctree::
    :maxdepth: 1
 
 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>`
 
+CPS-NCMP
+--------
+
+XNF data access and module information.
+
 :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>`
 
-Exposed API
------------
+CPS-NCMP-Inventory
+------------------
+
+DMI-Plugin Inventory.
+
+:download:`CPS NCMP RestOpenApi Inventory Specification <api/swagger/ncmp/openapi-inventory.yaml>`
+
+View Offered APIs
+-----------------
 
 The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS).
 The OAS 3, which is based on the original "Swagger Specification", is being widely used in API developments.
@@ -33,7 +48,23 @@ Specification can be accessed using following URI:
 
 .. code-block:: bash
 
-  “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, 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
+=============
+
+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 :ref:`DMI-Plugin's Design Page <onap-cps-ncmp-dmi-plugin:design>`.
 
 CPS Path
 ========