@eventcatalog/core 4.10.13 → 4.10.14

package/dist/docs/federation/reference/diagnostic-rules.md

@@ -0,0 +1,173 @@
+---
+sidebar_position: 3
+sidebar_label: Diagnostic rules
+title: Federation diagnostic rule reference
+description: Reference for every Federation rule, default level, trigger, output attributes, and resolution.
+---
+
+import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
+
+<EventCatalogEnterprise />
+
+Federation diagnostics use stable rule IDs. Configure each rule as `off`, `warn`, or `error` under `federation.rules`.
+
+| Rule | Default | Summary |
+| --- | --- | --- |
+| `federation/duplicate-source` | `error` | A resource has multiple owning catalogs |
+| `federation/type-collision` | `error` | One resource ID is documented with conflicting types |
+| `federation/pointer-type-mismatch` | `error` | A relationship expects the wrong target type |
+| `federation/facet-disagreement` | `error` | Catalogs provide contradictory facets for a resource |
+| `federation/asset-collision` | `warn` | Remote sources publish different files at one asset path |
+| `federation/missing-resource` | `warn` | A relationship points to an ID that is not present |
+| `federation/unresolved-version` | `warn` | The target ID exists, but its requested version does not |
+
+## `federation/duplicate-source`
+
+**Message:** `Resource has multiple owners`
+
+Triggered when the same resource ID and type are owned by more than one catalog. All versions of one resource ID must have the same owner.
+
+Attributes:
+
+| Attribute | Meaning |
+| --- | --- |
+| `resource` | Conflicting resource ID |
+| `catalogs` | Catalogs claiming ownership |
+| `resolution` | Suggested ownership action |
+
+Resolution: choose one owning catalog. Remove copied or placeholder resource definitions from consumers.
+
+## `federation/type-collision`
+
+**Message:** `Resource ID has conflicting types`
+
+Triggered when the same resource ID is documented as different EventCatalog resource types, such as an event in one catalog and a command in another.
+
+Attributes:
+
+| Attribute | Meaning |
+| --- | --- |
+| `resource` | Conflicting resource ID |
+| `<catalog ID>` | Type documented by that catalog |
+
+Resolution: correct the resource type or use distinct IDs for different resources.
+
+## `federation/pointer-type-mismatch`
+
+**Message:** `Reference type does not match resource`
+
+Triggered when a relationship pointer expects one target type but the resolved resource has another type.
+
+Attributes:
+
+| Attribute | Meaning |
+| --- | --- |
+| `resource` | Referenced resource ID |
+| `expected type` | Type required by the relationship |
+| `actual type` | Type documented by the owner |
+| `catalogs` | Catalogs involved in the mismatch |
+
+Resolution: correct the pointer or point it to the intended resource ID.
+
+## `federation/facet-disagreement`
+
+**Message:** `Catalogs disagree about this resource`
+
+Represents contradictory contributed facets for a resource, such as incompatible content supplied for the same facet by several catalogs.
+
+Attributes:
+
+| Attribute | Meaning |
+| --- | --- |
+| `resource` | Resource ID with contradictory facets |
+| `detail` | Available disagreement detail |
+| `catalogs` | Catalogs contributing the conflicting values |
+
+Resolution: decide which source is authoritative and align or remove the conflicting contribution.
+
+## `federation/asset-collision`
+
+**Message:** `Asset collision`
+
+Triggered when remote sources publish different content to the same `public/` or `components/` path.
+
+Attributes:
+
+| Attribute | Meaning |
+| --- | --- |
+| `asset` | Conflicting catalog-relative asset path |
+| `sources` | Sources publishing the path |
+| `winner` | Source selected by Federation |
+| `resolution` | Selection rule, currently `last configured source wins` |
+
+Resolution: namespace the paths, make the files identical, or deliberately order the sources and keep the warning visible.
+
+An existing public asset owned by the central catalog is preserved.
+
+## `federation/missing-resource`
+
+**Message:** `Referenced EventCatalog resource does not exist`
+
+Triggered when a relationship points to a resource ID that is not documented by any participating remote or central catalog.
+
+Attributes:
+
+| Attribute | Meaning |
+| --- | --- |
+| `source catalog` | Catalog containing the relationship pointer |
+| `referenced by` | Resource containing the pointer |
+| `missing resource` | Missing ID and requested version, when present |
+
+Resolution: add the owning catalog, document the resource in its owner, or correct the pointer ID.
+
+## `federation/unresolved-version`
+
+**Message:** `Referenced EventCatalog resource version does not exist`
+
+Triggered when the resource ID exists, but no available version satisfies the pointer.
+
+Attributes:
+
+| Attribute | Meaning |
+| --- | --- |
+| `source catalog` | Catalog containing the relationship pointer |
+| `referenced by` | Versioned resource containing the pointer |
+| `resource` | Target resource ID |
+| `requested version` | Exact version, range, or authored pointer value |
+| `available versions` | Versions published by the owner |
+
+Resolution: change the pointer to an available version or publish a matching version in the owning catalog.
+
+## Configure levels
+
+```js title="eventcatalog.config.js"
+export default {
+  federation: {
+    rules: {
+      'federation/missing-resource': 'error',
+      'federation/unresolved-version': 'error',
+      'federation/asset-collision': 'off',
+    },
+    sources: [/* ... */],
+  },
+};
+```
+
+Changing structural rules from `error` can allow ambiguous ownership or types into the generated view. See [Configure validation rules](/docs/federation/how-to/configure-validation-rules).
+
+## Operational errors without rule IDs
+
+Some failures stop Federation directly and do not have configurable `federation/*` rule IDs. These include:
+
+- Missing or invalid license access
+- Duplicate configured source IDs
+- Unsupported source locators
+- GitHub authentication or network failures
+- Missing filesystem source directories
+- Unsafe source, catalog, or artifact paths
+- Invalid published indexes
+- Content hash mismatches
+- Unreadable lockfiles
+- Filesystem write or rollback failures
+
+See [Troubleshooting Federation](/docs/federation/reference/troubleshooting).

package/dist/docs/federation/reference/generated-output.md

@@ -0,0 +1,118 @@
+---
+sidebar_position: 5
+sidebar_label: Generated output
+title: Federation generated output reference
+description: Reference for federated resources, shared components, public assets, the lockfile, and content cache.
+---
+
+import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
+
+<EventCatalogEnterprise />
+
+A successful Federation run can create or update four locations in the central catalog:
+
+```text
+central-catalog/
+├── federated/
+├── public/
+├── .eventcatalog-cache/
+└── eventcatalog.lock
+```
+
+## `federated/`
+
+Federated resource files are grouped by stable source identity:
+
+```text
+federated/
+├── acme-payments--0cfe83f789ab/
+│   ├── domains/
+│   ├── services/
+│   ├── events/
+│   ├── teams/
+│   └── users/
+├── acme-orders--7575b99c8b32/
+│   ├── domains/
+│   ├── services/
+│   └── events/
+└── components/
+```
+
+The directory name contains:
+
+- A filesystem-safe form of the source `id`
+- A short hash of the complete source `id`
+
+The hash prevents different IDs that produce the same safe text from sharing a directory.
+
+Resource-relative files remain with their resource, including:
+
+- Schemas
+- OpenAPI, AsyncAPI, and GraphQL specifications
+- Sidecar documentation and files
+- Diagrams and other resource-local content
+
+Do not edit `federated/`. It is replaced by the next successful run.
+
+## `federated/components/`
+
+Top-level custom components from remote catalogs are materialized into the shared `federated/components/` directory.
+
+When EventCatalog prepares the application, federated components form the base layer and the central catalog's local `components/` directory is applied afterward. A local component at the same relative path overrides the federated component.
+
+Top-level reusable `snippets/` are not federated in the current release.
+
+## `public/`
+
+Remote `public/` assets are first hydrated, then composed into the central catalog's `public/` directory.
+
+Selection rules:
+
+1. When several remote sources publish different content at one path, the last configured source wins and `federation/asset-collision` is reported.
+2. When the central catalog already owns the path, the central file is preserved.
+3. When a previously managed remote file was changed manually, Federation preserves it instead of treating it as managed output.
+4. When a managed remote file disappears from all sources, a later successful run removes it.
+
+Managed public-file hashes and source IDs are stored in `eventcatalog.lock`.
+
+## `eventcatalog.lock`
+
+The lockfile records:
+
+- `lockVersion`
+- Source IDs
+- Source commits or local content revisions
+- Source index digests
+- Resolution times
+- Managed public files
+
+It is written after a successful output update. It records what the run used but does not control the next run.
+
+See [Federation lockfile and content cache](/docs/federation/explanation/lockfile-and-cache).
+
+## `.eventcatalog-cache/`
+
+Federation content is cached under:
+
+```text
+.eventcatalog-cache/federation/content/
+```
+
+Entries use SHA-256 content keys and are verified before reuse. The cache is disposable and should normally be ignored by Git.
+
+The current release does not automatically remove content that is no longer referenced, so the cache can grow over time.
+
+## Cleanup when sources change
+
+On a successful run:
+
+- Resources no longer present in an index disappear from `federated/`
+- Removed sources disappear from `federated/`
+- Stale managed public files are removed
+- New source content replaces the previous generated content
+
+When `federation.sources` becomes empty, the command removes previous Federation output, managed public files, and the lockfile.
+
+## Failed output updates
+
+Federation stages new output and snapshots affected public files. If a normal output update fails, it attempts to restore the previous generated resources and public assets. The previous lockfile remains associated with the previous successful view.

package/dist/docs/federation/reference/supported-content.md

@@ -0,0 +1,86 @@
+---
+sidebar_position: 4
+sidebar_label: Supported content
+title: Federation supported content
+description: Reference for resources, files, assets, and catalog-level content included by Federation.
+---
+
+import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
+
+<EventCatalogEnterprise />
+
+Federation indexes and materializes normal EventCatalog resource content from every configured source.
+
+## Supported resources
+
+The current release supports:
+
+- Architecture decision records (ADRs)
+- Agents
+- Channels
+- Commands
+- Data products
+- Data stores (`container` resources)
+- Diagrams
+- Domains and subdomains
+- Entities
+- Events
+- Flows
+- Queries
+- Services
+- Systems
+- Teams
+- Users
+
+Resource versions remain with their owner and are included in cross-catalog version resolution.
+
+## Resource files
+
+Federation includes files associated with supported resources:
+
+- Markdown and MDX resource documentation
+- Schemas attached to events, commands, and queries
+- OpenAPI, AsyncAPI, and GraphQL specifications
+- Resource-local sidecar documentation
+- Resource-local images, diagrams, examples, and other files
+- Changelog and version documentation stored with the resource
+
+Paths and content hashes from the source index are used to fetch and verify these files.
+
+## Teams and users
+
+Top-level teams and users are included. Give shared people and teams one owning catalog to avoid organization-wide duplicate ownership.
+
+## Public assets
+
+Files under a source catalog's top-level `public/` directory are included and composed into the central `public/` directory.
+
+Remote collisions use last-configured-source-wins and report `federation/asset-collision`. Existing central public files are preserved.
+
+See [Share public assets and custom components](/docs/federation/how-to/share-assets-and-components).
+
+## Custom components
+
+Files under a source catalog's top-level `components/` directory are included in the federated component layer.
+
+Central components override federated components at the same relative path. Any npm packages imported by a federated component must be installed in the central catalog.
+
+## Content not included
+
+The current release does not federate:
+
+- Top-level reusable `snippets/`
+- Custom pages and API routes
+- `eventcatalog.config.js` settings from source catalogs
+- Source catalog themes, navigation, or global styles
+- Source `package.json` dependencies
+- `node_modules/`, build output, or cache directories
+- Content already under a source catalog's generated `federated/` directory
+
+The central catalog owns its application configuration, navigation, theme, custom pages, global dependencies, and build process.
+
+## Why generated Federation content is excluded
+
+When a source catalog is itself a central view, its generated `federated/` directory is excluded from indexing. This prevents generated paths from being nested repeatedly and avoids treating copied output as newly authored ownership.
+
+Only content owned by the selected source catalog is indexed for the next composition level.

package/dist/docs/federation/reference/troubleshooting.md

@@ -0,0 +1,208 @@
+---
+sidebar_position: 6
+sidebar_label: Troubleshooting
+title: Troubleshooting EventCatalog Federation
+description: Fix common source, ownership, relationship, asset, cache, and generated-output problems.
+---
+
+import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
+
+<EventCatalogEnterprise />
+
+Run with verbose diagnostics before investigating a warning:
+
+```bash
+npx eventcatalog federate --verbose
+```
+
+Errors always include details. Verbose mode adds the attributes for warnings.
+
+## Federation is not enabled
+
+If the command reports that Federation is an Enterprise feature:
+
+- Confirm the Enterprise `license.jwt` file is in the central catalog root
+- If the file is stored elsewhere, confirm `EC_LICENSE` points to it
+- Confirm the license has not expired
+- Email [hello@eventcatalog.dev](mailto:hello@eventcatalog.dev?subject=EventCatalog%20Federation%20Trial) to request or replace an offline trial key
+- Review [offline license validation](/docs/development/license-keys/license-validation#offline-validation)
+
+## No sources are configured
+
+Add at least one entry to `federation.sources`:
+
+```js title="eventcatalog.config.js"
+export default {
+  federation: {
+    sources: [
+      {
+        id: 'acme/payments',
+        source: 'github:acme/payments-catalog',
+      },
+    ],
+  },
+};
+```
+
+If previous Federation output exists, an empty source list intentionally removes it and its managed public files.
+
+## A source ID is configured more than once
+
+Every source entry needs a unique stable `id`. Change or remove the duplicate configuration entry.
+
+This configuration error is different from `federation/duplicate-source`, which means several catalogs own the same resource ID.
+
+## GitHub source errors
+
+### Unsupported GitHub locator
+
+Use:
+
+```text
+github:owner/repository
+```
+
+Do not use a full `https://github.com/...` URL.
+
+### Repository cannot be fetched
+
+Check:
+
+- The owner and repository name
+- The configured `ref`
+- Network access to GitHub
+- Git is installed when the source does not publish an index
+- `EVENTCATALOG_GITHUB_TOKEN` or `GITHUB_TOKEN` has repository contents read access
+
+### Published index source does not match
+
+The `source` value inside `catalog.index.json` must equal the configured source `id`.
+
+Either correct the published index or configure the matching stable ID.
+
+### Catalog path escapes the source
+
+`path` must be a safe relative path inside the selected repository. Remove absolute paths, `..` segments, or backslashes.
+
+## Filesystem source errors
+
+### Source does not exist
+
+`file:` paths are resolved from the central catalog directory, not from the terminal's parent directory.
+
+For sibling catalogs:
+
+```js
+{
+  id: 'acme/payments',
+  source: 'file:../payments-catalog',
+}
+```
+
+Confirm that the resolved directory exists and contains an EventCatalog project.
+
+### Filesystem source does not support `ref`
+
+Remove `ref` from the source. Filesystem sources always read the current local files.
+
+### Source or artifact escapes its allowed directory
+
+Federation rejects paths and symbolic links that resolve outside the selected filesystem source. Keep the catalog and its referenced files within the source root.
+
+## Ownership and type errors
+
+### `federation/duplicate-source`
+
+Several catalogs own the same resource ID. Choose one owner and remove copied or placeholder definitions from the other catalogs.
+
+### `federation/type-collision`
+
+The same ID is documented with different resource types. Correct the type or assign distinct IDs.
+
+### `federation/pointer-type-mismatch`
+
+A relationship expects one type but resolves to another. Correct the relationship pointer or its target ID.
+
+Use the [diagnostic rule reference](/docs/federation/reference/diagnostic-rules) to interpret the printed attributes.
+
+## Relationship warnings
+
+### Referenced resource does not exist
+
+For `federation/missing-resource`:
+
+- Check the referenced ID for a typo
+- Add the owning catalog to `federation.sources`
+- Confirm the owner documents the resource
+- Keep the warning if the external reference is deliberate
+
+### Referenced resource version does not exist
+
+For `federation/unresolved-version`:
+
+- Compare `requested version` with `available versions`
+- Correct the exact version or semantic range
+- Publish the required version in the owning catalog
+
+## Public assets or components are not correct
+
+For `federation/asset-collision`, run with `--verbose` to see the source order and winner.
+
+Then:
+
+- Namespace remote asset paths by team or domain
+- Make intentionally shared files identical
+- Reorder sources only when last-source-wins is deliberate
+- Check whether the central catalog owns the public path
+- Check whether a local component overrides the federated component
+
+If a custom component imports an npm package, install that dependency in the central catalog.
+
+Top-level source `snippets/` are not currently federated. Move required content into the page, provide it centrally, or avoid the remote snippet import.
+
+## Content hash mismatch
+
+Federation fetched bytes that did not match the hash recorded by the source index.
+
+Rerun the command first. If the error remains:
+
+- Regenerate or remove a stale published `catalog.index.json`
+- Confirm the source content still exists at the indexed commit
+- Check whether content was changed without updating the index
+
+Federation does not install content that fails integrity validation.
+
+## The lockfile cannot be read
+
+Check that `eventcatalog.lock` contains valid JSON and was not partially edited.
+
+If you do not need its audit or managed public-file state, move the malformed file aside and rerun Federation. Review public assets carefully because the new run will not know which existing files were managed by the unreadable lockfile.
+
+## Federated content looks stale
+
+Run Federation again before starting or building EventCatalog:
+
+```bash
+npx eventcatalog federate
+npm run dev
+```
+
+For a local source, remember there is no watcher integration yet.
+
+Use `--no-cache` when investigating cache behavior:
+
+```bash
+npx eventcatalog federate --no-cache
+```
+
+The cache is content-addressed and verified, so changing source content normally produces a different cache key without this option.
+
+## A failed run left the previous content visible
+
+This is expected. Federation preserves or restores the previous successful output when validation or a normal output update fails.
+
+Fix the reported problem and rerun the command. New output and a new lockfile are installed only after Federation succeeds.
+
+## Get help
+
+Share the command output, relevant source configuration with secrets removed, and the expected ownership model in the [EventCatalog Discord](https://eventcatalog.dev/discord) or [open an issue](https://github.com/event-catalog/eventcatalog/issues).

package/dist/docs/plugins/01-intro.md

@@ -29,11 +29,11 @@ These plugins are maintained by the EventCatalog team and are updated regularly,
 - [OpenAPI Plugin](/docs/plugins/openapi/intro) - Generate documentation from your OpenAPI files
 - [GraphQL Plugin](/docs/plugins/graphql/intro) - Generate documentation from your GraphQL files
 - [Github Plugin](/docs/plugins/github/intro) - Sync your schemas from GitHub to EventCatalog
-- [Backstage Plugin](/docs/plugins/backstage/intro) - Use EventCatalog features within Backstage
+- [Backstage Plugin](/docs/plugins/backstage/overview) - Embed EventCatalog documentation and visualizations in Backstage
 - [Amazon EventBridge](/docs/plugins/eventbridge/intro) - Sync Amazon EventBridge schemas to EventCatalog
 - [Amazon API Gateway](/docs/plugins/amazon-apigateway/intro) - Generate documentation from your Amazon API Gateway
 - [Confluent Schema Registry](/docs/plugins/confluent-schema-registry/intro) - Sync your schemas from Confluent Schema Registry to EventCatalog
-- [EventCatalog Federation](/docs/plugins/eventcatalog-federation/introduction) - Merge multiple EventCatalog instances into a single catalog.
+- [EventCatalog Federation](/docs/federation/overview) - Merge multiple EventCatalog instances into a single catalog.
 
 #### Community plugins
 
@@ -46,4 +46,4 @@ EventCatalog can integrate with anything that has an API.
 
 We offer support and services to build custom integrations for your EventCatalog.
 
-If you would like to explore custom integrations and have us build your integrate for you please contact us at `hello@eventcatalog.dev`.
+If you would like to explore custom integrations and have us build your integrate for you please contact us at `hello@eventcatalog.dev`.

package/dist/docs/plugins/03-all-plugins.md

@@ -19,8 +19,8 @@ Automate and sync your data from a wide range of systems to EventCatalog.
 | [Apicurio Registry](/docs/plugins/apicurio/intro) | Import schemas and specifications from Apicurio Registry into EventCatalog |
 | [Azure Schema Registry](/docs/plugins/azure-schema-registry/intro) | Import schemas from Azure Schema Registry into EventCatalog |
 | [Github Plugin](/docs/plugins/github/intro) | Sync your schemas from GitHub to EventCatalog |
-| [Backstage Plugin](/docs/plugins/backstage/intro) | Use EventCatalog features within Backstage |
+| [Backstage Plugin](/docs/plugins/backstage/overview) | Embed EventCatalog documentation and visualizations in Backstage |
 | [Amazon EventBridge](/docs/plugins/eventbridge/intro) | Sync Amazon EventBridge schemas to EventCatalog |
 | [Amazon API Gateway](/docs/plugins/amazon-apigateway/intro) | Generate documentation from your Amazon API Gateway |
 | [Confluent Schema Registry](/docs/plugins/confluent-schema-registry/intro) | Sync your schemas from Confluent Schema Registry to EventCatalog |
-| [EventCatalog Federation](/docs/plugins/eventcatalog-federation/introduction) | Merge multiple EventCatalog instances into a single catalog. |
+| [EventCatalog Federation](/docs/federation/overview) | Merge multiple EventCatalog instances into a single catalog. |

package/dist/docs/plugins/asyncapi/00-intro.md

@@ -38,10 +38,10 @@ The EventCatalog AsyncAPI plugin can provide you with many features:
 - ⭐️ Generate domains, services and messages into your catalog from your AsyncAPI specification files
 - ⭐️ [Automate your EventCatalog and fetch AsyncAPI files by URL](/docs/plugins/asyncapi/features#fetch-asyncapi-files-by-url)
 - ⭐️ [Map commands, queries and events from your OpenAPI file using custom extensions](/docs/plugins/asyncapi/features#mapping-messages-events-commands-or-queries)
-- ⭐️ [Automatically version your changes in EventCatalog in sync with your AsyncAPI versions](#automatic-versioning)
-- ⭐️ [Allow you to write and persist custom markdown between changes](#persist-markdown)
-- ⭐️ [Display your message schemas in the catalog](#downloading-schemas)
-- ⭐️ [Fetch AsyncAPI files from any URL](#fetch-asyncapi-files-by-url)
+- ⭐️ [Automatically version your changes in EventCatalog in sync with your AsyncAPI versions](/docs/plugins/asyncapi/features#automatic-versioning)
+- ⭐️ [Allow you to write and persist custom markdown between changes](/docs/plugins/asyncapi/features#persist-markdown)
+- ⭐️ [Display your message schemas in the catalog](/docs/plugins/asyncapi/features#downloading-schemas)
+- ⭐️ [Fetch AsyncAPI files from any URL](/docs/plugins/asyncapi/features#fetch-asyncapi-files-by-url)
 - ⭐️ Ability to download your message schemas and AsyncAPI files (also versioned)
 - ⭐️ Ability to draft services and endpoints in EventCatalog from your AsyncAPI files
 - ⭐️ and more....

package/dist/docs/plugins/asyncapi/02-plugin-configuration.md

@@ -53,13 +53,13 @@ Each service in the `services` array requires the following properties:
 | `domain.generateMarkdown` | function | - | Function to override the default markdown generation for the domain. See [Markdown templates](#markdown-templates) for more information. |
 | `messages.generateMarkdown` | function | - | Function to override the default markdown generation for the message. See [Markdown templates](#markdown-templates) for more information. |
 | `messages.id` | object | - | Configure the id of the messages that are generated (for example, set a prefix to all messages that are generated) _(Added in v4.5.1)_ [(Read more)](/docs/plugins/asyncapi/features#adding-prefix-to-all-messages) |
-| `messages.id.prefix` | string | - | A prefix value for the message that is generated. For example a message with the id `orderPlaced` with a configured prefix of `hello-` will be `hello-orderPlaced`. _(Added in v4.5.1)_ [(Read more)](/docs/plugins/asyncapi/plugin-configuration#adding-prefix-to-all-messages) |
-| `messages.id.separator` | string | `-` | The separator to use between the prefix and the message id. _(Added in v4.5.1)_ [(Read more)](/docs/plugins/asyncapi/plugin-configuration#adding-prefix-to-all-messages) |
-| `messages.id.prefixWithServiceId` | boolean | | If true, the service id will be added to the id of the messages that are generated. For example a message with the id `orderPlaced` and the service id `orders-service` will be `orders-service-orderPlaced`. _(Added in v4.5.1)_ [(Read more)](/docs/plugins/asyncapi/plugin-configuration#adding-prefix-to-all-messages) |
+| `messages.id.prefix` | string | - | A prefix value for the message that is generated. For example a message with the id `orderPlaced` with a configured prefix of `hello-` will be `hello-orderPlaced`. _(Added in v4.5.1)_ [(Read more)](/docs/plugins/asyncapi/features#adding-prefix-to-all-messages) |
+| `messages.id.separator` | string | `-` | The separator to use between the prefix and the message id. _(Added in v4.5.1)_ [(Read more)](/docs/plugins/asyncapi/features#adding-prefix-to-all-messages) |
+| `messages.id.prefixWithServiceId` | boolean | | If true, the service id will be added to the id of the messages that are generated. For example a message with the id `orderPlaced` and the service id `orders-service` will be `orders-service-orderPlaced`. _(Added in v4.5.1)_ [(Read more)](/docs/plugins/asyncapi/features#adding-prefix-to-all-messages) |
 | `messages.id.lowerCase` | boolean | false | If true, the message id will be stored in lowercase and the folder will also be lowercased. (e.g `/events/orderplaced/index.mdx) _(Added in v5.0.0)_ |
 | `preserveExistingMessages` | boolean | `true` | Preserve existing message Markdown when the generator runs again. Set to `false` to replace existing Markdown with content generated from the AsyncAPI specification and `messages.generateMarkdown` template. Referenced and external messages are never overwritten. |
 | `saveParsedSpecFile` | boolean | `false` | Parse and save expanded AsyncAPI spec (helpful for files with $refs) |
-| `parseSchemas` | boolean | `true` | If you choose to parse your specification file using the [saveParsedSpecFile](#saveparsedspecfile-saveparsedspecfile) field, you can also opt in or out to have your ,message schemas parsed using the `parseSchemas` field. By default message schemas are parsed, if you want to keep your original schemas you have to set `parseSchemas` to false. | | `parseChannels` | boolean | `false` | Parse and save channels. If you set to true the AsyncAPI channels will also be documented in the catalog. |
+| `parseSchemas` | boolean | `true` | If you choose to parse your specification file using the [saveParsedSpecFile](#optional-configuration-options) field, you can also opt in or out to have your ,message schemas parsed using the `parseSchemas` field. By default message schemas are parsed, if you want to keep your original schemas you have to set `parseSchemas` to false. | | `parseChannels` | boolean | `false` | Parse and save channels. If you set to true the AsyncAPI channels will also be documented in the catalog. |
 | `parseChannels` | boolean | `false` | When setting the value to true the generator will parse and write channels to your EventCatalog. |
 | `writeFilesToRoot` | boolean | `false` | Write AsyncAPI messages to root instead of service folder. By default all domains, services and messages will be grouped in the folder directory structure. |
 | `saveParsedSpecFile` | boolean | `true` | By default your AsyncAPI file will render in your catalog as you define it. If you are using $refs, or having issues seeing your AsyncAPI file in your catalog, then you can set this value to true. `saveParsedSpecFile`  is false by default. |