From 3d1579cb8cfe7fe924181bc3e02c570dca6ae081 Mon Sep 17 00:00:00 2001 From: shivasubedi Date: Mon, 13 Sep 2021 16:43:20 +0100 Subject: Create preliminary documentation for ONAP DMI-Plugin Create Preliminary documentation for Istanbul release of the DMI Plugin. Added new plugins in POM to generate swagger doc for design page. Added icons from Cps-Core, along with latest conf.py file from http://gerrit.onap.org/r/doc Issue-ID: CPS-625 Change-Id: I30582de9b07e93c1c2ecc18003ee6882994690d8 Signed-off-by: DylanB95EST Signed-off-by: shivasubedi --- docs/design.rst | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/design.rst (limited to 'docs/design.rst') diff --git a/docs/design.rst b/docs/design.rst new file mode 100644 index 00000000..e65c5aed --- /dev/null +++ b/docs/design.rst @@ -0,0 +1,40 @@ +.. 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 + +.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING +.. _design: + + +DMI Plugin Design +################# + +.. warning:: draft + +.. toctree:: + :maxdepth: 1 + +Offered APIs +============ + +The DMI Plugin supports the public APIs listed in the link below: + +:download:`DMI Rest OpenApi Specification ` + +Exposed API +----------- + +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. + +Specification can be accessed using following URI: + +.. code-block:: bash + + “http://:/v3/api-docs?group=dmi-plugin-docket” + +DMI Plugin CM Handles +===================== + +Several DMI Plugin APIs use the cm-handle parameter. +The DMI Plugin CM Handles are described in detail in :doc:`dmi-plugin-cm-handle`. -- cgit 1.2.3-korg