diff options
| author |   sourabh_sourabh <sourabh.sourabh@est.tech> | 2023-10-09 12:18:19 +0100 |
|---|---|---|
| committer | sourabh_sourabh <sourabh.sourabh@est.tech> | 2023-10-09 15:36:25 +0100 |
| commit | 02ce57c4324b0e465daa9f20538417874f449ad6 (patch) | |
| tree | cf0a7db0f67f9c616628131951bc7222286ab4c9 | |
| parent | a6acaeae5e3d1b857d29001bee81c9a9add90dcc (diff) | |
RTD Doc update with error code
-RTD doc is updated with new error codes.
Issue-ID: CPS-1904
Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
Change-Id: Id234655abe88e3348abc148f8c1eedd36bf58379
| -rw-r--r-- | docs/cps-ncmp-message-status-codes.rst | 12 | ||||
| -rwxr-xr-x | docs/design.rst | 10 |
2 files changed, 19 insertions, 3 deletions
diff --git a/docs/cps-ncmp-message-status-codes.rst b/docs/cps-ncmp-message-status-codes.rst index 1b74153d75..20a5ae3c11 100644 --- a/docs/cps-ncmp-message-status-codes.rst +++ b/docs/cps-ncmp-message-status-codes.rst @@ -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:: diff --git a/docs/design.rst b/docs/design.rst index c6413c294f..5ad86a3aed 100755 --- a/docs/design.rst +++ b/docs/design.rst @@ -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 |