Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

CPS-1104 - Getting issue details... STATUS


#Issue

Notes

Decisions






Overview

This page is for deciding the structure of the proposed "detail" section which needs to be introduced in the NcmpEvent payload.
Refer : CPS-858 Define Notifications on CM Handle Add (Ready) & Delete  #8

Purpose : Generic field to store information about the state.


Current Schema

Current NcmpSchema
{
  "eventId"                  : "00001",    
  "eventCorrelationId  : "cmhandle-001",       
  "eventTime"              : "2021-11-16T16:42:25-04:00",
  "eventSource"           : "org.onap.ncmp",                                 
  "eventType"              : "org.onap.ncmp.cmhandle-lcm-event",   
  ”eventSchema”         : “org.onap.ncmp:cmhandle-lcm-event:v1",   

  "event": {
     “cmhandle-state”     : “READY”,

      "cmHandleId" : "cmhandle-001",
      “cmhandle-properties” : [
          {“public-property-name-1” : “public-property-value-1”},
          {“public-property-name-2” : “public-property-value-2”}     
       ]
    }
}


Proposed Schema


  1. Structured detail schema

    Option#1
    {
      "eventId"                  : "00001",    
      "eventCorrelationId  : "cmhandle-001",       
      "eventTime"              : "2021-11-16T16:42:25-04:00",
      "eventSource"           : "org.onap.ncmp",                                 
      "eventType"              : "org.onap.ncmp.cmhandle-lcm-event",   
      ”eventSchema”         : “org.onap.ncmp:cmhandle-lcm-event:v1",   
    
      "event": {
         “cmhandle-state”     : “READY”,
    
          "cmHandleId" : "cmhandle-001",
         “cmhandle-properties” : [
              {“public-property-name-1” : “public-property-value-1”},
              {“public-property-name-2” : “public-property-value-2”}     
           ],
         "detail": {
             "detailMessage" : "sample message about the event",
              "lastCmHandleState" : "ADVISED"
              }
        }
    }




  2.  No Detail object , just add the lastCmHandleState

    Option#2
    {
      "eventId"                  : "00001",    
      "eventCorrelationId  : "cmhandle-001",       
      "eventTime"              : "2021-11-16T16:42:25-04:00",
      "eventSource"           : "org.onap.ncmp",                                 
      "eventType"              : "org.onap.ncmp.cmhandle-lcm-event",   
      ”eventSchema”         : “org.onap.ncmp:cmhandle-lcm-event:v1",   
    
      "event": {
         “cmhandle-state”     : “READY”,
         "last-cmhandle-state" : "ADVISED",
    
          "cmHandleId" : "cmhandle-001",
         “cmhandle-properties” : [
              {“public-property-name-1” : “public-property-value-1”},
              {“public-property-name-2” : “public-property-value-2”}     
           ]
        }
    }





    3. Introduce a Map which can take in any detail in the future ( just like cmhandle-properties)

    Option#3
    {
      "eventId"                  : "00001",    
      "eventCorrelationId  : "cmhandle-001",       
      "eventTime"              : "2021-11-16T16:42:25-04:00",
      "eventSource"           : "org.onap.ncmp",                                 
      "eventType"              : "org.onap.ncmp.cmhandle-lcm-event",   
      ”eventSchema”         : “org.onap.ncmp:cmhandle-lcm-event:v1",   
    
      "event": {
         “cmhandle-state”     : “READY”,
    
          "cmHandleId" : "cmhandle-001",
         “cmhandle-properties” : [
              {“public-property-name-1” : “public-property-value-1”},
              {“public-property-name-2” : “public-property-value-2”}     
           ],
    
       “detail” : [
              {“lastCmHandleState” : “ADVISED”},
              {“sampleMessage” : “some message”}     
           ]
        }
    }





     
  • No labels