1 Which operation(s) need support for multiple cm handles? Get Create Update (Put) Patch Delete if many what is the priority?
agreed 08 Mar 2023 with kieran mccarthy
Only Get (read)
(in future other operations might be support batch option too)
2 Which datasources should be supported?
Do we need to support passthrough-only no-cached() data only ?
agreed 08 Mar 2023 with kieran mccarthy :
all passthrough datastores will be supported
Not implemented (yet) response, for non passthrough datastores
3 URL pattern for NCMP bulk endpoints 08 Mar 2023
Existing : /v1/ch/{cm-handle}/data/ds/{datastore-name}
CPS Proposed : /v1/batch/data/ds/{datastore-name}
( include cm handles into payload / body and leave datastore into url)
-----------------------------------------------------------------------------------------------------------------------
17 Apr 2023 Meeting : kafka message schema & batch interface extension
POST http://localhost:8080/ncmp/v1/batch&topic=my-topic-name
{
agreed 08 Mar 2023 with kieran mccarthy : Follow the existing interfaces as much as possible for consistency and efficiency
------------------------------------------------------------------------------------------------------------
4 keep datastore, topic and optional parameters in the URL itself instead into body. CPS prefers keep interface similar as single cm handle interface (consistency and cost)
Existing : ...&topic=topicParamInQuery
agreed 08 Mar 2023 with kieran mccarthy : Follow the existing interfaces as much as possible for consistency and efficiency
5 support in ONAP DMI-plugin
agreed 08 Mar 2023 with Toine Siebelink : ONAP plugin can respond with not implemented yet code,
6 Response always Async ie. topic is compulsory ?
Assume topic is compulsory (defined in OPenApi) → Response therefore wil be 400 if not supplied Agreed 08 Mar 2023 with kieran mccarthy :
Topic is optional but system will respond with 'Not implemented (yet when not specified or blank
7 Should NCMP Amalgamate Async responses from DMI-Plugin before forwarding ? step 6 in flow diagram Agreed 08 Mar 2023 with kieran mccarthy : NCMP wil only forward to client topic no handling tracking or any responses or status of request
8 Handle non responding dmi-plugin Agreed 08 Mar 2023 with kieran mccarthy :
9 Should (can) NCMP check if 'MyTopic' specified by client exist Consider Access Control too. For now NCMP can log error. Client is responsible for topic setup Agreed 08 Mar 2023 with kieran mccarthy :
10 How to handle non-existing CM-Handles (id) Suggestions
Silently ignore (initial) error responseshould we combine all errors in one message? Agreed 08 Mar 2023 with kieran mccarthy :
Additional error (messages) response with all cm-handles that cannot be resolved, also a separate error message wil be sent for each failed DMI
11 Overlap/clash with Deutsche Telekom user story:
Jiraserver ONAP Jira serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1377
?!
08 Mar 2023 discussed in weekly ONAP meeting the DT user story is affect CPS-Core interface (not NCMP) and the requirement is to execute a query over ALL cm-handles (cached only?!) instead of a given list of cm-handles (~anchors)
12 Schema of bulk response
Jiraserver ONAP Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1556
1) Agreement required on the structure of the response. Please see response structure below.
Code Blocktitle Schema of bulk response collapse true
{
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$id": "urn:cps:org.onap.cps.ncmp.events.v1:dmi-async-bulk-response-event-schema:v1",
"$ref": "#/definitions/DmiAsyncBulkResponseEvent",
"definitions": {
"DmiAsyncBulkResponseEvent": {
"description": "The payload for bulk response event.",
"type": "object",
"properties": {
"eventId": {
"description": "The unique id identifying the event generated by DMI for this bulk response event.",
"type": "string"
},
"eventCorrelationId": {
"description": "The request id passed by NCMP for this bulk response event.",
"type": "string"
},
"eventTime": {
"description": "The time of bulk response event. The expected format is 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'.",
"type": "string"
},
"eventType": {
"description": "The type of bulk response event.",
"type": "string"
},
"eventSchema": {
"description": "The event schema for bulk response event.",
"type": "string"
},
"eventSchemaVersion": {
"description": "The event schema version for bulk response event.",
"type": "string"
},
"event": {
"$ref": "#/definitions/Event"
}
},
"required": [
"eventId",
"eventCorrelationId",
"eventType",
"eventSchema",
"eventSchemaVersion"
]
},
"Event": {
"description": "The bulk response event content.",
"type": "object",
"existingJavaType": "java.lang.Object"
}
}
}
Code Blocktitle Sample bulk response collapse true
{
"eventId": "4cb32729-85e3-44d1-aa6e-c923b9b059a5",
"eventCorrelationId": "68f15800-8ed4-4bae-9e53-27a9e03e1911",
"eventTime": "2023-03-28T14:29:23.876+0000",
"eventType": "org.onap.cps.ncmp.event.model.BulkResponseEvent",
"eventSchema": "urn:cps:org.onap.cps.ncmp.event.model.BulkResponseEvent",
"eventSchemaVersion": "v1",
"event": {
"payload": "response of batch cm handles"
}
}
13 Schema for Bulk Response event forwarding to client specified topic
- NCMP : forward bulk response messages to client topic
Not keeping the 'eventTarget' which comes from the ( BulkResponseEvent(In progress of the structure agreement)) .
Note: Will consider 'eventTarget', If it finalized the schema from
Jiraserver ONAP Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1556
Code Blocktitle Schema of bulk response collapse true
{
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$id": "urn:cps:org.onap.cps.ncmp.events.v1:ncmp-async-bulk-response-event-schema:v1",
"$ref": "#/definitions/NcmpAsyncBulkResponseEvent",
"definitions": {
"NcmpAsyncBulkResponseEvent": {
"description": "The payload for bulk response event.",
"type": "object",
"properties": {
"eventId": {
"description": "The unique id identifying the event generated by DMI for this bulk response event.",
"type": "string"
},
"eventCorrelationId": {
"description": "The request id passed by NCMP for this bulk response event.",
"type": "string"
},
"eventTime": {
"description": "The time of bulk response event. The expected format is 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'.",
"type": "string"
},
"eventType": {
"description": "The type of bulk response event.",
"type": "string"
},
"eventSchema": {
"description": "The event schema for bulk response event.",
"type": "string"
},
"eventSchemaVersion": {
"description": "The event schema version for bulk response event.",
"type": "string"
},
"event": {
"$ref": "#/definitions/Event"
}
},
"required": [
"eventId",
"eventCorrelationId",
"eventType",
"eventSchema",
"eventSchemaVersion"
]
},
"Event": {
"description": "The bulk response event content.",
"type": "object",
"existingJavaType": "java.lang.Object"
}
}
}
Code Blocktitle Sample bulk response collapse true
{
"eventId": "4cb32729-85e3-44d1-aa6e-c923b9b059a5",
"eventCorrelationId": "68f15800-8ed4-4bae-9e53-27a9e03e1911",
"eventTime": "2023-03-28T14:29:23.876+0000",
"eventType": "org.onap.cps.ncmp.event.model.AysncBulkResponseEvent",
"eventSchema": "urn:cps:org.onap.cps.ncmp.event.model.AysncBulkResponseEvent",
"eventSchemaVersion": "v1",
"event": {
"payload": "response of batch cm handles"
}
}
14 How NCMP would forward response? (Response data : ref. message flow #6)
Jiraserver ONAP Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1556
1. Do we need to send only one response containing all the requested cm handles ?kieran mccarthy - Please share your inputs on the above listed questions.
15 Message format for the batch interface
kafka Headers Field Type Description M=Mandatory, O=Optional Notes Decision eventId string The unique id identifying the event M Generated by DMI-Plugin eventCorrelationId string The request id passed by NCMP M It's requestId that NCMP sent to client as an ACK.
Example : “request-1234" (UUID)
eventTime string The timestamp when original event occurred O Example of Internet date/time format.
1985-04-12T23:20:50.52Z
This represents 20 minutes and 50.52 seconds after the 23rd hour of
April 12th, 1985 in UTC.
The timestamp should follow that on https://www.rfc-editor.org/rfc/rfc3339#section-5 .
This follows ISO 8601 and is what is used/referenced in 3GPP standards eventTarget string The destination topic of the client M Example : my-topic eventSource string The source of the event O Example : dmi-plugin:enm-1 (dmi service name) eventType string The type of the event M NCMP would own eventType that would be used by dmi-plugin Example :
In case of NCMP (Defined and owned) "org.onap.cps.ncmp.event.model.BatchXXXEvent" In case of DMI-plugin (Use NCMP defined event type) "org.onap.cps.ncmp.event.model.BatchXXXEvent" kieran mccarthy Please confirm following :
event type proposed name :
BathDataXXXEvent ?
For example :
BatchDataRequestEvents BathDataResponseEvent
eventSchema string The schema that this event adheres to. M NCMP would own eventSchema that would be used by dmi-plugin Example :
In case of NCMP (Defined and owned) "urn:cps:org.onap.cps.ncmp.event.model.BatchEvent:v1“ In case of DMI-plugin (Use NCMP defined event type) "urn:cps:org.onap.cps.ncmp.event.model.BatchEvent:v1“ schemaVersion string The version of the schema that this event adheres to M For example a version might be 1.0.0 (without “v”)
On versioning O-RAN follows https://semver.org .
Propose we follow the same for our schemas.
Field name should be "eventSchemaVersion" ?
Event Payload event Event The payload of an event M event.response-code String The received status code of the response M common ncmp definned error codes:
response code 0-99 is reserved for any succeess message
response code 100
response-code response-message event.data event.error 1 Success message Non empty null 100 Error message null Non empty
event.response-message String M Example :
In case of success : response-code : 1 response-message : Success message In case of failure : response-code : 100 response-message : Error message event.data array The data payload O NCMP will not amalgamate any data event.data.id String cmhandle-id M Example : "2" event.data.operationId String specified to distinguish multiple operations using same cmhandleId M Example : "12"
NCMP wil not check uniqueness of 'operationId' event.data.data object O optional - probably only required in case of "read" operations. APPLICATION/YANG-PATCH+JSON # create, update, delete, multiwrite operations won't have return data (to verify) NCMP will not amalgamate any data evenr.error object O event.error.operations array M event.error.operations.operationId String M mandatory - specified to distinguish multiple operations using same cmhandleId NCMP wil not check uniqueness of 'operationId' event.error.operations.ids array cmhandle-ids M Example : ["cm-1",...,"cm-n"]
