[FOLIO-2408] Decide standards and conventions for naming integration events Created: 20/Dec/19  Updated: 03/Feb/21  Resolved: 03/Feb/21

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: TBD
Reporter: Marc Johnson Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: potential-decision
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to MODINV-181 Integrate mod-inventory with mod-pubsub Closed
Sprint:

 Description   

Purpose

FOLIO is soon to introduce the capability to publish and subscribe to (integration) events.

Events (and hence event types) could be longer lived and more wide spread than interface definitions.

In order to support consistency and clarity of event definitions, I believe it is important to define standards and/or conventions for how events types are named.

Scope

This issue focuses solely on the names of event types. The topics of internal structure and semantics of events, and guidance around usage are out of scope unless relevant to the subject of naming.

Context

I believe FOLIO has struggled with defining standards and conventions for aspects of it's architecture. This causes inconsistencies between modules and confuses maintainers and users.

Often this gap has led to first implementors establishing defacto standards that FOLIO has had to live with going forward. Some notable examples are: interface and endpoint naming, database connection configuration, HTTP API semantics e.g. status codes, error responses etc

Current Situation

At the moment, there have been at least three different formats and naming structures used:

All capitalised, with past tense verb at the beginning, for example CREATED_INVENTORY_INSTANCE
All capitalised, with past tense verb at the end, for example NOTIFICATION_SENT
All lower case, with past tense verb at the end, for example marc_record_created

I personally find this confusing and unintuitive, making it harder to discover (or guess) what an is called.



 Comments   
Comment by Marc Johnson [ 03/Feb/21 ]

Closing as pre-dates the new decision making process and has not progressed

Generated at Thu Feb 08 23:20:25 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.