Versions Compared

Old Version 124

changes.mady.by.user Joseph Keenan

Saved on

compared with

New Version 125

changes.mady.by.user Joseph Keenan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Proposed Message Format

...


Info
iconfalse

Legend

ColorMeaning

NCMP standard event schema

Event payload schema as per org.onap.ncmp:async-request-response-event:v1

Response payload schema.  The payload schema is an onap one if non-passthrough but may be either an onap published or other (oran, proprietary, etc) schema if the original call received by the dmi plugin is a ncmp:passthrough-*.


SCOPE OF THE WORK :  the black highlighted parts of the above events. 
The blue highlight is not in current scope.  The blue bits will be up to the dmi plugins.
In the future these blue bits may become part of the standard onap base release.

...

Info
iconfalse
titleDMI Event sent to NCMP

{

  "eventId"                    : "9999",                                                                      # some generic event uuid generated by DMI Plugin
  “eventCorrelationId” : “request-009995”,                                                      # for event correlation - acts as the request Id when
                                                                                                                        # eventType=org.onap.ncmp.async-request-response-event
  "eventTime"             : "2021-11-16T16:42:25-04:00",
  "eventSource"          : "org.onap.ncmp",                                                        # ??? Is this needed?
  "eventType"             : "org.onap.ncmp.async-request-response-event",       # event type for async request response events
  ”eventSchema”        : “org.onap.ncmp:async-request-response-event:v1",  # event schema for async request response events
  “eventTarget”            : “topic:client-application-topic”,                                 # indicates where to route the event - ‘topic’ is default target type


  "event": {
     “response-data-schema” : “org.onap.cps.yang-patch-json:v1”,
     “response-status” : “SUCCESS”,
     “response-code”   : “201”,
     “response-data” : {
            …
           <response-data-payload>
           …
     }
  }
}

  • Is this not NCMP to DMI rather than DMI to NCMP?
       Kieran McCarthy : No, above is what is sent from DMI to NCMP.  This is the response that goes back to NCMP including the target client topic name 
    • Joseph Keenan Perfect thanks - I was thinking of the reponse once the async is recieved
  • Should response code above be OK?  
        Kieran McCarthy : as all calls are passthrough in the scope of this step/story thats up to the schema chosen for the dmi plugin.
                                     Normally end client applications prefer to work with codes rather than strings.  
  • Is there too much information being returned to NCMP?
    • Should we just return OK??
        Kieran McCarthy : again this is up to the chosen dmi plugin to decide on what the schema is - in this case for  it would be sufficient just return minimal data.
      I guess if it is a GET request then I suppose the response event will have some objects returned also meaning the schema would also need to support. 


Info
iconfalse
titleNCMP Event forwarded to Client topic (in eventTarget)

{

  "eventId"                    : "33001",                                                                    # some generic event uuid generated by NCMP
  “eventCorrelationId” : “request-009995”,                                                      # for event correlation - acts as the request Id when
                                                                                                                        # eventType=org.onap.ncmp.async-request-response-event
  "eventTime"             : "2015-11-16T16:42:26-05:06",
  "eventSource"          : "org.onap.ncmp",                                                        # The source of the event
  "eventType"             : "org.onap.ncmp.async-request-response-event",       # event type for async request response events
  ”eventSchema”        : “org.onap.ncmp:async-request-response-event:v1",  # event schema for async request response events

  "eventOrigin"           : {

        "eventId"                    : "00001",                                                                     # some generic event uuid generated by DMI Plugin
        "eventTime"               : "2021-11-16T16:42:25-04:00",
        “eventCorrelationId” : “request-009995”,     
        "eventSource"           : "org.onap.dmi",                                                           # ??? Is this needed?
        "eventType"               : "org.onap.ncmp.async-request-response-event",      # event type for async request response events
        ”eventSchema”          : “org.onap.ncmp:async-request-response-event:v1",  # event schema for async request response events
        “eventTarget”            : “topic:client-application-topic”
   },


  "event": {
     “response-data-schema” : “org.onap.cps.yang-patch-json:v1”,
     “response-status” : “SUCCESS”,
     “response-code”   : “201”,
     “response-data” : {
            …
           <response-data-payload>
           …
     }
  }
}

...