X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdesign.rst;h=eb5f6b6e072d77c152568e516460d52574e10d4e;hb=165e3b8bcc492ebe31431f30c14d5dc98bb7f18e;hp=ce419caedf290ce1a66d8474f3707475a03d8510;hpb=1ab1a5450452352ff00bee718054f10adfc5bea0;p=cps.git diff --git a/docs/design.rst b/docs/design.rst index ce419caed..eb5f6b6e0 100755 --- a/docs/design.rst +++ b/docs/design.rst @@ -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,21 +50,21 @@ 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 ========