blob: e65c5aed0de561f87f8005ba0470f7e905311cd7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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 <openapi/openapi.yml>`
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://<hostname>:<port>/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`.
|
