Open APIs

Dear Team,

One quick small query, Existing TMF639 v4.0 doesn't have exact resource delete event sample like resource create event however as per the document as we understand 

From TMF compliance point of view, if it's simple HTTP DELTE action request then we can simply pass resource id as below:

DELETE /tmf-api/resourceInventoryManagement/v4/resource/444 to delete it on demand.

However, as we are generating resource delete event then as per 639B conformance document resource mandatory attributes do we need to pass id, name, href as mandatory attributes in resource sample for delete event or just resource id is sufficient in resource delete event type?

{

  "eventId": "243421",

  "eventTime": "2023-06-16T16:42:25-04:00",

  "eventType": "ResourceDeleteEvent",

  "source": {

    "id": "APPXXXXX"

  },

  "event": {

    "resource": {

      "id": "22055683",

     "@type": "Device"

      }

  }

}

Hi Mahesh

The Delete event payload should include only the id, href, and @type. See this example from the v5 design guidelines document Part 1 (not published yet).

Hope it helps

{
  "correlationId": "45eba685-f411-4875-a8be-9382246b4f96",
  "description": "TroubleTicketDeleteEvent illustration",
  "domain": "Commercial",
  "eventId": "bb45761c-6f0d-41d3-921b-893fa172ffea",
  "eventTime": "2022-08-25T12:18:12.171Z",
  "eventType": "TroubleTicketDeleteEvent",
  "priority": "1",
  "timeOcurred": "2022-08-25T12:18:06.252Z",
  "title": "TroubleTicketDeleteEvent",
  "event": {
    "troubleTicket": {
      "id": "2a0a9c80-1ab4-42c9-b0fa-7b33a4c39679",
      "href": "https://mycsp.com/tmf-api/troubleTicket/v5/troubleTicket/2a0a9c80-1ab4-42c9-b0fa-7b33a4c39679",
      "@type": "TroubleTicket"
    }
  },
  "@baseType": "Event",
  "@type": "TroubleTicketDeleteEvent"
}

Thanks @Jonathan Goldberg for your inputs and it helps

So, be it resource delete event or serviceDeleteEvent or troubleTicketevent etc. id, href, @type is mandatory to pass in event...? Is that correct?

Presently we are on v4 version so future v5 version perspective these 3 would be mandatory ..correct?

Moreover, we don't have href available during delete event as its being deleted from Plan Build inventory and being informed to consumers so href may not be available.

Is it fine to send resource delete event without href?

Sorry you have already given ans. but please clarify.

{  "correlationId": "45eba685-f411-4875-a8be-9382246b4f96",  "description": "TroubleTicketDeleteEvent illustration",  "domain": "Commercial",  "eventId": "bb45761c-6f0d-41d3-921b-893fa172ffea",  "eventTime": "2022-08-25T12:18:12.171Z",  "eventType": "TroubleTicketDeleteEvent",  "priority": "1",  "timeOcurred": "2022-08-25T12:18:06.252Z",  "title": "TroubleTicketDeleteEvent",  "event": {    "troubleTicket": {      "id": "2a0a9c80-1ab4-42c9-b0fa-7b33a4c39679",      "href": "https://mycsp.com/tmf-api/troubleTicket/v5/troubleTicket/2a0a9c80-1ab4-42c9-b0fa-7b33a4c39679",      "@type": "TroubleTicket"    }  },  "@baseType": "Event",  "@type": "TroubleTicketDeleteEvent"}

I glanced through TMF630, the current design guidelines for v4 APIs. I couldn't find a specific directive for the Delete event. Many improvements have been made in v5 guidelines, and this is probably one of them.

Regarding href - you do have a point, but bear in mind that the design guidelines, and indeed API design, are not dependent on a particular implementation. Plausible implementations of DELETE are likely to be logical, marking the entity in the database as logically deleted, but not physically removed. We could then discuss if a valid href should return an entity that was logically deleted.

{  "correlationId": "45eba685-f411-4875-a8be-9382246b4f96",  "description": "TroubleTicketDeleteEvent illustration",  "domain": "Commercial",  "eventId": "bb45761c-6f0d-41d3-921b-893fa172ffea",  "eventTime": "2022-08-25T12:18:12.171Z",  "eventType": "TroubleTicketDeleteEvent",  "priority": "1",  "timeOcurred": "2022-08-25T12:18:06.252Z",  "title": "TroubleTicketDeleteEvent",  "event": {    "troubleTicket": {      "id": "2a0a9c80-1ab4-42c9-b0fa-7b33a4c39679",      "href": "https://mycsp.com/tmf-api/troubleTicket/v5/troubleTicket/2a0a9c80-1ab4-42c9-b0fa-7b33a4c39679",      "@type": "TroubleTicket"    }  },  "@baseType": "Event",  "@type": "TroubleTicketDeleteEvent"}