From 7f84b03e3493f2a077d53ee99c39f7e771807abc Mon Sep 17 00:00:00 2001 From: egernug Date: Mon, 29 Apr 2024 15:26:50 +0100 Subject: DMI REST interface documentation Issue-ID: CPS-2141 Change-Id: Ifb31682128cc23d20cdb46214bddc3cc9061257c Signed-off-by: egernug --- .../cps-r9-ncmp-dmi-plugin-interface-diagram.png | Bin 24561 -> 90987 bytes docs/architecture.rst | 11 ++++++++++- docs/design.rst | 4 +++- docs/index.rst | 5 +---- 4 files changed, 14 insertions(+), 6 deletions(-) diff --git a/docs/_static/cps-r9-ncmp-dmi-plugin-interface-diagram.png b/docs/_static/cps-r9-ncmp-dmi-plugin-interface-diagram.png index 6c5903d2..5a06fbf7 100644 Binary files a/docs/_static/cps-r9-ncmp-dmi-plugin-interface-diagram.png and b/docs/_static/cps-r9-ncmp-dmi-plugin-interface-diagram.png differ diff --git a/docs/architecture.rst b/docs/architecture.rst index 622b9c86..f0b87455 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2021-2023 Nordix Foundation +.. Copyright (C) 2021-2024 Nordix Foundation .. _architecture: DMI-Plugin Architecture @@ -52,5 +52,14 @@ The DMI-Plugin provides following interfaces. - Query data - Query module references - REST + * - DMI-I-02 + - Provides support for Async Data Subjobs enabling CRUDAQ requests for the paths in the request using the ID of the producer registered by DMI. This enables subnetwork-wide requests + - - Create data based on dataProducerId + - Read data based on dataProducerId + - Update data based on dataProducerId + - Delete data based on dataProducerId + - Perform action on data based on dataProducerId + - Query data based on dataProducerId + - REST More details on the CPS interface CPS-E-05 which is responsible for the DMI-Plugin can be found on the :ref:`CPS Architecture page` diff --git a/docs/design.rst b/docs/design.rst index 2efcc585..dd1472c9 100644 --- a/docs/design.rst +++ b/docs/design.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2021-2023 Nordix Foundation +.. Copyright (C) 2021-2024 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _design: @@ -19,6 +19,8 @@ The DMI-Plugin supports the public APIs listed in the link below: :download:`DMI Rest OpenApi Specification ` +:download:`DMI Datajob OpenApi Specification ` + View Offered APIs ----------------- diff --git a/docs/index.rst b/docs/index.rst index 236b1c8e..ade75612 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ .. 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 +.. Copyright (C) 2021-2024 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _master_index: @@ -28,7 +28,4 @@ CPS-NCMP Documentation * :ref:`CPS-NCMP` -CPS-Temporal Documentation --------------------------- -* :ref:`CPS-Temporal` -- cgit 1.2.3-korg