@eventcatalog/core 4.1.3 → 4.1.4

package/dist/docs/development/guides/messages/events/02-adding-events.md

@@ -1,130 +0,0 @@
----
-sidebar_position: 2
-keywords:
-- EventCatalog events
-sidebar_label: Creating an event
-title: Creating events
-description: Creating and managing events within EventCatalog.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-Events live in a `/events` folder. This folder can be placed:
-
-- At the root of your catalog, or
-  - `/events/{Event Name}/index.mdx` 
-- Inside a specific service folder.
-  - `/services/{Service Name}/events/{Event Name}/index.mdx` 
-
-The contents are split into two sections, **frontmatter** and the **markdown content**.
-
-_Here is an example of what a event markdown file may look like._
-
-```md title="/events/InventoryAdjusted/index.mdx (example)"
----
-# id of your event, used for slugs and references in EventCatalog.
-id: InventoryAdjusted
-
-# Display name of the event, rendered in EventCatalog
-name: Inventory Adjusted
-
-# Version of the event
-version: 0.0.4
-
-# Short summary of your event
-summary: |
-  Event with the intent to adjust the inventory
-
-# Optional owners, references teams or users
-owners:
-    - dboyne
-
-# Optional badges, rendered to UI by EventCatalog
-badges:
-    - content: New service
-      backgroundColor: blue
-      textColor: blue
----
-
-## Overview
-
-The `Inventory Adjusted` event represents intent to adjust the inventory of a given item.
-
-<NodeGraph />
-
-```
-
-Once this file is added, the event will automatically appear across EventCatalog.
-
-## Writing event content
-
-You can write any Markdown inside an event. 
-
-Each event gets its own page, so use this space to fully explain how it works.
-
-You can also use [interactive components](/docs/development/components/using-components) to enrich your documentation.
-
-## Assign producers and consumers to your event
-
-To add producers or consumers to your event you can read the [guide on adding messages to services](/docs/development/guides/messages/common/map-to-producers-and-consumers).
-
-You can also assign your event to one or more [channels](/docs/development/guides/channels/adding-messages-to-services) (e.g Kafka, RabbitMQ, AWS SQS, AWS SNS, etc).
-
-<AddedIn version="3.18.0" />
-
-## Document an HTTP operation
-
-If your event is tied to an HTTP endpoint, you can use the `operation` field to document the method, path, and expected status codes.
-
-```md title="/events/OrderCreated/index.mdx (example)"
----
-id: OrderCreated
-# ...
-operation:
-  method: POST
-  path: /orders
-  statusCodes:
-    - "201"
-    - "400"
----
-```
-
-When defined, the visualiser shows an HTTP method badge, the API path, and colored status code pills on the event node. See the [event API reference](/docs/api/event-api#operation) for all available options.
-
-## Adding schemas to your event
-
-You can add any schema format to your event, you can read the [guide on adding schemas to messages](/docs/development/guides/messages/common/adding-schemas).
-
-## What should I document?
-
-There’s no strict structure, but consider including:
-
-- Purpose – What does this event do and why does it exist?
-- How to trigger it – APIs, SDKs, or UI actions
-- Schema – Payload structure and validation rules
-- Ownership – Who maintains this event?
-- Contributing – How others can propose changes
-
-## Custom icon
-
-<AddedIn version="3.28.1" />
-
-Set `styles.icon` in your frontmatter to display a custom icon on the event. The icon appears in the visualiser node, sidebar navigation, page header, and search results.
-
-```md title="/events/InventoryAdjusted/index.mdx (example)"
----
-id: InventoryAdjusted
-name: Inventory Adjusted
-version: 0.0.4
-styles:
-  icon: /icons/events/eventbridge.svg
----
-```
-
-The value can be a path to a file in your catalog's `public/` folder (e.g. `/icons/events/eventbridge.svg`) or an absolute URL (e.g. `https://cdn.simpleicons.org/amazoneventbridge`).
-
-## How do events appear in EventCatalog?
-
-![Example](../../img/events/example.png)
-
-

package/dist/docs/development/guides/messages/events/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "Events",
-  "position": 1,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/events",
-    "description": "A collection of guides to help you understand events and how they work with EventCatalog."
-  }
-}

package/dist/docs/development/guides/messages/queries/01-introduction.md

@@ -1,25 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- EventCatalog queries
-- Queries
-sidebar_label: What are queries?
-title: Understanding queries
-description: What are queries? Why are they useful for event-driven architectures?
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="2.10.0" />
-
-Queries are a type of message that represent requests for information.
-
-In EventCatalog [Services](/docs/development/guides/services/introduction) may query (send) or accept (receive) queries in your architecture.
-
-### Queries in EventCatalog
-
-- Queries in EventCatalog can be **accepted** by services or **invoked** by services.
-- Queries in EventCatalog are green
-- Queries live in the `/queries` folder.
-
-![Example](../../img/queries/query-example.png)

package/dist/docs/development/guides/messages/queries/02-adding-queries.md

@@ -1,130 +0,0 @@
----
-sidebar_position: 2
-keywords:
-- EventCatalog queries
-sidebar_label: Creating a query
-title: Creating queries
-description: Creating and managing queries within EventCatalog.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-Queries live in a `/queries` folder. This folder can be placed:
-
-- At the root of your catalog, or
-  - `/queries/{Query Name}/index.mdx` 
-- Inside a specific service folder.
-  - `/services/{Service Name}/queries/{Query Name}/index.mdx` 
-
-The contents are split into two sections, **frontmatter** and the **markdown content**.
-
-_Here is an example of what a query markdown file may look like._
-
-```md title="/queries/GetOrder/index.mdx (example)"
----
-# id of your query, used for slugs and references in EventCatalog.
-id: GetOrder
-
-# Display name of the query, rendered in EventCatalog
-name: Get Order
-
-# Version of the query
-version: 0.0.4
-
-# Short summary of your query
-summary: |
-    Query with the intent to get an order from the system
-
-# Optional owners, references teams or users
-owners:
-    - dboyne
-
-# Optional badges, rendered to UI by EventCatalog
-badges:
-    - content: New service
-      backgroundColor: blue
-      textColor: blue
----
-
-## Overview
-
-The `GetOrder` query represents intent to get an order from the system.
-
-<NodeGraph />
-
-```
-
-Once this file is added, the query will automatically appear across EventCatalog.
-
-## Writing query content
-
-You can write any Markdown inside a query. 
-
-Each query gets its own page, so use this space to fully explain how it works.
-
-You can also use [interactive components](/docs/development/components/using-components) to enrich your documentation.
-
-## Assign services to your queries
-
-To add services that invoke or accept your query you can read the [guide on adding messages to services](/docs/development/guides/messages/common/map-to-producers-and-consumers).
-
-You can also assign your query to one or more [channels](/docs/development/guides/channels/adding-messages-to-services) (e.g HTTP, GraphQL, etc).
-
-<AddedIn version="3.18.0" />
-
-## Document an HTTP operation
-
-If your query maps to an HTTP endpoint, use the `operation` field to document the method, path, and expected status codes.
-
-```md title="/queries/GetOrder/index.mdx (example)"
----
-id: GetOrder
-# ...
-operation:
-  method: GET
-  path: /orders/{id}
-  statusCodes:
-    - "200"
-    - "404"
----
-```
-
-When defined, the visualiser shows an HTTP method badge, the API path, and colored status code pills on the query node. See the [query API reference](/docs/api/query-api#operation) for all available options.
-
-## Adding schemas to your query
-
-You can add any schema format to your query, you can read the [guide on adding schemas to messages](/docs/development/guides/messages/common/adding-schemas).
-
-## What should I document?
-
-There’s no strict structure, but consider including:
-
-- Purpose – What does this query do and why does it exist?
-- How to trigger it – APIs, SDKs, or UI actions
-- Schema – Payload structure and validation rules
-- Ownership – Who maintains this query?
-- Contributing – How others can propose changes
-
-## Custom icon
-
-<AddedIn version="3.28.1" />
-
-Set `styles.icon` in your frontmatter to display a custom icon on the query. The icon appears in the visualiser node, sidebar navigation, page header, and search results.
-
-```md title="/queries/GetOrder/index.mdx (example)"
----
-id: GetOrder
-name: Get Order
-version: 0.0.4
-styles:
-  icon: /icons/query/search.svg
----
-```
-
-The value can be a path to a file in your catalog's `public/` folder (e.g. `/icons/query/search.svg`) or an absolute URL (e.g. `https://cdn.simpleicons.org/graphql`).
-
-## How do queries appear in EventCatalog?
-
-![Example](../../img/queries/example.png)
-
-

package/dist/docs/development/guides/owners/teams/01-introduction.md

@@ -1,21 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- EventCatalog services
-- Teams
-sidebar_label: What are teams?
-title: Understanding teams
-description: What are teams in EventCatalog?
----
-
-In EventCatalog you can assign teams or owners to domains, services or messages.
-
-Teams are collection of users in EventCatalog, and they can have their own documented page.
-
-### Teams in EventCatalog
-
-- Teams live in the `/teams` folder.
-- Teams reference users within it's frontmatter.
-- Teams can own domains, services or messages.
-
-![Example](../../img/teams/example.png)

package/dist/docs/development/guides/owners/teams/02-adding-teams.md

@@ -1,73 +0,0 @@
----
-sidebar_position: 2
-keywords:
-- EventCatalog teams
-sidebar_label: Creating a team
-title: Creating teams
-description: Creating and managing teams within EventCatalog.
----
-
-Adding a team to your Catalog is a great way to add a collection of owners for domain, service or message.
-
-### What do teams look like in EventCatalog?
-
-![Example](../../img/teams/example.png)
-
-## Adding a new team
-
-To add a new team create a new folder within the `/teams` folder with an `md` file.
-
-- `/teams/{team Name}.mdx` 
-  - (example `/teams/full-stack.mdx`)
-
-The `md` contents are split into two sections, **frontmatter** and the **markdown content**.
-
-_Here is an example of what a team markdown file may look like._
-
-```md title="/teams/full-stack.md (example)"
----
-# id of the team
-id: full-stack
-
-# display name for the team
-name: Full stackers
-
-# short summary of the team
-summmary: Full stack developers based in London, UK
-
-# members of the team (users live in /users directory)
-members:
-    - dboyne
-    - asmith
-    - msmith
-
-# optional email address to contact the team
-email: test@test.com
-
-# optional slack URL to send them a DM
-slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
----
-
-## Overview
-
-The Full Stack Team is responsible for developing and maintaining both the front-end and back-end components of our applications. This team ensures that the user interfaces are intuitive and responsive, and that the server-side logic and database interactions are efficient and secure. The Full Stack Team handles the entire lifecycle of web applications, from initial development to deployment and ongoing maintenance.
-
-```
-
-**That's it!**
-
-Once you add your new team to EventCatalog, it will now show in the docs.
-
-## Adding content
-
-With **teams** you can write any Markdown you want and it will render on your page. Every command gets its own page.
-
-Teams do not support custom components.
-
-### Tips for team content
-
-It's entirely up to you what you want to add to your teams markdown content but here are a few things you might want to consider.
-
-- Context of the team. Who are they? 
-- Contact info for the team?
-

package/dist/docs/development/guides/owners/teams/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "Teams",
-  "position": 11,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/teams",
-    "description": "A collection of guides to help you understand teams and how they work with EventCatalog."
-  }
-}

package/dist/docs/development/guides/owners/users/01-introduction.md

@@ -1,20 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- EventCatalog services
-- users
-sidebar_label: What are users?
-title: Understanding users
-description: What are users in EventCatalog?
----
-
-In EventCatalog you can assign users or owners to domains, services or messages.
-
-A user represents a person.
-
-### Users in EventCatalog
-
-- Users live in the `/users` folder.
-- Users can own domains, services or messages.
-
-![Example](../../img/users/example.png)

package/dist/docs/development/guides/owners/users/02-adding-users.md

@@ -1,69 +0,0 @@
----
-sidebar_position: 2
-keywords:
-- EventCatalog users
-sidebar_label: Creating a user
-title: Creating users
-description: Creating and managing users within EventCatalog.
----
-
-Adding a user to your Catalog is a great way to add an owner for a domain, service or message.
-
-### What do users look like in EventCatalog?
-
-![Example](../../img/users/example.png)
-
-## Adding a new user
-
-To add a new user, create a new file within the `/users` folder with an `md` file.
-
-- `/users/{user id}.mdx` 
-  - (example `/users/dboyne.mdx`)
-
-The `md` contents are split into two sections, **frontmatter** and the **markdown content**.
-
-_Here is an example of what a user markdown file may look like._
-
-```md title="/users/full-stack.md (example)"
----
-# id of the user
-id: dboyne
-
-# display name for the user
-name: David Boyne
-
-# optional URL path for a profile image
-avatarUrl: "https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png"
-
-# users role in the company
-role: Lead developer
-
-# optional user email address
-email: test@test.com
-
-# optional slack link to DM the user
-slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
----
-
-## Overview
-
-<!-- Contents about the user -->
-
-```
-
-**That's it!**
-
-Once you add your new user to EventCatalog, it will now show in the docs.
-
-## Adding content
-
-With **users** you can write any Markdown you want and it will render on your page. Every command gets its own page.
-
-Users do not support custom components.
-
-### Tips for user content
-
-It's entirely up to you what you want to add to your users markdown content but here are a few things you might want to consider.
-
-- Context of the user. Who are they? 
-- Contact info for the user?

package/dist/docs/development/guides/owners/users/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "Users",
-  "position": 12,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/users",
-    "description": "A collection of guides to help you understand users and how they work with EventCatalog."
-  }
-}

package/dist/docs/development/guides/schemas/01-introduction.md

@@ -1,64 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- EventCatalog Schemas
-sidebar_label: Getting started
-title: Getting started with schemas
-description: Getting started with schemas in EventCatalog
----
-
-EventCatalog supports **any schema or specification format**, including (but not limited to):
-
-- JSON / YAML
-- Avro
-- Protobuf
-- GraphQL
-- OpenAPI
-- AsyncAPI
-
-Schemas are **optional**, but they add valuable context to your messages and services by making data structures explicit and discoverable.
-
----
-
-## Why add schemas?
-
-By adding schemas to your messages and services, you unlock several benefits:
-
-- **Schema Explorer** – Quickly find and browse schemas [(see demo)](https://demo.eventcatalog.dev/schemas/explorer)
-- **Fields Explorer** – Browse every schema field catalog-wide, search across formats, and trace fields to the services that produce and consume them [(see guide)](/docs/development/guides/schemas/fields-explorer)
-- **API access** – Access schemas programmatically through the EventCatalog API [(see guide)](/docs/development/guides/schemas/schema-api)
-- **Ask questions** – Query and explore schemas using the [EventCatalog MCP](/docs/development/ask-your-architecture/mcp-server/introduction)
-- **Visualization** – Help developers understand data structures using [schema property search and visualization](/docs/development/components/components/schema-viewer)
-- **Field Usage** – Track which services depend on specific fields to understand the impact of schema changes [(see guide)](/docs/development/guides/schemas/field-usage)
-
----
-
-## Adding schemas to messages
-
-You can attach one or more schemas to any message type:
-
-- **Commands** -
-- **Queries**
-- **Events**
-
-Get started by following the relevant guide:
-
-- [Adding schemas to commands](/docs/development/guides/messages/common/adding-schemas)
-- [Adding schemas to queries](/docs/development/guides/messages/common/adding-schemas)
-- [Adding schemas to events](/docs/development/guides/messages/common/adding-schemas)
-
----
-
-## Adding specifications to services
-
-In addition to message-level schemas, services can render full API and messaging specifications, including:
-
-- **AsyncAPI**
-- **OpenAPI**
-- **GraphQL**
-
-Use the guides below to add specifications to your services:
-
-- [Adding AsyncAPI specifications to services](/docs/development/guides/services/adding-to-services/asyncapi)
-- [Adding OpenAPI specifications to services](/docs/development/guides/services/adding-to-services/openapi)
-- [Adding GraphQL schemas to services](/docs/development/guides/services/adding-to-services/graphql)

package/dist/docs/development/guides/services/01-introduction.md

@@ -1,33 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- EventCatalog services
-- Services
-sidebar_label: What are services?
-title: Understanding services
-description: What are services? Why are they useful for event-driven architectures?
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-In EventCatalog services represent systems that produce or receive messages (e.g [commands](/docs/development/guides/messages/commands/introduction), [events](/docs/development/guides/messages/events/introduction) or [queries](/docs/development/guides/messages/queries/introduction)).
-
-Services can have one or more specifications (OpenAPI, AsyncAPI, GraphQL) attached to them.
-
-Services can be part of a domain, subdomain or independent.
-
-:::tip
-
-If your building microservices, think of a service as a microservice, or if you are building monolith applications, think of a service as that application. The term service is loosely defined by EventCatalog as flexible to what you need.
-
-:::
-
-## Internal and external services
-
-Services in EventCatalog fall into two categories:
-
-- **Internal services** — systems your team owns and operates. Your own microservices, monoliths, or applications. This is the default when you create a service.
-- **External services** — third-party systems you integrate with but do not own, such as Stripe, Twilio, or Snowflake. You opt in to this by setting `externalSystem: true` on the service.
-
-Both are just services under the hood — they share the same schema, can send and receive messages, be versioned, have owners, and carry specifications. The distinction only affects how they are grouped in the sidebar and rendered in the visualiser, so that the systems you operate are easy to tell apart from the ones you depend on.
-