Merge "Update Overview Section of Documentation"

[cps.git] / docs / design.rst

diff --git a/docs/design.rst b/docs/design.rst
index f9f12de..ce419ca 100755 (executable)
--- a/docs/design.rst
+++ b/docs/design.rst
@@ -9,8 +9,6 @@
 CPS Design
 ##########
 
-.. warning:: draft
-
 .. toctree::
    :maxdepth: 1
 
@@ -23,8 +21,8 @@ CPS supports the public APIs listed in the link below:
 
 :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>`
 
-Exposed API
------------
+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 +31,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
+and CPS-NCMP 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 `DMI Plugin's Design Page <https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin/en/latest/design.html>`_.
 
 CPS Path
 ========