diff options
| author |   lukegleeson <luke.gleeson@est.tech> | 2021-10-01 17:21:48 +0100 |
|---|---|---|
| committer | lukegleeson <luke.gleeson@est.tech> | 2021-10-08 14:04:26 +0100 |
| commit | 78d592277197ffc05067730186003e2fca49e8c3 (patch) | |
| tree | 10400f4da4d304868b00457cd1db571f1854b219 /docs/design.rst | |
| parent | 9ee0feb24f8f75ce05cf9e34e4621cf2b226657e (diff) | |
Update Design And Modelling section
Update Design and Modelling sections of DMI Plugin documentation for
Istanbul release.
Issue-ID: CPS-627
Change-Id: Ic572da315d23a79a6b0b069e2144e5ff89aff583
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
Signed-off-by: lukegleeson <luke.gleeson@est.tech>
Diffstat (limited to 'docs/design.rst')
| -rw-r--r-- | docs/design.rst | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/docs/design.rst b/docs/design.rst index e65c5aed..708feeb3 100644 --- a/docs/design.rst +++ b/docs/design.rst @@ -9,8 +9,6 @@ DMI Plugin Design ################# -.. warning:: draft - .. toctree:: :maxdepth: 1 @@ -19,10 +17,10 @@ Offered APIs The DMI Plugin supports the public APIs listed in the link below: -:download:`DMI Rest OpenApi Specification <openapi/openapi.yml>` +:download:`DMI Rest OpenApi Specification <openapi/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. @@ -31,10 +29,16 @@ Specification can be accessed using following URI: .. code-block:: bash - “http://<hostname>:<port>/v3/api-docs?group=dmi-plugin-docket” + http://<hostname>:<port>/v3/api-docs?group=dmi-plugin-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#/ -DMI Plugin CM Handles -===================== +Consumed APIs +============= -Several DMI Plugin APIs use the cm-handle parameter. -The DMI Plugin CM Handles are described in detail in :doc:`dmi-plugin-cm-handle`. +- SDNC: REST based interface exposed by the SDNC client. This is used to retrieve the yang resources and modules for CPS. |