search

event-catalog / eventcatalog

An open source documentation tool to bring discoverability to your event-driven architectures
https://eventcatalog.dev
MIT License
1.67k stars 139 forks source link

feat(core): added new content type "flows" #709

Closed boyney123 closed 1 month ago

boyney123 commented 1 month ago

New feature for EventCatalog that allows users to document "flows".

Flows are way to document processes or EDA choreography across your domains, services and messages.

Flows API allows you to define "steps" for a particular feature. An example of this would be capturing a payment from a user.

Example

An example of a "flow" would be capturing a payment from a user.

When a payment is captured from a user commands are sent, and events are raised. Services are also involved as well as external systems. From end-to-end many commands, events and services will be interacted with. Flows allows you to document this, version it and visualize it.

changeset-bot[bot] commented 1 month ago

🦋 Changeset detected

Latest commit: 568f2f7c9bd35eaf1742d293e0bb0be9703272c0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package | Name | Type | | ------------------ | ----- | | @eventcatalog/core | Minor |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR