Conversation
EventCatalog: Schema ReviewThe following schemas were modified in this pull request: Order amended (0.0.1) (
|
| Schema Format | Risk Score |
|---|---|
| proto3 | 70/100 |
The new schema introduces a well-defined event structure for order amendments, adhering to EDA best practices by including specific domain actions and a version number. However, the lack of a previous schema makes it difficult to assess backward compatibility, posing potential risks to downstream consumers like the Inventory Service.
Potential Effected Consumers
- Inventory Service (0.0.2) - The Inventory Service may be affected by changes in the event structure, particularly if it relies on fields that have been modified or added. Ensure compatibility with the new schema to prevent disruptions.
Order amended (0.0.1) (✅ Safe)
| Schema Format | Risk Score |
|---|---|
| json | 85/100 |
The schema change introduces a new optional field 'userName', which is backward compatible as it does not affect existing required fields. However, the absence of a version number in the event schema is a deviation from best practices. The change is low risk but should be communicated to consumers to ensure they handle the new field appropriately.
Potential Effected Consumers
- Inventory Service (0.0.2) - The Inventory Service may be affected by the addition of the 'userName' field. Ensure that the service can handle this new field without issues, even though it is not required.
Order amended (0.0.1) (✅ Safe)
| Schema Format | Risk Score |
|---|---|
| json | 0/100 |
The new schema could not be retrieved, making it impossible to assess the changes for backward compatibility or adherence to best practices. Without the new schema, we cannot determine the impact on consumers or identify any potential breaking changes.
Potential Effected Consumers
- Inventory Service (0.0.2) - The Inventory Service may be affected by changes to the OrderAmendedEvent schema. Without the new schema, it's unclear how the service might be impacted, but any changes to field types, names, or structures could disrupt its functionality.
Using Model: gpt-4o | Provider: openai
No description provided.