Mule application documentation suite
Northwind partner ingest: start with the map, then open the owning document
This landing page routes readers to the smallest document that owns their question. It does not duplicate RAML, flow behavior, deployment procedure, or incident response.
Two-minute orientation
The application accepts partner events over HTTP, validates them against the RAML contract, transforms them into the Northwind event envelope, and posts them to /events. It does not own warehouse schema, producer identity policy, or ingestion queue topology.
Boundary: partner-specific shape ends at the transformation. Retry and event identity after that point follow the Northwind Events API.
Documents in this set
open by questionStart here
README.md
Purpose, boundaries, local proof, and links to every owning page.
How it works
docs/architecture.md
Listeners, flows, transforms, dependencies, error routes, and trust boundaries.
Wire contract
docs/api-contract.md
RAML source, authentication, examples, stable errors, and downstream mapping.
Get productive
docs/onboarding.md
Prerequisites, local runtime, one partner fixture, and readiness proof.
Operate
docs/runbook.md
Only emitted when the repository contains application-specific operational controls.
Test evidence
docs/test-report.md
Only emitted for a named build or release decision, never as a permanent stub.
Ownership and flow inventory
current state| Flow | Trigger | Responsibility | Failure owner |
|---|---|---|---|
partner-http | Partner POST | Authenticate, validate RAML, assign request ID | partner-ingest |
to-northwind-event | Validated message | Map partner fields to event envelope | partner-ingest |
publish-event | Mapped event | Call Northwind POST /events with stable ID | Shared with Events API |
retry-or-dead-letter | Retryable failure | Bound retries and preserve identity | partner-ingest |
Evidence and freshness rules
trust- RAML and Mule configuration are the source for listeners, routes, properties, and transformations.
- MUnit results support named test claims; absent tests are not inferred passes.
- Deployment files own environment names and required configuration.
- The Northwind OpenAPI file owns downstream event behavior.
- When evidence conflicts, record the mismatch in the owning document instead of smoothing it over here.
Generate only documents supported by real evidence. A short suite with four complete pages is better than a catalog of empty headings.