RTD Doc update with error code 18/136118/3
authorsourabh_sourabh <sourabh.sourabh@est.tech>
Mon, 9 Oct 2023 11:18:19 +0000 (12:18 +0100)
committersourabh_sourabh <sourabh.sourabh@est.tech>
Mon, 9 Oct 2023 14:36:25 +0000 (15:36 +0100)
-RTD doc is updated with new error codes.

Issue-ID: CPS-1904
Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
Change-Id: Id234655abe88e3348abc148f8c1eedd36bf58379

docs/cps-ncmp-message-status-codes.rst
docs/design.rst

index 1b74153..20a5ae3 100644 (file)
@@ -10,15 +10,15 @@ CPS-NCMP Message Status Codes
 #############################
 
     +-----------------+------------------------------------------------------+-----------------------------------+
-    | Status Code     | Status Message                                       | Feature                           |
+    | Status Code     | Status Message                                       | Feature(s)                        |
     +=================+======================================================+===================================+
     | 0               | Successfully applied changes                         | Data Operation                    |
     +-----------------+------------------------------------------------------+-----------------------------------+
     | 1               | successfully applied subscription                    | CM Data Notification Subscription |
     +-----------------+------------------------------------------------------+-----------------------------------+
-    | 100             | cm handle id(s) is(are) not found                    | Data Operation                    |
+    | 100             | cm handle id(s) is(are) not found                    | Data Operation, Inventory         |
     +-----------------+------------------------------------------------------+-----------------------------------+
-    | 101             | cm handle id(s) is(are) in non ready state           | Data Operation                    |
+    | 101             | cm handle(s) not ready                               | Data Operation                    |
     +-----------------+------------------------------------------------------+-----------------------------------+
     | 102             | dmi plugin service is not responding                 | Data Operation                    |
     +-----------------+------------------------------------------------------+-----------------------------------+
@@ -32,6 +32,12 @@ CPS-NCMP Message Status Codes
     +-----------------+------------------------------------------------------+-----------------------------------+
     | 107             | southbound system is busy                            | Data Operation                    |
     +-----------------+------------------------------------------------------+-----------------------------------+
+    | 108             | Unknown error                                        | Inventory                         |
+    +-----------------+------------------------------------------------------+-----------------------------------+
+    | 109             | cm-handle already exists                             | Inventory                         |
+    +-----------------+------------------------------------------------------+-----------------------------------+
+    | 110             | cm-handle has an invalid character(s) in id          | Inventory                         |
+    +-----------------+------------------------------------------------------+-----------------------------------+
 
 .. note::
 
index c6413c2..5ad86a3 100755 (executable)
@@ -83,3 +83,13 @@ NCMP Inventory CM Handle Querying
 
 The CM Handle searches ncmp inventory endpoints can be used to query for CM Handles or CM Handle IDs.
 This endpoint is described in detail in :doc:`ncmp-inventory-querying`.
+
+Common NCMP Response Codes
+==========================
+
+NCMP uses common responses codes in REST responses and events. Also the DMI plugin interface uses these codes which are defined here:
+
+.. toctree::
+   :maxdepth: 1
+
+   cps-ncmp-message-status-codes.rst