ProvMnS: Update Documentation 13/142913/2
authorToineSiebelink <toine.siebelink@est.tech>
Mon, 12 Jan 2026 17:36:51 +0000 (17:36 +0000)
committerToineSiebelink <toine.siebelink@est.tech>
Tue, 13 Jan 2026 17:52:02 +0000 (17:52 +0000)
Issue-ID: CPS-2706
Change-Id: I6dc66c09318b8dc4683885baafd1c55ed33325ef
Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
docs/csv/metrics.csv
docs/design.rst
docs/release-notes.rst

index f008323..0aa8850 100644 (file)
@@ -9,14 +9,14 @@
 "cps_ncmp_inventory_cm_handles_by_state{state=LOCKED}","Current number of cm handles in locked state"
 "cps_ncmp_inventory_cm_handles_by_state{state=DELETING}","Current number of cm handles in deleting state"
 "cps_ncmp_inventory_cm_handles_by_state{state=DELETED}","Number of cm handles that have been deleted since the application started"
-"cps.ncmp.cmnotifications.consumeandforward","Time taken to forward CM AVC events"
 "cps.ncmp.dmi.get","Time taken to fetch the resource data from operational data store for given cm handle "
+"cps.ncmp.cm.notifications.consume.and.forward","Time taken to forward CM AVC events"
 "cps.ncmp.inventory.persistence.datanode.get","Time taken to get a data node (from ncmp dmi registry)"
 "cps.ncmp.inventory.persistence.datanode.get","Time taken to get a data node (from ncmp dmi registry)"
 "cps.ncmp.inventory.module.references.from.dmi","Time taken to get all module references for a cm handle from dmi"
 "cps.ncmp.inventory.yang.resources.from.dmi","Time taken to get list of yang resources from dmi"
 "cps.ncmp.cmhandle.state.update.batch","Time taken to update a batch of cm handle states"
-"cps.rest.admin.controller.schemaset.create","Time taken to create schemaset from controller"
+"cps.rest.admin.controller.schema.create","Time taken to create schema set from controller"
 "cps.data.controller.datanode.get.v1","Time taken to get data node"
 "cps.data.controller.datanode.get.v2","Time taken to get data node"
 "cps.data.controller.datanode.get.v3","Time taken to get data node"
@@ -29,9 +29,9 @@
 "cps.data.persistence.service.datanode.query.anchors","Time taken to query data nodes across all anchors or list of anchors"
 "cps.data.persistence.service.datanode.get","Time taken to get a data node"
 "cps.data.persistence.service.datanode.batch.get","Time taken to get data nodes"
-"cps.module.persistence.schemaset.create","Time taken to store a schemaset (list of module references)"
-"cps.module.persistence.schemaset.createFromNewAndExistingModules","Time taken to store a schemaset (from new and existing)"
-"cps.dataupdate.events.send","Time taken to send Data Update event"
+"cps.module.persistence.schema.create","Time taken to store a schema set (list of module references)"
+"cps.module.persistence.schema.createFromNewAndExistingModules","Time taken to store a schema set (from new and existing)"
+"cps.data.update.events.send","Time taken to send Data Update event"
 "cps.data.service.datanode.root.save","Time taken to save a root data node"
 "cps.data.service.datanode.child.save","Time taken to save a child data node"
 "cps.data.service.list.element.save","Time taken to save list elements"
 "cps.data.service.list.update","Time taken to update a list"
 "cps.data.service.list.batch.update","Time taken to update a batch of lists"
 "cps.data.service.datanode.delete","Time taken to delete a datanode"
-"cps.data.service.datanode.batch.delete","Time taken to delete a batch of datanodes"
-"cps.data.service.datanode.delete.anchor","Time taken to delete all datanodes for an anchor"
-"cps.data.service.datanode.delete.anchor.batch","Time taken to delete all datanodes for multiple anchors"
+"cps.data.service.datanode.batch.delete","Time taken to delete a batch of data nodes"
+"cps.data.service.datanode.delete.anchor","Time taken to delete all data nodes for an anchor"
+"cps.data.service.datanode.delete.anchor.batch","Time taken to delete all data nodes for multiple anchors"
 "cps.data.service.list.delete","Time taken to delete a list or list element"
 "cps.delta.service.get.delta","Time taken to get delta between anchors"
 "cps.delta.service.get.delta","Time taken to get delta between anchor and a payload"
-"cps.module.service.schemaset.create","Time taken to create (and store) a schemaset"
+"cps.module.service.schema.create","Time taken to create (and store) a schema set"
 "cps.data.service.datanode.query","Time taken to query data nodes"
 "cps.data.service.datanode.query","Time taken to query data nodes with a limit on results"
-"cps.utils.yangparser.nodedata.with.parent.parse","Time taken to parse node data with a parent"
-"cps.utils.yangparser.nodedata.with.parent.with.yangResourceMap.parse","Time taken to parse node data with a parent"
-"cps.yangtextschemasourceset.build","Time taken to build a yang text schema source set"
-"cps.yang.schemasourceset.build","Time taken to build a ODL yang Model"
+"cps.utils.yang.parser.node.data.with.parent.parse","Time taken to parse node data with a parent"
+"cps.utils.yang.parser.node.data.with.parent.with.yangResourceMap.parse","Time taken to parse node data with a parent"
+"cps.yang.text.schema.source.set.build","Time taken to build a yang text schema source set"
+"cps.yang.schema.source.set.build","Time taken to build a ODL yang Model"
index bc0acd9..c10102a 100644 (file)
@@ -27,10 +27,37 @@ CPS-Core functionality.
 CPS-NCMP
 --------
 
-XNF data access and module information.
+XNF data access and module information
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>`
 
+Provisioning Management Service
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+:download:`ProvMnS API Specification <https://forge.3gpp.org/rep/sa5/MnS/-/raw/Tag_Rel18_SA110/OpenAPI/TS28532_ProvMnS.yaml>`
+
+The following limitations apply to the implementation of the ProvMnS API:
+
+- Unsupported GET Accept Type:
+
+   - application/vnd.3gpp.object-tree-flat+json
+
+- Unsupported PATCH Accept Types:
+
+   - application/merge-patch+json
+   - application/3gpp-merge-patch+json
+
+- Unsupported PATCH Operations:
+
+   - copy
+   - move
+   - test
+
+- Maximum of 10 Operations in a single PATCH request.
+
+- Asynchronous notifications (callbacks) are not implemented.
+
 CPS-NCMP-Inventory
 ------------------
 
@@ -61,7 +88,7 @@ Notes
 -----
 
 Input Size limitations
-++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^
 
 Depending on HTTP servers used, the request size is typically limited. For example Nginx has a default limit of 1MB.
 In this case it means that a registration request is limited to approximately 3,000 cm handles (depending on the length of cm handle ids and other properties involved).
index 0449996..7707570 100644 (file)
@@ -31,6 +31,9 @@ Release Data
 |                                      |                                                        |
 +--------------------------------------+--------------------------------------------------------+
 
+Features
+--------
+    - `CPS-1992 <https://lf-onap.atlassian.net/browse/CPS-1992>`_ NCMP to Support ProvMnS CM New 3GPP sync single FDN request
 
 Version: 3.7.3
 ==============