diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 41 | ||||
-rw-r--r-- | docs/deployment.rst | 2 | ||||
-rw-r--r-- | docs/design.rst | 6 | ||||
-rw-r--r-- | docs/release-notes.rst | 41 |
4 files changed, 82 insertions, 8 deletions
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index 8098faefcc..a1cc5d9ba7 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -918,9 +918,9 @@ paths: - network-cm-proxy /v1/ch/{cm-handle}/modules/definitions: get: - description: "Fetch all module definitions (name, revision, yang resource) for\ - \ a given cm handle" - operationId: getModuleDefinitionsByCmHandleId + description: "Get module definitions (module name, revision, yang resource)\ + \ with options to filter on module name and revision" + operationId: getModuleDefinitions parameters: - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" @@ -930,6 +930,21 @@ paths: schema: example: my-cm-handle type: string + - description: Filter for a module name.This is an optional parameter + in: query + name: module-name + required: false + schema: + example: my-module + type: string + - description: Filter for a module revision.This is an optional parameter and + ignored when no module name is supplied + in: query + name: revision + required: false + schema: + example: 2024-01-22 + type: string responses: "200": content: @@ -969,8 +984,7 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Internal Server Error - summary: "Fetch all module definitions (name, revision, yang resource) for a\ - \ given cm handle" + summary: Get module definitions tags: - network-cm-proxy /v1/ch/searches: @@ -1666,6 +1680,23 @@ components: schema: default: / type: string + moduleNameInQuery: + description: Filter for a module name.This is an optional parameter + in: query + name: module-name + required: false + schema: + example: my-module + type: string + revisionInQuery: + description: Filter for a module revision.This is an optional parameter and + ignored when no module name is supplied + in: query + name: revision + required: false + schema: + example: 2024-01-22 + type: string dataSyncEnabled: description: Is used to enable or disable the data synchronization flag in: query diff --git a/docs/deployment.rst b/docs/deployment.rst index ca7824d6dc..3b5aad1bfc 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -333,7 +333,7 @@ Below are the list of distributed datastructures that we have. +--------------+------------------------------------+-----------------------------------------------------------+ | cps-ncmp | moduleSetTagCacheMapConfig | Stores the module set tags for cm handles. | +--------------+------------------------------------+-----------------------------------------------------------+ -| cps-ncmp | cmSubscriptionEventCache | Stores and tracks cm notification subscription requests. | +| cps-ncmp | cmNotificationSubscriptionCache | Stores and tracks cm notification subscription requests. | +--------------+------------------------------------+-----------------------------------------------------------+ | cps-ncmp | alternateIdPerCmHandleId | Stores the alternate id for each cm handle id. | +--------------+------------------------------------+-----------------------------------------------------------+ diff --git a/docs/design.rst b/docs/design.rst index 80eb5f1523..af1f5abd4a 100644 --- a/docs/design.rst +++ b/docs/design.rst @@ -72,6 +72,12 @@ CPS Path Several CPS APIs use the cps-path (or cpsPath in Java API) parameter. The CPS Path is described in detail in :doc:`cps-path`. +CPS Delta +========= + +CPS Delta feature provides the ability to find the delta/difference between two JSON configurations. +The CPS Delta feature is described in detail in :doc:`cps-delta-feature`. + NCMP CM Handle Querying ======================= diff --git a/docs/release-notes.rst b/docs/release-notes.rst index f5cef76eda..191a04d1aa 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -16,6 +16,34 @@ CPS Release Notes .. * * * NEW DELHI * * * .. ========================= +Version: 3.4.4 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.4.4 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.4.4 New Delhi | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | Not yet released | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.4.4 + +Features +-------- + + Version: 3.4.3 ============== @@ -32,18 +60,27 @@ Release Data | **Release designation** | 3.4.3 New Delhi | | | | +--------------------------------------+--------------------------------------------------------+ -| **Release date** | Not yet released | +| **Release date** | 2024 February 07 | | | | +--------------------------------------+--------------------------------------------------------+ Bug Fixes --------- 3.4.3 - + - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Fix for Schema object cache not being distributed. + - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Fixes for upgrade yang modules using module set tag. + - `CPS-2070 <https://jira.onap.org/browse/CPS-2070>`_ Add retry interval for Kafka consumer. Features -------- - `CPS-1824 <https://jira.onap.org/browse/CPS-1824>`_ CPS Delta between 2 anchors. + - `CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_ Add maven classifier to Spring Boot JAR. + +Notes +----- +The maven build of cps-application has been changed so that the JAR produced by spring-boot-maven-plugin has a +*-springboot* classifier (`CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_). This means that the filename +of the Spring Boot JAR is *cps-application-3.4.3-springboot.jar*. Version: 3.4.2 ============== |