@eventcatalog/core 5.0.0-beta.9 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +13 -12
- package/README.md +5 -5
- package/dist/analytics/analytics.cjs +1 -1
- package/dist/analytics/analytics.js +2 -2
- package/dist/analytics/log-build.cjs +91 -44
- package/dist/analytics/log-build.d.cts +2 -2
- package/dist/analytics/log-build.d.ts +2 -2
- package/dist/analytics/log-build.js +6 -5
- package/dist/analytics/studio-usage.cjs +90 -0
- package/dist/analytics/studio-usage.d.cts +5 -0
- package/dist/analytics/studio-usage.d.ts +5 -0
- package/dist/analytics/studio-usage.js +10 -0
- package/dist/catalog-runtime.cjs +1 -1
- package/dist/{chunk-RFIXKATC.js → chunk-4G7FSRPN.js} +35 -42
- package/dist/{chunk-AWOO63ME.js → chunk-AD7CL772.js} +11 -4
- package/dist/chunk-CA6WCQ2T.js +54 -0
- package/dist/{chunk-GAHKCOQM.js → chunk-JZN4RSMF.js} +1 -1
- package/dist/{chunk-JQMYHZWI.js → chunk-NEAVAFSJ.js} +16 -8
- package/dist/{chunk-4CFZUHGG.js → chunk-NIVST4WY.js} +1 -1
- package/dist/{chunk-ENAG6UH7.js → chunk-NKNOXQ62.js} +1 -6
- package/dist/{chunk-ZEY2XUJN.js → chunk-OX6TSVHY.js} +6 -6
- package/dist/{chunk-36RYTYT5.js → chunk-PD7KTSYN.js} +1 -1
- package/dist/{chunk-EUNQJO3J.js → chunk-RE7UTPWH.js} +1 -1
- package/dist/chunk-S5GWAUG5.js +29 -0
- package/dist/{chunk-TZVDMWQX.js → chunk-YQGRMDRB.js} +4 -2
- package/dist/constants.cjs +1 -1
- package/dist/constants.js +1 -1
- package/dist/docs/api/02-config.md +57 -7
- package/dist/docs/development/00-why-eventcatalog.md +11 -11
- package/dist/docs/development/01-fundamentals.md +20 -13
- package/dist/docs/development/01-getting-started/configuration-overview.md +2 -2
- package/dist/docs/development/01-getting-started/installation.md +9 -1
- package/dist/docs/development/_getting-started.mdx +1 -1
- package/dist/docs/development/ask-your-architecture/01-intro.md +5 -5
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/01-what-is-eventcatalog-assistant.md +0 -4
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/02-configuration.md +15 -3
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/03-bring-your-own-tools.md +0 -3
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/_category_.json +1 -1
- package/dist/docs/development/ask-your-architecture/02-llms.txt.md +1 -1
- package/dist/docs/development/ask-your-architecture/{05-skills/01-introduction.md → 03-install-skills.md} +57 -7
- package/dist/docs/development/ask-your-architecture/03-mcp-server/_category_.json +1 -1
- package/dist/docs/development/ask-your-architecture/03-mcp-server/getting-started.md +86 -33
- package/dist/docs/development/ask-your-architecture/03-mcp-server/introduction.md +14 -4
- package/dist/docs/development/ask-your-architecture/03-schemas.txt.md +1 -1
- package/dist/docs/development/ask-your-architecture/04-agents/_category_.json +1 -1
- package/dist/docs/development/authentication/01-introduction.md +2 -23
- package/dist/docs/development/authentication/02-enabling-authentication.md +0 -20
- package/dist/docs/development/authentication/07-rbac-middleware.md +0 -2
- package/dist/docs/development/authentication/providers/03-setting-up-github.md +0 -2
- package/dist/docs/development/authentication/providers/03a-setting-up-google.md +0 -2
- package/dist/docs/development/authentication/providers/04-setting-up-azure-ad.md +0 -2
- package/dist/docs/development/authentication/providers/05-setting-up-okta.md +0 -3
- package/dist/docs/development/authentication/providers/06-setting-up-auth0.md +0 -2
- package/dist/docs/development/bring-your-own-documentation/01-introduction.md +0 -4
- package/dist/docs/development/bring-your-own-documentation/custom-pages/01-introduction.md +0 -3
- package/dist/docs/development/bring-your-own-documentation/custom-pages/02-adding-custom-docs.md +0 -17
- package/dist/docs/development/bring-your-own-documentation/custom-pages/03-components.md +0 -4
- package/dist/docs/development/bring-your-own-documentation/custom-pages/04-owners.md +0 -2
- package/dist/docs/development/bring-your-own-documentation/resource-docs/01-introduction.md +1 -3
- package/dist/docs/development/bring-your-own-documentation/resource-docs/02-adding-resource-docs.md +1 -4
- package/dist/docs/development/bring-your-own-documentation/resource-docs/03-categories.md +0 -2
- package/dist/docs/development/bring-your-own-documentation/resource-docs/04-versioning.md +1 -3
- package/dist/docs/development/components/components/11-flow.md +17 -0
- package/dist/docs/development/components/components/15-nodegraph.md +43 -10
- package/dist/docs/development/components/components/18-remote-schema.md +1 -4
- package/dist/docs/development/components/custom-components/07-reference.md +14 -0
- package/dist/docs/development/customization/02-themes.md +0 -5
- package/dist/docs/development/customization/03-search.md +1 -1
- package/dist/docs/development/customization/05-custom-pages-and-api-routes/01-introduction.md +0 -2
- package/dist/docs/development/customization/05-custom-pages-and-api-routes/04-reference.md +7 -1
- package/dist/docs/development/customization/05-resource-sidebar.md +1 -1
- package/dist/docs/development/customization/09-embed-eventcatalog.md +20 -25
- package/dist/docs/development/deployment/hosting-options.md +7 -2
- package/dist/docs/development/developer-tools/eventcatalog-linter/how-to/05-fix-common-problems.md +16 -0
- package/dist/docs/development/developer-tools/eventcatalog-linter/reference/03-rules.md +31 -1
- package/dist/docs/development/developer-tools/eventcatalog-linter/reference/05-supported-resources.md +1 -1
- package/dist/docs/development/governance/architecture-change-detection/01-introduction.md +0 -10
- package/dist/docs/development/governance/architecture-change-detection/06-pipeline-gates.md +0 -4
- package/dist/docs/development/guides/97-architecture-graph.md +1 -1
- package/dist/docs/development/guides/99-adding-analytics.md +0 -7
- package/dist/docs/development/guides/domains/03-model-subdomains.md +2 -2
- package/dist/docs/development/guides/domains/04-add-resources-to-domains/01-add-systems-to-domains.md +3 -1
- package/dist/docs/development/guides/domains/04-add-resources-to-domains/02-add-services-to-domains.md +5 -1
- package/dist/docs/development/guides/domains/04-add-resources-to-domains/03-add-messages-to-domains.md +2 -2
- package/dist/docs/development/guides/domains/04-add-resources-to-domains/05-add-entities-to-domains.md +1 -1
- package/dist/docs/development/guides/domains/04-add-resources-to-domains/06-domain-resources-page.md +40 -0
- package/dist/docs/development/guides/domains/06-visualize-domains/01-domain-diagram.md +89 -0
- package/dist/docs/development/guides/domains/06-visualize-domains/_category_.json +1 -2
- package/dist/docs/development/guides/domains/09-reference.md +4 -4
- package/dist/docs/development/guides/owners/automated-teams-and-users/create-your-own-connector.md +0 -2
- package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-github.md +0 -3
- package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-microsoft-entra.md +0 -2
- package/dist/docs/development/guides/resources/adrs/03-linking-resources.md +8 -0
- package/dist/docs/development/guides/resources/adrs/06-reference.md +4 -4
- package/dist/docs/development/guides/resources/agents/11-reference.md +1 -1
- package/dist/docs/development/guides/resources/data/04-reference.md +1 -1
- package/dist/docs/development/guides/resources/data-products/07-reference.md +1 -1
- package/dist/docs/development/guides/resources/entities/05-entity-maps.md +1 -1
- package/dist/docs/development/guides/resources/entities/06-reference.md +2 -2
- package/dist/docs/development/guides/resources/flows/01-introduction.md +11 -1
- package/dist/docs/development/guides/resources/flows/03-model-flow-steps.md +65 -6
- package/dist/docs/development/guides/resources/flows/05-explore-flows.md +112 -0
- package/dist/docs/development/guides/resources/flows/06-reference.md +25 -4
- package/dist/docs/development/guides/resources/messages/01-what-are-messages.md +19 -0
- package/dist/docs/development/guides/resources/messages/04-message-channels/01-introduction.md +16 -0
- package/dist/docs/development/guides/resources/messages/04-message-channels/05-reference.md +2 -1
- package/dist/docs/development/guides/resources/messages/10-reference.md +6 -3
- package/dist/docs/development/guides/resources/schemas/04-explore-schemas/01-schema-explorer.md +2 -2
- package/dist/docs/development/guides/resources/schemas/04-explore-schemas/02-fields-explorer.md +0 -9
- package/dist/docs/development/guides/resources/schemas/05-schema-api.md +0 -3
- package/dist/docs/development/guides/resources/schemas/06-schema-mcp.md +11 -3
- package/dist/docs/development/guides/resources/services/04-add-resources-to-services/03-add-entities-to-services.md +1 -1
- package/dist/docs/development/guides/resources/services/05-resources-page.md +50 -0
- package/dist/docs/development/guides/resources/services/08-reference.md +2 -1
- package/dist/docs/development/guides/systems/01-introduction.md +1 -1
- package/dist/docs/development/guides/systems/02-create-system.md +2 -2
- package/dist/docs/development/guides/systems/03-add-resources-to-systems.md +35 -9
- package/dist/docs/development/guides/systems/04-model-relationships-and-actors.md +5 -3
- package/dist/docs/development/guides/systems/05-system-context-maps.md +39 -22
- package/dist/docs/development/guides/systems/06-reference.md +4 -4
- package/dist/docs/development/license/01-license-file.md +151 -0
- package/dist/docs/development/license/_category_.json +12 -0
- package/dist/docs/development/license-keys/_category_.json +3 -3
- package/dist/docs/development/license-keys/integrations.md +7 -37
- package/dist/docs/development/license-keys/license-validation.md +4 -0
- package/dist/docs/development/license-keys/overview.md +5 -1
- package/dist/docs/development/license-keys/plans.md +4 -2
- package/dist/docs/development/studio/01-introduction.md +60 -0
- package/dist/docs/development/studio/02-create-a-canvas.md +103 -0
- package/dist/docs/development/studio/03-set-up-persistent-storage.md +59 -0
- package/dist/docs/development/studio/04-collaborate-on-a-canvas.md +78 -0
- package/dist/docs/development/studio/05-connect-your-agent.md +102 -0
- package/dist/docs/development/studio/06-run-studio-in-production.md +54 -0
- package/dist/docs/development/studio/07-reference.md +294 -0
- package/dist/docs/development/studio/_category_.json +12 -0
- package/dist/docs/development/upgrading/v5.md +345 -0
- package/dist/docs/federation/00-overview.md +2 -8
- package/dist/docs/federation/01-first-federation.md +6 -18
- package/dist/docs/federation/explanation/how-it-works.md +0 -4
- package/dist/docs/federation/explanation/lockfile-and-cache.md +0 -4
- package/dist/docs/federation/explanation/mvp-status-and-feedback.md +0 -4
- package/dist/docs/federation/explanation/ownership-and-references.md +0 -4
- package/dist/docs/federation/how-to/configure-github-sources.md +6 -5
- package/dist/docs/federation/how-to/configure-validation-rules.md +0 -4
- package/dist/docs/federation/how-to/run-in-ci.md +2 -9
- package/dist/docs/federation/how-to/share-assets-and-components.md +0 -4
- package/dist/docs/federation/how-to/use-local-sources.md +0 -4
- package/dist/docs/federation/legacy-federation/00-introduction.md +4 -22
- package/dist/docs/federation/legacy-federation/01-installation.md +7 -58
- package/dist/docs/federation/legacy-federation/02-plugin-configuration.md +3 -21
- package/dist/docs/federation/legacy-federation/03-examples.md +3 -5
- package/dist/docs/federation/legacy-federation/04-configuration.md +3 -8
- package/dist/docs/federation/legacy-federation/05-setup-team-catalog.md +3 -6
- package/dist/docs/federation/reference/cli.md +2 -8
- package/dist/docs/federation/reference/configuration.md +0 -4
- package/dist/docs/federation/reference/diagnostic-rules.md +0 -5
- package/dist/docs/federation/reference/generated-output.md +0 -4
- package/dist/docs/federation/reference/supported-content.md +0 -4
- package/dist/docs/federation/reference/troubleshooting.md +0 -14
- package/dist/docs/plugins/02-generators.md +1 -1
- package/dist/docs/plugins/amazon-apigateway/00-intro.md +3 -28
- package/dist/docs/plugins/amazon-apigateway/01-installation.md +4 -56
- package/dist/docs/plugins/amazon-apigateway/02-plugin-configuration.md +1 -6
- package/dist/docs/plugins/apicurio/00-intro.md +2 -31
- package/dist/docs/plugins/apicurio/01-installation.md +2 -26
- package/dist/docs/plugins/apicurio/02-plugin-configuration.md +5 -13
- package/dist/docs/plugins/apicurio/03-features.md +1 -3
- package/dist/docs/plugins/asyncapi/00-intro.md +2 -28
- package/dist/docs/plugins/asyncapi/01-installation.md +3 -54
- package/dist/docs/plugins/asyncapi/02-plugin-configuration.md +2 -1
- package/dist/docs/plugins/aws-glue-registry/00-intro.md +4 -32
- package/dist/docs/plugins/aws-glue-registry/00a-installation.md +3 -53
- package/dist/docs/plugins/azure-schema-registry/00-intro.md +4 -32
- package/dist/docs/plugins/azure-schema-registry/01-installation.md +6 -33
- package/dist/docs/plugins/azure-schema-registry/02-plugin-configuration.md +1 -14
- package/dist/docs/plugins/azure-schema-registry/04-examples.md +0 -2
- package/dist/docs/plugins/backstage/00-overview.md +1 -7
- package/dist/docs/plugins/backstage/01-get-started.md +6 -15
- package/dist/docs/plugins/backstage/06-configuration.md +2 -8
- package/dist/docs/plugins/confluent-schema-registry/00-intro.md +2 -29
- package/dist/docs/plugins/confluent-schema-registry/01-installation.md +2 -26
- package/dist/docs/plugins/eventbridge/00-intro.md +0 -4
- package/dist/docs/plugins/eventbridge/00a-installation.md +1 -87
- package/dist/docs/plugins/eventbridge/03-api.md +2 -20
- package/dist/docs/plugins/github/00-intro.md +0 -31
- package/dist/docs/plugins/github/01-installation.md +2 -34
- package/dist/docs/plugins/graphql/00-intro.md +0 -30
- package/dist/docs/plugins/graphql/01-installation.md +1 -53
- package/dist/docs/plugins/graphql/02-plugin-configuration.md +0 -1
- package/dist/docs/plugins/hookdeck/01-intro.md +1 -1
- package/dist/docs/plugins/openapi/00-intro.md +0 -30
- package/dist/docs/plugins/openapi/01-installation.md +1 -57
- package/dist/docs/plugins/openapi/02-plugin-configuration.md +0 -5
- package/dist/docs/plugins/openapi/03-features.md +0 -4
- package/dist/eventcatalog-config-file-utils.cjs +34 -41
- package/dist/eventcatalog-config-file-utils.d.cts +56 -58
- package/dist/eventcatalog-config-file-utils.d.ts +56 -58
- package/dist/eventcatalog-config-file-utils.js +1 -1
- package/dist/eventcatalog.cjs +340 -249
- package/dist/eventcatalog.config.d.cts +18 -15
- package/dist/eventcatalog.config.d.ts +18 -15
- package/dist/eventcatalog.js +51 -33
- package/dist/features.cjs +36 -49
- package/dist/features.d.cts +1 -3
- package/dist/features.d.ts +1 -3
- package/dist/features.js +4 -6
- package/dist/federation/federate.cjs +37 -44
- package/dist/federation/federate.js +5 -5
- package/dist/federation/source-provider.js +2 -2
- package/dist/generate.cjs +37 -42
- package/dist/generate.js +4 -4
- package/dist/resolve-catalog-dependencies.cjs +34 -41
- package/dist/resolve-catalog-dependencies.js +2 -2
- package/dist/runtime-dependencies/@eventcatalog__visualiser__studio-fonts.css.mjs +3 -0
- package/dist/runtime-dependencies/@eventcatalog__visualiser__studio.css.mjs +3 -0
- package/dist/runtime-dependencies/@eventcatalog__visualiser__studio.mjs +3 -0
- package/dist/runtime-dependencies/htmlparser2.mjs +3 -0
- package/dist/runtime-dependencies/manifest.json +5 -1
- package/dist/runtime-dependencies/react-syntax-highlighter__dist__cjs__create-element.js.mjs +3 -0
- package/dist/utils/child-process-signals.cjs +53 -0
- package/dist/utils/child-process-signals.d.cts +19 -0
- package/dist/utils/child-process-signals.d.ts +19 -0
- package/dist/utils/child-process-signals.js +6 -0
- package/dist/utils/cli-logger.cjs +1 -1
- package/dist/utils/cli-logger.js +2 -2
- package/dist/utils/license-status.cjs +11 -4
- package/dist/utils/license-status.d.cts +3 -2
- package/dist/utils/license-status.d.ts +3 -2
- package/dist/utils/license-status.js +1 -1
- package/eventcatalog/astro.config.mjs +21 -1
- package/eventcatalog/integrations/config-loader.mjs +56 -58
- package/eventcatalog/integrations/skip-startup-reload.mjs +31 -0
- package/eventcatalog/integrations/stable-dependency-order.mjs +29 -0
- package/eventcatalog/integrations/storage.mjs +20 -0
- package/eventcatalog/integrations/studio-server.mjs +4 -1
- package/eventcatalog/src/components/CatalogGraph/CatalogForceGraph.tsx +39 -0
- package/eventcatalog/src/components/ChatPanel/ChatPanel.tsx +2 -0
- package/eventcatalog/src/components/Homepage/CatalogDashboard.astro +342 -0
- package/eventcatalog/src/components/MDX/NodeGraph/AstroNodeGraph.tsx +60 -4
- package/eventcatalog/src/components/MDX/NodeGraph/NodeGraph.astro +5 -1
- package/eventcatalog/src/components/NavigationProgress.astro +7 -0
- package/eventcatalog/src/components/SchemaExplorer/ApiContentViewer.tsx +2 -0
- package/eventcatalog/src/components/SchemaExplorer/ExamplesViewer.tsx +2 -0
- package/eventcatalog/src/components/SchemaExplorer/SchemaCodeModal.tsx +2 -0
- package/eventcatalog/src/components/SchemaExplorer/SchemaContentViewer.tsx +2 -0
- package/eventcatalog/src/components/Search/SearchDataLoader.astro +16 -28
- package/eventcatalog/src/components/Search/SearchModal.tsx +2 -10
- package/eventcatalog/src/components/Search/search-utils.ts +26 -0
- package/eventcatalog/src/components/Seo.astro +5 -1
- package/eventcatalog/src/components/Settings/AssistantSettingsForm.tsx +53 -48
- package/eventcatalog/src/components/Settings/GeneralSettingsForm.tsx +183 -178
- package/eventcatalog/src/components/Settings/LicenseSettings.tsx +140 -31
- package/eventcatalog/src/components/Settings/LlmAccessSettingsForm.tsx +40 -35
- package/eventcatalog/src/components/Settings/LogoUpload.tsx +1 -1
- package/eventcatalog/src/components/Settings/McpSettingsForm.tsx +9 -8
- package/eventcatalog/src/components/Settings/Row.tsx +7 -4
- package/eventcatalog/src/components/Settings/SettingsShared.tsx +3 -3
- package/eventcatalog/src/components/SideNav/NestedSideBar/index.tsx +37 -76
- package/eventcatalog/src/components/SideNav/NestedSideBar/storage.ts +2 -0
- package/eventcatalog/src/components/SideNav/NestedSideBar/utils.ts +122 -1
- package/eventcatalog/src/components/SideNav/SideNav.astro +9 -1
- package/eventcatalog/src/components/TrialBadge.astro +20 -9
- package/eventcatalog/src/content.config.ts +19 -2
- package/eventcatalog/src/features/auth/error.astro +4 -2
- package/eventcatalog/src/features/auth/login.astro +2 -1
- package/eventcatalog/src/features/auth/middleware/middleware-auth.ts +21 -1
- package/eventcatalog/src/features/auth/unauthorized.astro +1 -1
- package/eventcatalog/src/features/fields/pages/fields.astro +1 -1
- package/eventcatalog/src/features/integrations/eventcatalog-features.ts +13 -7
- package/eventcatalog/src/features/mcp/apps/architecture-diagram/node-chat.tsx +6 -45
- package/eventcatalog/src/features/mcp/apps/canvas/shared.ts +3 -3
- package/eventcatalog/src/features/mcp/apps/canvas/styles.css +3 -1
- package/eventcatalog/src/features/mcp/apps/canvas/view.tsx +7 -5
- package/eventcatalog/src/features/mcp/apps/generated/canvas.html +123 -98
- package/eventcatalog/src/features/mcp/apps/generated/viewer.html +118 -101
- package/eventcatalog/src/features/mcp/mcp-server.ts +20 -4
- package/eventcatalog/src/features/server/start.ts +25 -0
- package/eventcatalog/src/features/storage/database.ts +88 -0
- package/eventcatalog/src/features/storage/migrations.ts +85 -0
- package/eventcatalog/src/features/storage/sql/database.sql +5 -0
- package/eventcatalog/src/features/storage/sql/migrations/0001-studio-canvases.sql +12 -0
- package/eventcatalog/src/features/storage/sql/migrations.sql +15 -0
- package/eventcatalog/src/features/storage/sql.ts +28 -0
- package/eventcatalog/src/features/studio/agent-choreography.ts +13 -10
- package/eventcatalog/src/features/studio/agents.ts +28 -0
- package/eventcatalog/src/features/studio/api/canvases-api.ts +219 -0
- package/eventcatalog/src/features/studio/api/canvases.ts +25 -0
- package/eventcatalog/src/features/studio/api/client.ts +40 -0
- package/eventcatalog/src/features/studio/canvas-actions.ts +160 -34
- package/eventcatalog/src/features/studio/canvas-preview.ts +1 -2
- package/eventcatalog/src/features/studio/catalog.ts +16 -14
- package/eventcatalog/src/features/studio/components/CanvasHeader.tsx +274 -105
- package/eventcatalog/src/features/studio/components/CanvasStatusMenu.tsx +15 -14
- package/eventcatalog/src/features/studio/components/ConnectAgentDialog.tsx +272 -119
- package/eventcatalog/src/features/studio/components/ConnectionsChooser.tsx +1 -2
- package/eventcatalog/src/features/studio/components/DeleteCanvasDialog.tsx +65 -0
- package/eventcatalog/src/features/studio/components/Dialog.tsx +60 -0
- package/eventcatalog/src/features/studio/components/JoinForm.tsx +101 -26
- package/eventcatalog/src/features/studio/components/LeftPanel.tsx +122 -230
- package/eventcatalog/src/features/studio/components/NodeDetails.tsx +183 -0
- package/eventcatalog/src/features/studio/components/OpenInStudioDialog.tsx +79 -0
- package/eventcatalog/src/features/studio/components/Presence.tsx +52 -45
- package/eventcatalog/src/features/studio/components/ShareDialog.tsx +277 -141
- package/eventcatalog/src/features/studio/components/ShortcutsDialog.tsx +41 -0
- package/eventcatalog/src/features/studio/components/StudioDesigner.tsx +1314 -385
- package/eventcatalog/src/features/studio/components/StudioNotice.astro +24 -0
- package/eventcatalog/src/features/studio/document-name.ts +7 -0
- package/eventcatalog/src/features/studio/from-visualiser.ts +138 -0
- package/eventcatalog/src/features/studio/hooks/presence-sender.ts +19 -2
- package/eventcatalog/src/features/studio/hooks/use-canvas-webmcp.ts +9 -3
- package/eventcatalog/src/features/studio/hooks/use-comments.ts +2 -2
- package/eventcatalog/src/features/studio/hooks/use-follow-camera.ts +8 -3
- package/eventcatalog/src/features/studio/hooks/use-studio-flow.ts +244 -32
- package/eventcatalog/src/features/studio/identity.ts +25 -1
- package/eventcatalog/src/features/studio/limits.ts +2 -0
- package/eventcatalog/src/features/studio/pages/[id].astro +42 -16
- package/eventcatalog/src/features/studio/pages/index.astro +596 -373
- package/eventcatalog/src/features/studio/pages/webmcp-relay.ts +12 -15
- package/eventcatalog/src/features/studio/server/canvas-mcp.ts +8 -23
- package/eventcatalog/src/features/studio/server/runtime.ts +150 -46
- package/eventcatalog/src/features/studio/server/sql/storage.sql +18 -0
- package/eventcatalog/src/features/studio/server/storage.ts +53 -73
- package/eventcatalog/src/features/studio/webmcp-relay/LICENSE +21 -0
- package/eventcatalog/src/features/studio/webmcp-relay/README.md +5 -0
- package/eventcatalog/src/features/studio/webmcp-relay/embed.js +2 -0
- package/eventcatalog/src/features/studio/webmcp-relay/widget.html +10 -0
- package/eventcatalog/src/features/studio/webmcp-relay/widget.js +1 -0
- package/eventcatalog/src/features/tools/catalog-tools.ts +3 -1
- package/eventcatalog/src/layouts/BaseLayout.astro +4 -4
- package/eventcatalog/src/layouts/SettingsLayout.astro +2 -2
- package/eventcatalog/src/layouts/VerticalSideBarLayout.astro +3 -2
- package/eventcatalog/src/pages/_index.astro +5 -342
- package/eventcatalog/src/pages/architecture/[type]/[id]/[version]/_index.data.spec.ts +2 -3
- package/eventcatalog/src/pages/architecture/[type]/[id]/[version]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/architecture/[type]/[id]/[version]/index.astro +3 -1
- package/eventcatalog/src/pages/diagrams/[id]/[version]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/diagrams/[id]/[version]/embed.astro +1 -0
- package/eventcatalog/src/pages/diagrams/[id]/[version]/index.astro +1 -0
- package/eventcatalog/src/pages/directory/[type]/_index.data.ts +5 -7
- package/eventcatalog/src/pages/directory/[type]/index.astro +3 -1
- package/eventcatalog/src/pages/discover/[type]/_index.data.ts +5 -7
- package/eventcatalog/src/pages/discover/[type]/index.astro +3 -1
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/[docVersion]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/[docVersion]/index.astro +1 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/index.astro +1 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/asyncapi/[filename].astro +3 -1
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/asyncapi/_[filename].data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/changelog/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/changelog/index.astro +1 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/examples/[...filename].astro +1 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/examples/_[...filename].data.ts +0 -4
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/field-lineage/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/field-lineage/index.astro +1 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/graphql/[filename].astro +3 -1
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/graphql/_[filename].data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/index.astro +1 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/resources/_index.data.spec.ts +2 -3
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/resources/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/resources/index.astro +1 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/spec/[filename].astro +1 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/spec/_[filename].data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/index.astro +2 -1
- package/eventcatalog/src/pages/docs/[type]/[id]/language/[dictionaryId]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/language/[dictionaryId]/index.astro +1 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/language/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/[type]/[id]/language/index.astro +1 -0
- package/eventcatalog/src/pages/docs/custom/[...path]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/custom/[...path]/index.astro +1 -0
- package/eventcatalog/src/pages/docs/services/[id]/[docType]/[docId]/index.astro +1 -1
- package/eventcatalog/src/pages/docs/services/[id]/[version]/resources/index.astro +1 -0
- package/eventcatalog/src/pages/docs/services/[id]/asyncapi/[filename].astro +1 -1
- package/eventcatalog/src/pages/docs/services/[id]/changelog/index.astro +1 -1
- package/eventcatalog/src/pages/docs/services/[id]/graphql/[filename].astro +1 -1
- package/eventcatalog/src/pages/docs/services/[id]/spec/[filename].astro +1 -1
- package/eventcatalog/src/pages/docs/teams/[id]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/teams/[id]/index.astro +1 -0
- package/eventcatalog/src/pages/docs/users/[id]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/docs/users/[id]/index.astro +1 -0
- package/eventcatalog/src/pages/index.astro +4 -2
- package/eventcatalog/src/pages/schemas/[type]/[id]/[version]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/schemas/[type]/[id]/[version]/index.astro +9 -1
- package/eventcatalog/src/pages/schemas/explorer/_index.data.ts +0 -7
- package/eventcatalog/src/pages/schemas/explorer/index.astro +4 -2
- package/eventcatalog/src/pages/settings/license.astro +9 -1
- package/eventcatalog/src/pages/triggers/[type]/[id]/[version]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/triggers/[type]/[id]/[version]/index.astro +1 -0
- package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/data/_index.data.ts +0 -7
- package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/data/index.astro +1 -0
- package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/entity-map/_index.data.ts +0 -7
- package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/entity-map/index.astro +1 -0
- package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/index.astro +1 -0
- package/eventcatalog/src/pages/visualiser/[type]/[id]/_index.data.ts +38 -0
- package/eventcatalog/src/pages/visualiser/[type]/[id]/index.astro +18 -41
- package/eventcatalog/src/pages/visualiser/designs/[id]/_index.data.ts +0 -7
- package/eventcatalog/src/pages/visualiser/designs/[id]/index.astro +2 -1
- package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/entity-map/_index.data.ts +0 -7
- package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/entity-map/index.astro +1 -0
- package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/index.astro +1 -0
- package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/systems-context/_index.data.ts +0 -7
- package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/systems-context/index.astro +1 -0
- package/eventcatalog/src/pages/visualiser/systems/[id]/[version]/context/_index.data.ts +0 -7
- package/eventcatalog/src/pages/visualiser/systems/[id]/[version]/context/index.astro +1 -0
- package/eventcatalog/src/pages/visualiser/systems/[id]/[version]/index.astro +1 -0
- package/eventcatalog/src/types/react-syntax-highlighter.d.ts +10 -0
- package/eventcatalog/src/utils/collections/flows.ts +20 -7
- package/eventcatalog/src/utils/collections/resource-owners.ts +8 -2
- package/eventcatalog/src/utils/collections/resources.ts +2 -0
- package/eventcatalog/src/utils/collections/util.ts +8 -4
- package/eventcatalog/src/utils/git.ts +11 -0
- package/eventcatalog/src/utils/homepage-dashboard.ts +143 -0
- package/eventcatalog/src/utils/license.ts +1 -1
- package/eventcatalog/src/utils/link-validation.ts +25 -19
- package/eventcatalog/src/utils/node-graphs/domain-entity-map.ts +3 -1
- package/eventcatalog/src/utils/node-graphs/domain-levels-node-graph.ts +3 -3
- package/eventcatalog/src/utils/node-graphs/field-node-graph.ts +4 -2
- package/eventcatalog/src/utils/node-graphs/layout-node-graph.ts +20 -1
- package/eventcatalog/src/utils/node-graphs/node-resource.ts +67 -0
- package/eventcatalog/src/utils/node-graphs/systems-node-graph.ts +1 -1
- package/eventcatalog/src/utils/page-loaders/hybrid-page.ts +4 -15
- package/eventcatalog/src/utils/page-title.ts +15 -0
- package/eventcatalog/src/utils/syntax-highlighter-renderer.ts +64 -0
- package/eventcatalog/src/utils/trial.ts +13 -0
- package/package.json +11 -11
- package/dist/docs/development/ask-your-architecture/05-skills/02-installation.md +0 -60
- package/dist/docs/development/ask-your-architecture/05-skills/_category_.json +0 -11
- package/dist/docs/development/ask-your-architecture/06-slack-integration/01-introduction.md +0 -63
- package/dist/docs/development/ask-your-architecture/06-slack-integration/02-slack-app-setup.md +0 -154
- package/dist/docs/development/ask-your-architecture/06-slack-integration/03-installation.md +0 -169
- package/dist/docs/development/ask-your-architecture/06-slack-integration/04-deployment.md +0 -236
- package/dist/docs/development/ask-your-architecture/06-slack-integration/05-usage.md +0 -140
- package/dist/docs/development/ask-your-architecture/06-slack-integration/06-troubleshooting.md +0 -268
- package/dist/docs/development/ask-your-architecture/06-slack-integration/_category_.json +0 -13
- package/dist/docs/development/guides/domains/06-visualize-domains/01-domain-integration-map.md +0 -40
- package/dist/runtime-dependencies/@mcp-b__webmcp-local-relay.mjs +0 -3
- package/eventcatalog/src/features/studio/canvas-doc.ts +0 -409
- package/eventcatalog/src/features/studio/clipboard.ts +0 -97
- package/eventcatalog/src/features/studio/components/CanvasControls.tsx +0 -154
- package/eventcatalog/src/features/studio/components/Comments.tsx +0 -770
- package/eventcatalog/src/features/studio/components/ContainerChooser.tsx +0 -145
- package/eventcatalog/src/features/studio/components/DragGhost.tsx +0 -115
- package/eventcatalog/src/features/studio/components/Picture.tsx +0 -21
- package/eventcatalog/src/features/studio/components/PropertiesPanel.tsx +0 -212
- package/eventcatalog/src/features/studio/components/canvas-nodes.tsx +0 -255
- package/eventcatalog/src/features/studio/components/icons.ts +0 -53
- package/eventcatalog/src/features/studio/components/status.ts +0 -51
- package/eventcatalog/src/features/studio/edges.ts +0 -56
- package/eventcatalog/src/features/studio/flow-state.ts +0 -92
- package/eventcatalog/src/features/studio/grouping.ts +0 -226
- package/eventcatalog/src/features/studio/layout.ts +0 -42
- package/eventcatalog/src/features/studio/levels.ts +0 -282
- package/eventcatalog/src/features/studio/node-types.ts +0 -205
- package/eventcatalog/src/features/studio/pages/new.astro +0 -24
- package/eventcatalog/src/features/studio/pages/wake.ts +0 -15
- package/eventcatalog/src/features/studio/placement.ts +0 -197
- package/eventcatalog/src/features/studio/studio.css +0 -273
- package/dist/{chunk-A2RZR3U4.js → chunk-6K7XZAYI.js} +3 -3
|
@@ -8,20 +8,16 @@ description: Installation of the EventCatalog Federation plugin
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
11
|
-
import PluginLicense from '@site/src/components/MDX/PluginLicense';
|
|
12
11
|
import Beta from '@site/src/components/MDX/Beta';
|
|
13
|
-
import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
|
|
14
12
|
|
|
15
|
-
|
|
13
|
+
:::warning Deprecated
|
|
16
14
|
|
|
17
|
-
|
|
15
|
+
The `@eventcatalog/generator-federation` generator is deprecated. Federation is now built into EventCatalog and runs with `eventcatalog federate`. See the [EventCatalog Federation docs](/docs/federation/overview) to get started.
|
|
18
16
|
|
|
19
|
-
This page documents the legacy
|
|
17
|
+
This page documents the legacy generator for existing users.
|
|
20
18
|
|
|
21
19
|
:::
|
|
22
20
|
|
|
23
|
-
<PluginLicense url="#commercial-use" />
|
|
24
|
-
|
|
25
21
|
The EventCatalog Federation plugin is designed for your [main catalog](/docs/federation/legacy-federation/configuration).
|
|
26
22
|
|
|
27
23
|
This plugin will allow you to merge multiple EventCatalog instances into a single catalog.
|
|
@@ -114,62 +110,15 @@ generators: [
|
|
|
114
110
|
],
|
|
115
111
|
```
|
|
116
112
|
|
|
117
|
-
###
|
|
118
|
-
|
|
119
|
-
The EventCatalog Federation plugin requires an EventCatalog Scale license key to work with EventCatalog.
|
|
120
|
-
|
|
121
|
-
You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
122
|
-
|
|
123
|
-
You have a few options for setting the license key:
|
|
124
|
-
|
|
125
|
-
1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
|
|
126
|
-
2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
|
|
127
|
-
|
|
128
|
-
#### 1. Setting license key in `.env` file (recommended) {#setting-license-key-in-env-file-recommended}
|
|
129
|
-
|
|
130
|
-
<AddedIn version="2.35.4" />
|
|
131
|
-
|
|
132
|
-
Create a `.env` file in the root of your project and add the following:
|
|
133
|
-
|
|
134
|
-
```bash title=".env"
|
|
135
|
-
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
:::tip Using an Older API Key?
|
|
139
|
-
|
|
140
|
-
If you already have an older Federation plugin key, you can still use it with the Federation-specific environment variable.
|
|
141
|
-
|
|
142
|
-
```bash title=".env"
|
|
143
|
-
EVENTCATALOG_LICENSE_KEY_FEDERATION=your-license-key
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
:::
|
|
147
|
-
|
|
148
|
-
#### 2. Setting license key in eventcatalog.config.js {#setting-license-key-in-eventcatalogconfigjs}
|
|
149
|
-
|
|
150
|
-
If you prefer, you can set the license key in the `eventcatalog.config.js` file
|
|
151
|
-
using the `licenseKey` property in the EventCatalog Federation plugin.
|
|
152
|
-
|
|
153
|
-
```js title="eventcatalog.config.js"
|
|
154
|
-
export default {
|
|
155
|
-
generators: [
|
|
156
|
-
[
|
|
157
|
-
'@eventcatalog/generator-federation',
|
|
158
|
-
{
|
|
159
|
-
licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
|
|
160
|
-
},
|
|
161
|
-
],
|
|
162
|
-
],
|
|
163
|
-
};
|
|
164
|
-
```
|
|
113
|
+
### License
|
|
165
114
|
|
|
166
|
-
|
|
115
|
+
The EventCatalog Federation plugin is open source under the MIT License and doesn't need a license key.
|
|
167
116
|
|
|
168
|
-
If
|
|
117
|
+
If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
|
|
169
118
|
|
|
170
119
|
## Run the generator
|
|
171
120
|
|
|
172
|
-
Once you have configured the plugin
|
|
121
|
+
Once you have configured the plugin you can run the generator.
|
|
173
122
|
|
|
174
123
|
```sh
|
|
175
124
|
npm run generate
|
|
@@ -7,20 +7,16 @@ title: Plugin Configuration
|
|
|
7
7
|
description: Configuration of the EventCatalog Federation plugin
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
:::warning Deprecated
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
The `@eventcatalog/generator-federation` generator is deprecated. Federation is now built into EventCatalog and runs with `eventcatalog federate`. See the [EventCatalog Federation docs](/docs/federation/overview) to get started.
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
This page documents the legacy `@eventcatalog/generator-federation` implementation. For new projects, use the [current built-in EventCatalog Federation](/docs/federation/overview).
|
|
14
|
+
This page documents the legacy generator for existing users.
|
|
17
15
|
|
|
18
16
|
:::
|
|
19
17
|
|
|
20
18
|
API Configuration for the EventCatalog Federation plugin
|
|
21
19
|
|
|
22
|
-
|
|
23
|
-
|
|
24
20
|
## Overview
|
|
25
21
|
|
|
26
22
|
The EventCatalog Federation plugin is configured in the `eventcatalog.config.js` file inside the `generators` array.
|
|
@@ -201,17 +197,3 @@ export default {
|
|
|
201
197
|
|
|
202
198
|
You can view an example configuration in the [EventCatalog Federation plugin GitHub repository](https://github.com/event-catalog/generators/blob/main/examples/generator-federation/basic/central-catalog/eventcatalog.config.js).
|
|
203
199
|
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
@@ -7,13 +7,11 @@ title: Examples
|
|
|
7
7
|
description: Examples of using the Federation plugin
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
:::warning Deprecated
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
The `@eventcatalog/generator-federation` generator is deprecated. Federation is now built into EventCatalog and runs with `eventcatalog federate`. See the [EventCatalog Federation docs](/docs/federation/overview) to get started.
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
This page documents the legacy `@eventcatalog/generator-federation` implementation. For new projects, use the [current built-in EventCatalog Federation](/docs/federation/overview).
|
|
14
|
+
This page documents the legacy generator for existing users.
|
|
17
15
|
|
|
18
16
|
:::
|
|
19
17
|
|
|
@@ -8,21 +8,18 @@ description: Configuring federation in your EventCatalog
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
11
|
-
import PluginLicense from '@site/src/components/MDX/PluginLicense';
|
|
12
11
|
import Beta from '@site/src/components/MDX/Beta';
|
|
13
|
-
import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
|
|
14
12
|
|
|
15
|
-
|
|
13
|
+
:::warning Deprecated
|
|
16
14
|
|
|
17
|
-
|
|
15
|
+
The `@eventcatalog/generator-federation` generator is deprecated. Federation is now built into EventCatalog and runs with `eventcatalog federate`. See the [EventCatalog Federation docs](/docs/federation/overview) to get started.
|
|
18
16
|
|
|
19
|
-
This page documents the legacy
|
|
17
|
+
This page documents the legacy generator for existing users.
|
|
20
18
|
|
|
21
19
|
:::
|
|
22
20
|
|
|
23
21
|
<!-- <Beta /> -->
|
|
24
22
|
<AddedIn version="2.18.0" />
|
|
25
|
-
<PluginLicense url="/docs/federation/legacy-federation/introduction#commercial-use" />
|
|
26
23
|
|
|
27
24
|
EventCatalog Federation is powered by the [EventCatalog Federation Generator](https://github.com/event-catalog/generators), this let's you define the repositories you want to merge into your main catalog.
|
|
28
25
|
|
|
@@ -172,8 +169,6 @@ If you want to learn more about the federation generator you can read the [Event
|
|
|
172
169
|
|
|
173
170
|
### Running the generator
|
|
174
171
|
|
|
175
|
-
You will need an EventCatalog Scale license key to run the generator. You can get a free 30-day trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
176
|
-
|
|
177
172
|
Once you have configured the federation generator you can run the generator.
|
|
178
173
|
|
|
179
174
|
Inside your main catalog run the following command:
|
|
@@ -8,21 +8,18 @@ description: Configuring federation in your EventCatalog
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
11
|
-
import PluginLicense from '@site/src/components/MDX/PluginLicense';
|
|
12
11
|
import Beta from '@site/src/components/MDX/Beta';
|
|
13
|
-
import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
|
|
14
12
|
|
|
15
|
-
|
|
13
|
+
:::warning Deprecated
|
|
16
14
|
|
|
17
|
-
|
|
15
|
+
The `@eventcatalog/generator-federation` generator is deprecated. Federation is now built into EventCatalog and runs with `eventcatalog federate`. See the [EventCatalog Federation docs](/docs/federation/overview) to get started.
|
|
18
16
|
|
|
19
|
-
This page documents the legacy
|
|
17
|
+
This page documents the legacy generator for existing users.
|
|
20
18
|
|
|
21
19
|
:::
|
|
22
20
|
|
|
23
21
|
<!-- <Beta /> -->
|
|
24
22
|
<AddedIn version="2.18.0" />
|
|
25
|
-
<PluginLicense url="/docs/federation/legacy-federation/introduction#commercial-use" />
|
|
26
23
|
|
|
27
24
|
Multiple teams can own their own EventCatalog, this is useful if you have multiple teams that want to own their own EventCatalog / Documentation.
|
|
28
25
|
|
|
@@ -5,10 +5,6 @@ title: Federation CLI reference
|
|
|
5
5
|
description: Command, option, environment variable, and output reference for eventcatalog federate.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
|
|
9
|
-
|
|
10
|
-
<EventCatalogEnterprise />
|
|
11
|
-
|
|
12
8
|
Run Federation from the central catalog directory:
|
|
13
9
|
|
|
14
10
|
```bash
|
|
@@ -20,11 +16,12 @@ The command loads `federation.sources` and `federation.rules` from `eventcatalog
|
|
|
20
16
|
## Requirements
|
|
21
17
|
|
|
22
18
|
- A central EventCatalog project
|
|
23
|
-
- An EventCatalog Enterprise offline license file
|
|
24
19
|
- At least one configured source, unless you are cleaning previous output
|
|
25
20
|
- Git for GitHub sources that do not publish an index
|
|
26
21
|
- Network and repository access for GitHub sources
|
|
27
22
|
|
|
23
|
+
Federation is free for organizations that [qualify for Free Use](/license-faq), using their free license key. Commercial customers need the [Enterprise plan](/pricing). Every organization can try it during its 60-day evaluation.
|
|
24
|
+
|
|
28
25
|
## Options
|
|
29
26
|
|
|
30
27
|
| Option | Description | Default |
|
|
@@ -69,11 +66,8 @@ EVENTCATALOG_FEDERATION_LOCAL=true npx eventcatalog federate
|
|
|
69
66
|
|
|
70
67
|
## Environment variables
|
|
71
68
|
|
|
72
|
-
Place the Enterprise `license.jwt` file in the central catalog root. You can commit it with the catalog or write it during CI/CD. If you store it elsewhere, set `EC_LICENSE` to its file path. Email [hello@eventcatalog.dev](mailto:hello@eventcatalog.dev?subject=EventCatalog%20Federation%20Trial) to request an offline trial key.
|
|
73
|
-
|
|
74
69
|
| Variable | Description |
|
|
75
70
|
| --- | --- |
|
|
76
|
-
| `EC_LICENSE` | Optional path to the Enterprise offline license file. Defaults to `license.jwt` in the catalog root. |
|
|
77
71
|
| `EVENTCATALOG_GITHUB_TOKEN` | Preferred GitHub token for private repositories and authenticated content requests. |
|
|
78
72
|
| `GITHUB_TOKEN` | GitHub token fallback when `EVENTCATALOG_GITHUB_TOKEN` is not set. |
|
|
79
73
|
|
|
@@ -5,10 +5,6 @@ title: Federation configuration reference
|
|
|
5
5
|
description: Reference for federation sources and rule levels in eventcatalog.config.js.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
|
|
9
|
-
|
|
10
|
-
<EventCatalogEnterprise />
|
|
11
|
-
|
|
12
8
|
Configure Federation under the `federation` key in the central catalog's `eventcatalog.config.js`.
|
|
13
9
|
|
|
14
10
|
```js title="eventcatalog.config.js"
|
|
@@ -5,10 +5,6 @@ title: Federation diagnostic rule reference
|
|
|
5
5
|
description: Reference for every Federation rule, default level, trigger, output attributes, and resolution.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
|
|
9
|
-
|
|
10
|
-
<EventCatalogEnterprise />
|
|
11
|
-
|
|
12
8
|
Federation diagnostics use stable rule IDs. Configure each rule as `off`, `warn`, or `error` under `federation.rules`.
|
|
13
9
|
|
|
14
10
|
| Rule | Default | Summary |
|
|
@@ -159,7 +155,6 @@ Changing structural rules from `error` can allow ambiguous ownership or types in
|
|
|
159
155
|
|
|
160
156
|
Some failures stop Federation directly and do not have configurable `federation/*` rule IDs. These include:
|
|
161
157
|
|
|
162
|
-
- Missing or invalid license access
|
|
163
158
|
- Duplicate configured source IDs
|
|
164
159
|
- Unsupported source locators
|
|
165
160
|
- GitHub authentication or network failures
|
|
@@ -5,10 +5,6 @@ title: Federation generated output reference
|
|
|
5
5
|
description: Reference for federated resources, shared components, public assets, the lockfile, and content cache.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
|
|
9
|
-
|
|
10
|
-
<EventCatalogEnterprise />
|
|
11
|
-
|
|
12
8
|
A successful Federation run can create or update four locations in the central catalog:
|
|
13
9
|
|
|
14
10
|
```text
|
|
@@ -5,10 +5,6 @@ title: Federation supported content
|
|
|
5
5
|
description: Reference for resources, files, assets, and catalog-level content included by Federation.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
|
|
9
|
-
|
|
10
|
-
<EventCatalogEnterprise />
|
|
11
|
-
|
|
12
8
|
Federation indexes and materializes normal EventCatalog resource content from every configured source.
|
|
13
9
|
|
|
14
10
|
## Supported resources
|
|
@@ -5,10 +5,6 @@ title: Troubleshooting EventCatalog Federation
|
|
|
5
5
|
description: Fix common source, ownership, relationship, asset, cache, and generated-output problems.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
import EventCatalogEnterprise from '@site/src/components/MDX/EventCatalogEnterprise';
|
|
9
|
-
|
|
10
|
-
<EventCatalogEnterprise />
|
|
11
|
-
|
|
12
8
|
Run with verbose diagnostics before investigating a warning:
|
|
13
9
|
|
|
14
10
|
```bash
|
|
@@ -17,16 +13,6 @@ npx eventcatalog federate --verbose
|
|
|
17
13
|
|
|
18
14
|
Errors always include details. Verbose mode adds the attributes for warnings.
|
|
19
15
|
|
|
20
|
-
## Federation is not enabled
|
|
21
|
-
|
|
22
|
-
If the command reports that Federation is an Enterprise feature:
|
|
23
|
-
|
|
24
|
-
- Confirm the Enterprise `license.jwt` file is in the central catalog root
|
|
25
|
-
- If the file is stored elsewhere, confirm `EC_LICENSE` points to it
|
|
26
|
-
- Confirm the license has not expired
|
|
27
|
-
- Email [hello@eventcatalog.dev](mailto:hello@eventcatalog.dev?subject=EventCatalog%20Federation%20Trial) to request or replace an offline trial key
|
|
28
|
-
- Review [offline license validation](/docs/development/license-keys/license-validation#offline-validation)
|
|
29
|
-
|
|
30
16
|
## No sources are configured
|
|
31
17
|
|
|
32
18
|
Add at least one entry to `federation.sources`:
|
|
@@ -8,7 +8,7 @@ description: Understanding EventCatalog generators.
|
|
|
8
8
|
---
|
|
9
9
|
EventCatalog generators are custom scripts executed before the build process begins.
|
|
10
10
|
|
|
11
|
-
During the catalog build, your configured generators run dynamically, providing the opportunity to
|
|
11
|
+
During the catalog build, your configured generators run dynamically, providing the opportunity to use existing generators and plugins or develop your own custom solutions.
|
|
12
12
|
|
|
13
13
|
### Why use generators?
|
|
14
14
|
|
|
@@ -8,9 +8,6 @@ description: Getting started with Amazon EventBridge plugin
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
11
|
-
import PluginLicense from '@site/src/components/MDX/PluginLicense';
|
|
12
|
-
|
|
13
|
-
<PluginLicense url="#commercial-use" />
|
|
14
11
|
|
|
15
12
|
<!-- <iframe width="100%" height="415" src="https://www.youtube.com/embed/MeBuwAflwM4?si=rhio4gjfDPau4eqB" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> -->
|
|
16
13
|
|
|
@@ -44,32 +41,10 @@ This plugin will download OpenAPI specifications from your API Gateway and impor
|
|
|
44
41
|
|
|
45
42
|
This will map your routes into commands, events and queries in your catalog and assign these to services and domains and teams in your organization.
|
|
46
43
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
This plugin requires an EventCatalog Scale license key to be used.
|
|
50
|
-
|
|
51
|
-
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
52
|
-
|
|
53
|
-
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
54
|
-
|
|
55
|
-
See [pricing](/pricing) for more information.
|
|
56
|
-
|
|
57
|
-
_Have any questions? You can email us at `hello@eventcatalog.dev`._
|
|
58
|
-
|
|
59
|
-
## License FAQ
|
|
60
|
-
|
|
61
|
-
### What is the license key for?
|
|
62
|
-
The EventCatalog Scale license key is required to use the Amazon API Gateway plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
63
|
-
|
|
64
|
-
### How do I get an EventCatalog Scale license key?
|
|
65
|
-
You can obtain an EventCatalog Scale license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). Your organization can start with a 30-day trial.
|
|
66
|
-
|
|
67
|
-
### Terms
|
|
68
|
-
- **Trial Period**: 30-day free trial no credit card required
|
|
69
|
-
- **Support**: Discord community support (extra for priority support)
|
|
44
|
+
### License
|
|
70
45
|
|
|
71
|
-
|
|
46
|
+
This plugin is open source under the MIT License and doesn't need a license key.
|
|
72
47
|
|
|
73
48
|
## Issues
|
|
74
49
|
|
|
75
|
-
If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators or join our [Discord community](https://eventcatalog.dev/discord) to chat with the team and other users.
|
|
50
|
+
If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators or join our [Discord community](https://eventcatalog.dev/discord) to chat with the team and other users.
|
|
@@ -8,12 +8,9 @@ description: Installation instructions for the Amazon API Gateway plugin
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
11
|
-
import PluginLicense from '@site/src/components/MDX/PluginLicense';
|
|
12
11
|
import Tabs from '@theme/Tabs';
|
|
13
12
|
import TabItem from '@theme/TabItem';
|
|
14
13
|
|
|
15
|
-
<PluginLicense url="#commercial-use" />
|
|
16
|
-
|
|
17
14
|
This plugin requires the OpenAPI and Amazon API Gateway plugins to be installed.
|
|
18
15
|
|
|
19
16
|
<!-- <iframe width="100%" height="415" src="https://www.youtube.com/embed/MeBuwAflwM4?si=rhio4gjfDPau4eqB" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> -->
|
|
@@ -123,63 +120,15 @@ export default {
|
|
|
123
120
|
};
|
|
124
121
|
```
|
|
125
122
|
|
|
126
|
-
###
|
|
127
|
-
|
|
128
|
-
The API Gateway and OpenAPI plugin both require a license key to work with EventCatalog.
|
|
129
|
-
|
|
130
|
-
You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
131
|
-
|
|
132
|
-
You have a few options for setting the license key:
|
|
133
|
-
|
|
134
|
-
1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
|
|
135
|
-
2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
|
|
136
|
-
|
|
137
|
-
#### 1. Setting license key in `.env` file (recommended) {#setting-license-key-in-env-file-recommended}
|
|
138
|
-
|
|
139
|
-
<AddedIn version="2.35.4" />
|
|
140
|
-
|
|
141
|
-
Create a `.env` file in the root of your project and add the following:
|
|
142
|
-
|
|
143
|
-
```bash title=".env"
|
|
144
|
-
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
:::tip Using an Older API Key?
|
|
148
|
-
|
|
149
|
-
If you already have older Amazon API Gateway and OpenAPI plugin keys, you can still use them with the plugin-specific environment variables.
|
|
150
|
-
|
|
151
|
-
```bash title=".env"
|
|
152
|
-
EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY=your-license-key
|
|
153
|
-
EVENTCATALOG_LICENSE_KEY_OPENAPI=your-license-key
|
|
154
|
-
```
|
|
155
|
-
|
|
156
|
-
:::
|
|
123
|
+
### Licensing
|
|
157
124
|
|
|
158
|
-
|
|
125
|
+
The API Gateway and OpenAPI plugins are open source under the MIT License and don't need a license key.
|
|
159
126
|
|
|
160
|
-
If
|
|
161
|
-
using the `licenseKey` property in both the API Gateway and OpenAPI plugin.
|
|
162
|
-
|
|
163
|
-
```js title="eventcatalog.config.js"
|
|
164
|
-
export default {
|
|
165
|
-
generators: [
|
|
166
|
-
[
|
|
167
|
-
'@eventcatalog/generator-eventbridge',
|
|
168
|
-
{
|
|
169
|
-
licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
|
|
170
|
-
},
|
|
171
|
-
],
|
|
172
|
-
],
|
|
173
|
-
};
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
#### White listing EventCatalog domains
|
|
177
|
-
|
|
178
|
-
If you are behind a firewall you will need to white list the domain `https://api.eventcatalog.cloud` in your firewall. This is because the plugin needs to verify your license key.
|
|
127
|
+
If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
|
|
179
128
|
|
|
180
129
|
## Run the generator
|
|
181
130
|
|
|
182
|
-
Once you have configured the plugin
|
|
131
|
+
Once you have configured the plugin you can run the generator.
|
|
183
132
|
|
|
184
133
|
```sh
|
|
185
134
|
npm run generate
|
|
@@ -193,4 +142,3 @@ Run your catalog locally to see the changes.
|
|
|
193
142
|
npm run dev
|
|
194
143
|
```
|
|
195
144
|
|
|
196
|
-
|
|
@@ -7,11 +7,7 @@ title: Plugin Configuration
|
|
|
7
7
|
description: Configuration of the Amazon API Gateway plugin
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
This plugin
|
|
11
|
-
|
|
12
|
-
You can get a 30-day free trial license key by signing up to [EventCatalog Cloud](https://eventcatalog.dev/cloud).
|
|
13
|
-
|
|
14
|
-
Once you have your license key you can set the `EVENTCATALOG_SCALE_LICENSE_KEY` environment variable.
|
|
10
|
+
This plugin is open source under the MIT License and doesn't need a license key.
|
|
15
11
|
|
|
16
12
|
## Overview
|
|
17
13
|
|
|
@@ -23,7 +19,6 @@ The Amazon API Gateway plugin is configured in the `eventcatalog.config.js` file
|
|
|
23
19
|
|--------|------|----------|---------|-------------|
|
|
24
20
|
| `output` | string | No | `amazon-apigateway-specs` | The output directory for the OpenAPI specifications (used by the OpenAPI Generator plugin) |
|
|
25
21
|
| `credentials` | [AwsCredentialIdentity](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-types/Interface/AwsCredentialIdentity/) | No | - | AWS credentials to use for the import on AWS. If this is not provided it will default to the credentials on the machine. |
|
|
26
|
-
| `licenseKey` | string | No | - | You can either pass the license key directly or set the `EVENTCATALOG_SCALE_LICENSE_KEY` environment variable. |
|
|
27
22
|
| `apis` | API[] | Yes | - | Array of API configurations |
|
|
28
23
|
|
|
29
24
|
## API Configuration
|
|
@@ -8,17 +8,10 @@ title: Introduction
|
|
|
8
8
|
description: Getting started with Apicurio Registry plugin
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
|
|
12
11
|
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
13
12
|
|
|
14
|
-
import PluginLicense from '@site/src/components/MDX/PluginLicense';
|
|
15
|
-
|
|
16
|
-
<PluginLicense url="#commercial-use" />
|
|
17
|
-
|
|
18
|
-
|
|
19
13
|
<iframe width="100%" height="415" src="https://www.youtube.com/embed/0DmGWa0sr6w?si=KsE4D9C_yN7998Vo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
|
|
20
14
|
|
|
21
|
-
|
|
22
15
|
---
|
|
23
16
|
|
|
24
17
|
Many teams building event-driven architectures use schema registries to manage their message schemas and API specifications.
|
|
@@ -67,36 +60,14 @@ EventCatalog supports [generators](/docs/plugins/generators). These are scripts
|
|
|
67
60
|
|
|
68
61
|
The EventCatalog Apicurio Registry plugin is a generator. It will import your schemas and specifications from your Apicurio Registry into EventCatalog.
|
|
69
62
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
This plugin requires an EventCatalog Scale license key to be used.
|
|
73
|
-
|
|
74
|
-
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
63
|
+
### License
|
|
75
64
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
See [pricing](/pricing) for more information.
|
|
79
|
-
|
|
80
|
-
_Have any questions? You can email us at `hello@eventcatalog.dev`._
|
|
65
|
+
This plugin is open source under the MIT License and doesn't need a license key.
|
|
81
66
|
|
|
82
67
|
## Need a demo?
|
|
83
68
|
|
|
84
69
|
If you would like a demo of the plugin, please feel free to reach out to us and book a time to chat at hello@eventcatalog.dev.
|
|
85
70
|
|
|
86
|
-
## License FAQ
|
|
87
|
-
|
|
88
|
-
### What is the license key for?
|
|
89
|
-
The EventCatalog Scale license key is required to use the Apicurio Registry plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
90
|
-
|
|
91
|
-
### How do I get an EventCatalog Scale license key?
|
|
92
|
-
You can obtain an EventCatalog Scale license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 30-day free trial.
|
|
93
|
-
|
|
94
|
-
### Terms
|
|
95
|
-
- **Trial Period**: 30-day free trial no credit card required
|
|
96
|
-
- **Support**: Discord community support (extra for priority support)
|
|
97
|
-
|
|
98
|
-
After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
99
|
-
|
|
100
71
|
## Any questions or need help?
|
|
101
72
|
|
|
102
73
|
If you have questions or need help, you can join our [Discord community](https://eventcatalog.dev/discord) or raise an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
|
|
@@ -8,13 +8,10 @@ description: Installation of the EventCatalog Apicurio Registry plugin
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
11
|
-
import PluginLicense from '@site/src/components/MDX/PluginLicense';
|
|
12
11
|
import Beta from '@site/src/components/MDX/Beta';
|
|
13
12
|
import Tabs from '@theme/Tabs';
|
|
14
13
|
import TabItem from '@theme/TabItem';
|
|
15
14
|
|
|
16
|
-
<PluginLicense url="#commercial-use" />
|
|
17
|
-
|
|
18
15
|
The Apicurio Registry plugin is used to generate a catalog from an Apicurio Registry and import your schemas and specifications into EventCatalog.
|
|
19
16
|
|
|
20
17
|
You can map your schemas from your Apicurio Registry to events, commands, or queries in your catalog, and assign these to services and domains.
|
|
@@ -55,7 +52,6 @@ Add the plugin to the `generators` array.
|
|
|
55
52
|
|
|
56
53
|
You can also create services and assign schemas to them, along with domains. [(see examples)](/docs/plugins/apicurio/plugin-configuration#example-configurations).
|
|
57
54
|
|
|
58
|
-
|
|
59
55
|
```js title="eventcatalog.config.js"
|
|
60
56
|
// ...
|
|
61
57
|
generators: [
|
|
@@ -115,35 +111,15 @@ We create an `orders` domain and an `Orders Service` that sends and receives mes
|
|
|
115
111
|
|
|
116
112
|
### Configure API keys
|
|
117
113
|
|
|
118
|
-
The EventCatalog Apicurio Registry plugin
|
|
114
|
+
The EventCatalog Apicurio Registry plugin is open source under the MIT License and doesn't need a license key. If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
|
|
119
115
|
|
|
120
|
-
|
|
121
|
-
2. Apicurio Registry access token (optional - only if your registry requires authentication)
|
|
122
|
-
|
|
123
|
-
Create a `.env` file in the root, and add your keys to the project.
|
|
116
|
+
If your Apicurio Registry requires authentication, create a `.env` file in the root and add your access token to the project.
|
|
124
117
|
|
|
125
118
|
```bash title=".env"
|
|
126
|
-
# EventCatalog license key
|
|
127
|
-
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
128
|
-
|
|
129
119
|
# Apicurio Registry Bearer Token (optional - only if your registry requires authentication)
|
|
130
120
|
APICURIO_ACCESS_TOKEN=your-access-token-here
|
|
131
121
|
```
|
|
132
122
|
|
|
133
|
-
:::tip Using an Older API Key?
|
|
134
|
-
|
|
135
|
-
If you already have an older Apicurio Registry plugin key, you can still use it with the plugin-specific environment variable.
|
|
136
|
-
|
|
137
|
-
```bash title=".env"
|
|
138
|
-
EVENTCATALOG_LICENSE_KEY_APICURIO_SCHEMA_REGISTRY=your-license-key
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
:::
|
|
142
|
-
|
|
143
|
-
#### White listing EventCatalog domains
|
|
144
|
-
|
|
145
|
-
If you are behind a firewall you will need to white list the domain `https://api.eventcatalog.cloud` in your firewall. This is because the plugin needs to verify your license key.
|
|
146
|
-
|
|
147
123
|
#### Run the plugin
|
|
148
124
|
|
|
149
125
|
Run the plugin to import your schemas into EventCatalog.
|
|
@@ -73,12 +73,10 @@ You can attach OpenAPI or AsyncAPI specifications stored in your Apicurio Regist
|
|
|
73
73
|
|
|
74
74
|
You can attach OpenAPI or AsyncAPI specifications from your Apicurio Registry to services. These specifications can optionally be processed by their respective EventCatalog plugins to generate additional documentation.
|
|
75
75
|
|
|
76
|
-
:::info Plugin
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
- Configure the license key in your `.env` file:
|
|
81
|
-
- `EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key`
|
|
76
|
+
:::info Plugin setup
|
|
77
|
+
To use the OpenAPI and AsyncAPI generators with the Apicurio plugin, you'll need to install the respective plugins: `npm install @eventcatalog/generator-openapi @eventcatalog/generator-asyncapi`
|
|
78
|
+
|
|
79
|
+
Both plugins are open source under the MIT License and don't need a license key.
|
|
82
80
|
|
|
83
81
|
Learn more: [OpenAPI Plugin Docs](/docs/plugins/openapi/intro) | [AsyncAPI Plugin Docs](/docs/plugins/asyncapi/intro)
|
|
84
82
|
:::
|
|
@@ -528,16 +526,10 @@ In this example we attach OpenAPI and AsyncAPI specifications to a service and u
|
|
|
528
526
|
```
|
|
529
527
|
|
|
530
528
|
:::tip
|
|
531
|
-
When using nested generators, make sure to:
|
|
532
|
-
1. Install the respective plugins:
|
|
529
|
+
When using nested generators, make sure to install the respective plugins:
|
|
533
530
|
```bash
|
|
534
531
|
npm install @eventcatalog/generator-openapi @eventcatalog/generator-asyncapi
|
|
535
532
|
```
|
|
536
|
-
2. Obtain an EventCatalog Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud) (30-day free trial available)
|
|
537
|
-
3. Add the license key to your `.env` file:
|
|
538
|
-
```bash
|
|
539
|
-
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
540
|
-
```
|
|
541
533
|
|
|
542
534
|
See [OpenAPI Plugin Docs](/docs/plugins/openapi/intro) | [AsyncAPI Plugin Docs](/docs/plugins/asyncapi/intro) for more information.
|
|
543
535
|
:::
|