PI-1473 add enhancement ability for domain events

[anthony-britton-moj]

Part one about ready - ability to add the detail url (or any other information desired) to a domain event
Part two to add the api reading ability - detail url added for probation-case.engagement.created

[marcus-bcl]

Just a thought, happy to leave it as is - but should we prefix the path with something like "/details/..."? E.g.

domain-events-and-delius.hmpps.service.justice.gov.uk/details/probation-case.engagement.created/A123456

in case we ever need to add any other API endpoints (unrelated to event details) to this service?

[anthony-britton-moj]

Just a thought, happy to leave it as is - but should we prefix the path with something like "/details/..."? E.g.

domain-events-and-delius.hmpps.service.justice.gov.uk/details/probation-case.engagement.created/A123456

in case we ever need to add any other API endpoints (unrelated to event details) to this service?

My initial thoughts were to add details in the url, however, I then thought we would not want to add other API endpoints that were not related to event details -- it's in the name - domain event service? Everything we put here should be related to domain events, and probably only the detail for them. Other endpoints would probably go elsewhere, otherwise we risk another community-api scenario?
If we did want to change it later - given we produce the detail url, we can also update to include details - but at the moment it feels a little redundant.