aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api/swagger/ncmp/openapi-inventory.yaml8
-rw-r--r--docs/cps-ncmp-message-status-codes.rst12
-rw-r--r--docs/deployment.rst4
-rwxr-xr-xdocs/design.rst10
-rwxr-xr-xdocs/release-notes.rst63
5 files changed, 92 insertions, 5 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index 6203c857a5..af6b004b1b 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -265,22 +265,26 @@ components:
key: my-property
cmHandleProperties:
key: my-property
+ moduleSetTag: my-module-set-tag
- cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
+ moduleSetTag: my-module-set-tag
createdCmHandles:
- cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
+ moduleSetTag: my-module-set-tag
- cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
+ moduleSetTag: my-module-set-tag
dmiPlugin: my-dmi-plugin
dmiModelPlugin: my-dmi-model-plugin
dmiDataPlugin: my-dmi-data-plugin
@@ -325,6 +329,7 @@ components:
key: my-property
cmHandleProperties:
key: my-property
+ moduleSetTag: my-module-set-tag
properties:
cmHandle:
example: my-cm-handle
@@ -339,6 +344,9 @@ components:
example: my-property
type: string
type: object
+ moduleSetTag:
+ example: my-module-set-tag
+ type: string
required:
- cmHandle
type: object
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/deployment.rst b/docs/deployment.rst
index acc32e3640..0642e6a8e1 100644
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -336,5 +336,7 @@ Below are the list of distributed datastructures that we have.
+--------------+---------------------------------+----------------------------------------------------------+
| cps-ncmp | trustLevelPerDmiPlugin | Stores the TrustLevel for the dmi-plugins. |
+--------------+---------------------------------+----------------------------------------------------------+
+| cps-ncmp | moduleSetTagCacheMapConfig | Stores the Module Set Tags for cmHandles. |
++--------------+---------------------------------+----------------------------------------------------------+
-Total number of caches : 7 \ No newline at end of file
+Total number of caches : 8 \ No newline at end of file
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
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 013617a815..d891162c32 100755
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -16,6 +16,61 @@ CPS Release Notes
.. * * * MONTREAL * * *
.. ========================
+Version: 3.3.9
+==============
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------------------------+
+| **CPS Project** | |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Docker images** | onap/cps-and-ncmp:3.3.9 |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Release designation** | 3.3.9 Montreal |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Release date** | Not yet released |
+| | |
++--------------------------------------+--------------------------------------------------------+
+
+Bug Fixes
+---------
+3.3.9
+
+Features
+--------
+
+Version: 3.3.8
+==============
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------------------------+
+| **CPS Project** | |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Docker images** | onap/cps-and-ncmp:3.3.8 |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Release designation** | 3.3.8 Montreal |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Release date** | 2023 September 29 |
+| | |
++--------------------------------------+--------------------------------------------------------+
+
+Bug Fixes
+---------
+3.3.8
+
+Features
+--------
+ - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
+
Version: 3.3.7
==============
@@ -32,16 +87,22 @@ Release Data
| **Release designation** | 3.3.7 Montreal |
| | |
+--------------------------------------+--------------------------------------------------------+
-| **Release date** | Not yet released |
+| **Release date** | 2023 September 20 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
3.3.7
+ - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
Features
--------
+ - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
+
+Note
+----
+Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
Version: 3.3.6
==============