diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 4 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 14 | ||||
| -rw-r--r-- | docs/cm-notification-subscriptions.rst | 20 | ||||
| -rw-r--r-- | docs/schemas/dmidataavc/avc-event-schema-1.0.0.json | 88 |
4 files changed, 113 insertions, 13 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index 8552ad53e3..c72f47a428 100644 --- a/docs/api/swagger/ncmp/openapi-inventory.yaml +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -136,8 +136,8 @@ paths: \ plugin)." operationId: searchCmHandleIds parameters: - - description: Boolean parameter to determine if returned value(s) will be cmHandle - Ids or Alternate Ids for a given query + - description: Boolean parameter to determine if returned value(s) will be cm + handle references for a given query in: query name: outputAlternateId required: false diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index aa732c8566..024aed681c 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -698,7 +698,7 @@ paths: schema: $ref: '#/components/schemas/DmiErrorMessage' description: Bad Gateway - summary: Execute a data operation for group of cm handle ids + summary: Execute a data operation for group of cm handle references tags: - network-cm-proxy /v1/ch/{cm-handle}/data/ds/{datastore-name}/query: @@ -1141,8 +1141,8 @@ paths: this query. operationId: searchCmHandleIds parameters: - - description: Boolean parameter to determine if returned value(s) will be cmHandle - Ids or Alternate Ids for a given query + - description: Boolean parameter to determine if returned value(s) will be cm + handle references for a given query in: query name: outputAlternateId required: false @@ -1618,8 +1618,8 @@ components: example: 2024-01-22 type: string outputAlternateIdOptionInQuery: - description: Boolean parameter to determine if returned value(s) will be cmHandle - Ids or Alternate Ids for a given query + description: Boolean parameter to determine if returned value(s) will be cm + handle references for a given query in: query name: outputAlternateId required: false @@ -1789,8 +1789,8 @@ components: type: string targetIds: items: - description: "targeted cm handles, maximum of 50 supported. If this limit\ - \ is exceeded the request wil be refused." + description: "targeted cm handle references, maximum of 200 supported.\ + \ If this limit is exceeded the request wil be refused." example: "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\ ]" type: string diff --git a/docs/cm-notification-subscriptions.rst b/docs/cm-notification-subscriptions.rst index 14e871addc..e1d1c2f800 100644 --- a/docs/cm-notification-subscriptions.rst +++ b/docs/cm-notification-subscriptions.rst @@ -6,14 +6,14 @@ .. _cmNotificationSubscriptions: -CM Data Subscriptions -##################### +CM Data Subscriptions and Notifications +####################################### .. toctree:: :maxdepth: 1 -Introduction -============ +CM Data Subscriptions +===================== CM Subscriptions are created to subscribe to notifications for CM related changes that happened in the network based on predicates. Predicates can be used to filter on CM Handle (id), Datastore and Xpath. @@ -44,5 +44,17 @@ The response for the involved subscription participants for the Create and Delet **Note.** The Cm Subscription feature relies on the DMI Plugin support for applying the subscriptions. This support is currently not implemented in the ONAP DMI Plugin. +CM Data Notifications +===================== +CM Notifications are triggered by any change in the network, provided the client has already set up a CM Subscription to receive such notifications. Once the events are generated, they are processed by NCMP and forwarded to the client in the same format. + +**Note.** Currently, CM Notifications are sent regardless of the CM Subscriptions. Notifications controlled by CM Subscription have not yet been delivered. + +The CM Notification Event follows the structure outlined in the schema below: + +:download:`CM Data Notification Event Schema <schemas/dmidataavc/avc-event-schema-1.0.0.json>` + +**Note.** NCMP uses the CM Notification event key from the source topic to forward notifications to the client, ensuring that the order of notifications within a topic partition is maintained during forwarding. +**Note.** If the notification key from the source topic is null, NCMP cannot guarantee the order of events within a topic partition when forwarding. diff --git a/docs/schemas/dmidataavc/avc-event-schema-1.0.0.json b/docs/schemas/dmidataavc/avc-event-schema-1.0.0.json new file mode 100644 index 0000000000..474520d142 --- /dev/null +++ b/docs/schemas/dmidataavc/avc-event-schema-1.0.0.json @@ -0,0 +1,88 @@ +{ + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "urn:cps:org.onap.cps.ncmp.events:avc-event-schema:1.0.0", + "$ref": "#/definitions/AvcEvent", + "definitions": { + "Edit": { + "additionalProperties": false, + "properties": { + "edit-id": { + "type": "string" + }, + "operation": { + "type": "string" + }, + "target": { + "type": "string" + }, + "value": { + "type": "object", + "existingJavaType": "java.lang.Object" + } + }, + "required": [ + "edit-id", + "operation", + "target" + ] + }, + "AvcEvent": { + "description": "The payload for AVC event.", + "type": "object", + "javaType": "org.onap.cps.ncmp.events.avc1_0_0.AvcEvent", + "properties": { + "data": { + "description": "The AVC event content compliant with RFC8641 format", + "type": "object", + "additionalProperties": false, + "properties": { + "push-change-update": { + "type": "object", + "additionalProperties": false, + "properties": { + "datastore-changes": { + "type": "object", + "additionalProperties": false, + "properties": { + "ietf-yang-patch:yang-patch": { + "type": "object", + "additionalProperties": false, + "properties": { + "patch-id": { + "type": "string" + }, + "edit": { + "type": "array", + "items": { + "$ref": "#/definitions/Edit" + } + } + }, + "required": [ + "patch-id", + "edit" + ] + } + }, + "required": [ + "ietf-yang-patch:yang-patch" + ] + } + }, + "required": [ + "datastore-changes" + ] + } + }, + "required": [ + "push-change-update" + ] + } + }, + "required": [ + "data" + ], + "additionalProperties": false + } + } +}
\ No newline at end of file |