asyncapi / asyncapi/spec

Proposal: Add Saga Pattern Example for E-commerce Order Processing

Open
#1,175 5 comments 0 reactions 0 assignees View on GitHub
❔ Question stale
Dominant language
JavaScript
Stars
5.3k
Forks
382
Avg merge
7m
Merged PRs (30d)
4

Description

## **Proposal: Add Saga Pattern Example for E-commerce Order Processing**

### **Context and Problem Statement**
The current examples in the AsyncAPI specification will not include a comprehensive demonstration of the Saga pattern, which will be crucial for implementing distributed transactions in event-driven architectures.

### **Proposed Solution**
I will create a new example [ecommerce-saga-asyncapi.yml](cci:7://file:///Users/sujal/Desktop/Project/spec/spec/examples/ecommerce-saga-asyncapi.yml:0:0-0:0) that will demonstrate:
- A complete e-commerce order processing flow
- Distributed transaction management using the Saga pattern
- Compensation handling for rollback scenarios
- Clear message schemas and event flows

### **Example Location**
The example will be available at: [spec/examples/ecommerce-saga-asyncapi.yml](cci:7://file:///Users/sujal/Desktop/Project/spec/spec/examples/ecommerce-saga-asyncapi.yml:0:0-0:0)

### **Additional Context**
- The implementation will use AsyncAPI 2.6.0
- It will include detailed message schemas
- It will demonstrate error handling and compensation
- It will follow the same structure as other examples in the repository

### **Next Steps**
- [x] Review the example
- [x] Provide feedback
- [ ] Merge if approved

Would you like me to submit this as a pull request for review?

Contributor guide

Open the contributing guide

Research direction

Start by comparing the proposed spec/examples/ecommerce-saga-asyncapi.yml with the existing examples and confirm the AsyncAPI 2.6.0 structure. The work is done when the example documents the complete order flow, Saga compensation and error handling, with clear message schemas and event flows consistent with the repository’s examples.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.