@eventcatalog/core 5.0.0-beta.8 → 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 +234 -134
- package/README.md +5 -5
- package/dist/analytics/analytics.cjs +18 -3
- package/dist/analytics/analytics.d.cts +1 -1
- package/dist/analytics/analytics.d.ts +1 -1
- package/dist/analytics/analytics.js +3 -2
- package/dist/analytics/log-build.cjs +157 -76
- package/dist/analytics/log-build.d.cts +2 -2
- package/dist/analytics/log-build.d.ts +2 -2
- package/dist/analytics/log-build.js +7 -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/analytics/telemetry.cjs +42 -0
- package/dist/analytics/telemetry.d.cts +20 -0
- package/dist/analytics/telemetry.d.ts +20 -0
- package/dist/analytics/telemetry.js +8 -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-CPW6G62V.js +17 -0
- package/dist/{chunk-PU25TOOJ.js → chunk-JZN4RSMF.js} +1 -1
- package/dist/{chunk-4W55ZOOS.js → chunk-NEAVAFSJ.js} +66 -35
- package/dist/{chunk-C6T2AAFR.js → chunk-NIVST4WY.js} +9 -3
- package/dist/{chunk-ENAG6UH7.js → chunk-NKNOXQ62.js} +1 -6
- package/dist/{chunk-AYNZXUB5.js → chunk-OX6TSVHY.js} +5 -5
- package/dist/{chunk-36RYTYT5.js → chunk-PD7KTSYN.js} +1 -1
- package/dist/{chunk-RDIZJ7UT.js → chunk-RE7UTPWH.js} +1 -1
- package/dist/chunk-S5GWAUG5.js +29 -0
- package/dist/{chunk-T4G3VVZ4.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 +408 -281
- package/dist/eventcatalog.config.d.cts +26 -15
- package/dist/eventcatalog.config.d.ts +26 -15
- package/dist/eventcatalog.js +46 -27
- 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,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
|
:::
|
|
@@ -65,9 +65,7 @@ One of the powerful features of the Apicurio Registry plugin is its ability to w
|
|
|
65
65
|
|
|
66
66
|
You can store OpenAPI and AsyncAPI specifications in your Apicurio Registry and use them to generate comprehensive service documentation automatically.
|
|
67
67
|
|
|
68
|
-
:::info
|
|
69
|
-
The OpenAPI and AsyncAPI generators require an EventCatalog Scale license key. You can get a 30-day free trial from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
70
|
-
|
|
68
|
+
:::info
|
|
71
69
|
See the [OpenAPI Plugin](/docs/plugins/openapi/intro) and [AsyncAPI Plugin](/docs/plugins/asyncapi/intro) documentation for more details on installation and configuration.
|
|
72
70
|
:::
|
|
73
71
|
|
|
@@ -9,10 +9,7 @@ description: Getting started with AsyncAPI plugin
|
|
|
9
9
|
|
|
10
10
|
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
11
11
|
|
|
12
|
-
import PluginLicense from '@site/src/components/MDX/PluginLicense';
|
|
13
|
-
|
|
14
12
|
<AddedIn version="2.5.0"/>
|
|
15
|
-
<PluginLicense url="#commercial-use" />
|
|
16
13
|
|
|
17
14
|
<iframe width="100%" height="415" src="https://www.youtube.com/embed/XglwSNAnpKY?si=CtM_M0odLSPB8nhY" 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>
|
|
18
15
|
|
|
@@ -26,7 +23,6 @@ Using the EventCatalog AsyncAPI generator you can generate and maintain your Eve
|
|
|
26
23
|
Want to see what your AsyncAPI file looks like in EventCatalog? [Try the playground](https://try.eventcatalog.dev) — drop your file and see the result in seconds.
|
|
27
24
|
:::
|
|
28
25
|
|
|
29
|
-
|
|
30
26
|
:::info
|
|
31
27
|
**What is AsyncAPI?**: An industry standard for defining asynchronous APIs. Use this specification to document your service, channels and messages.
|
|
32
28
|
:::
|
|
@@ -54,28 +50,6 @@ EventCatalog supports [generators](/docs/plugins/generators). These are scripts
|
|
|
54
50
|
|
|
55
51
|
The EventCatalog AsyncAPI plugin let's you define 1 or many AsyncAPI files. When running the generate command the scripts populate your eventcatalog. You can choose how your AsyncAPI services are added to EventCatalog and which domain they belong to.
|
|
56
52
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
This plugin requires an EventCatalog Scale license key to be used.
|
|
60
|
-
|
|
61
|
-
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
62
|
-
|
|
63
|
-
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
64
|
-
|
|
65
|
-
See [pricing](/pricing) for more information.
|
|
66
|
-
|
|
67
|
-
_Have any questions? You can email us at `hello@eventcatalog.dev`._
|
|
68
|
-
|
|
69
|
-
## License FAQ
|
|
70
|
-
|
|
71
|
-
### What is the license key for?
|
|
72
|
-
The EventCatalog Scale license key is required to use the OpenAPI plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
73
|
-
|
|
74
|
-
### How do I get an EventCatalog Scale license key?
|
|
75
|
-
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.
|
|
76
|
-
|
|
77
|
-
### Terms
|
|
78
|
-
- **Trial Period**: 30-day free trial no credit card required
|
|
79
|
-
- **Support**: Discord community support (extra for priority support)
|
|
53
|
+
### License
|
|
80
54
|
|
|
81
|
-
|
|
55
|
+
This plugin is open source under the MIT License and doesn't need a license key.
|
|
@@ -8,13 +8,10 @@ description: Installation of the EventCatalog AsyncAPI 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 AsyncAPI plugin is used to generate a catalog from an AsyncAPI specification files.
|
|
19
16
|
|
|
20
17
|
You can map your AsyncAPI files to commands, events and queries in your catalog, and assign these to services and domains.
|
|
@@ -78,58 +75,11 @@ generators: [
|
|
|
78
75
|
|
|
79
76
|
```
|
|
80
77
|
|
|
81
|
-
###
|
|
82
|
-
|
|
83
|
-
The EventCatalog AsyncAPI plugin requires an EventCatalog Scale license key to work with EventCatalog.
|
|
84
|
-
|
|
85
|
-
You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
86
|
-
|
|
87
|
-
You have a few options for setting the license key:
|
|
88
|
-
|
|
89
|
-
1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
|
|
90
|
-
2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
|
|
91
|
-
|
|
92
|
-
#### 1. Setting license key in `.env` file (recommended) {#setting-license-key-in-env-file-recommended}
|
|
93
|
-
|
|
94
|
-
<AddedIn version="2.35.4" />
|
|
95
|
-
|
|
96
|
-
Create a `.env` file in the root of your project and add the following:
|
|
97
|
-
|
|
98
|
-
```bash title=".env"
|
|
99
|
-
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
:::tip Using an Older API Key?
|
|
78
|
+
### Licensing
|
|
103
79
|
|
|
104
|
-
|
|
80
|
+
The EventCatalog AsyncAPI plugin is open source under the MIT License and doesn't need a license key.
|
|
105
81
|
|
|
106
|
-
|
|
107
|
-
EVENTCATALOG_LICENSE_KEY_ASYNCAPI=your-license-key
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
:::
|
|
111
|
-
|
|
112
|
-
#### 2. Setting license key in eventcatalog.config.js {#setting-license-key-in-eventcatalogconfigjs}
|
|
113
|
-
|
|
114
|
-
If you prefer, you can set the license key in the `eventcatalog.config.js` file
|
|
115
|
-
using the `licenseKey` property in the EventCatalog AsyncAPI plugin.
|
|
116
|
-
|
|
117
|
-
```js title="eventcatalog.config.js"
|
|
118
|
-
export default {
|
|
119
|
-
generators: [
|
|
120
|
-
[
|
|
121
|
-
'@eventcatalog/generator-asyncapi',
|
|
122
|
-
{
|
|
123
|
-
licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
|
|
124
|
-
},
|
|
125
|
-
],
|
|
126
|
-
],
|
|
127
|
-
};
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
#### White listing EventCatalog domains
|
|
131
|
-
|
|
132
|
-
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.
|
|
82
|
+
If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
|
|
133
83
|
|
|
134
84
|
#### Run the plugin
|
|
135
85
|
|
|
@@ -151,4 +101,3 @@ npm run dev
|
|
|
151
101
|
|
|
152
102
|
If you get stuck, find an issue or need help, please raise an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues) or join our [Discord community](https://eventcatalog.dev/discord).
|
|
153
103
|
|
|
154
|
-
|
|
@@ -17,12 +17,13 @@ import TabItem from '@theme/TabItem';
|
|
|
17
17
|
|
|
18
18
|
The EventCatalog AsyncAPI plugin is configured in the `eventcatalog.config.js` file inside the `generators` array.
|
|
19
19
|
|
|
20
|
+
This plugin is open source under the MIT License and doesn't need a license key.
|
|
21
|
+
|
|
20
22
|
## Required Configuration Options
|
|
21
23
|
|
|
22
24
|
| Option | Type | Required | Description |
|
|
23
25
|
|--------|------|----------|-------------|
|
|
24
26
|
| `services` | `Service[]` | Yes | List of AsyncAPI files to add to your catalog |
|
|
25
|
-
| `licenseKey` | string | Yes* | EventCatalog Scale license key. Get a 30-day trial at [EventCatalog Cloud](https://eventcatalog.cloud). Can also be set via the `EVENTCATALOG_SCALE_LICENSE_KEY` environment variable. |
|
|
26
27
|
|
|
27
28
|
### Service Configuration
|
|
28
29
|
|
|
@@ -8,9 +8,6 @@ description: Getting started with AWS Glue Schema 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
|
-
|
|
13
|
-
<PluginLicense url="#commercial-use" />
|
|
14
11
|
|
|
15
12
|
<iframe width="100%" height="515" src="https://www.youtube.com/embed/cUQDdisz1wg?si=4Sj262A8N6iD8MTV" 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
|
|
|
@@ -66,39 +63,14 @@ The plugin supports all AWS Glue Schema Registry formats:
|
|
|
66
63
|
- **JSON Schema** - For JSON data validation and documentation
|
|
67
64
|
- **Protocol Buffers** - For language-neutral, platform-neutral serialization
|
|
68
65
|
|
|
66
|
+
### License
|
|
67
|
+
|
|
68
|
+
This plugin is open source under the MIT License and doesn't need a license key.
|
|
69
69
|
|
|
70
70
|
### See an example
|
|
71
71
|
|
|
72
72
|
If you would like to get started with our example project, [you can find it on GitHub](https://github.com/event-catalog/generators/tree/main/examples/generator-glue-registry/basic).
|
|
73
73
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
## Commercial and License
|
|
77
|
-
|
|
78
|
-
This plugin requires an EventCatalog Scale license key to be used.
|
|
79
|
-
|
|
80
|
-
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
81
|
-
|
|
82
|
-
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
83
|
-
|
|
84
|
-
See [pricing](/pricing) for more information.
|
|
85
|
-
|
|
86
|
-
_Have any questions? You can email us at `hello@eventcatalog.dev`._
|
|
87
|
-
|
|
88
|
-
## License FAQ
|
|
89
|
-
|
|
90
|
-
### What is the license key for?
|
|
91
|
-
The EventCatalog Scale license key is required to use the AWS Glue Schema Registry plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
92
|
-
|
|
93
|
-
### How do I get an EventCatalog Scale license key?
|
|
94
|
-
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.
|
|
95
|
-
|
|
96
|
-
### Terms
|
|
97
|
-
- **Trial Period**: 30-day free trial no credit card required
|
|
98
|
-
- **Support**: Discord community support (extra for priority support)
|
|
99
|
-
|
|
100
|
-
After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
101
|
-
|
|
102
74
|
## Issues
|
|
103
75
|
|
|
104
|
-
If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators
|
|
76
|
+
If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators
|
|
@@ -8,12 +8,9 @@ description: How to install the AWS Glue Schema 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 Tabs from '@theme/Tabs';
|
|
13
12
|
import TabItem from '@theme/TabItem';
|
|
14
13
|
|
|
15
|
-
<PluginLicense url="#commercial-use" />
|
|
16
|
-
|
|
17
14
|
## Installation
|
|
18
15
|
|
|
19
16
|
Install the plugin into your EventCatalog application:
|
|
@@ -22,7 +19,6 @@ Install the plugin into your EventCatalog application:
|
|
|
22
19
|
If you don't have an EventCatalog project yet, you can follow the instructions in the [Getting Started](/docs/development/getting-started/installation) guide.
|
|
23
20
|
:::
|
|
24
21
|
|
|
25
|
-
|
|
26
22
|
```bash
|
|
27
23
|
npm install @eventcatalog/generator-aws-glue
|
|
28
24
|
```
|
|
@@ -93,7 +89,6 @@ generators: [
|
|
|
93
89
|
// "myapp.orders" will be assigned to the inventory service. The inventory service will publish these schemas.
|
|
94
90
|
{ id: 'Inventory Service', version: '1.0.0', sends: [{ prefix: "myapp.orders"}], receives:[{ prefix: "UserCheckedOut"}] },
|
|
95
91
|
|
|
96
|
-
|
|
97
92
|
// This service sends schemas that match the SchemaName prefixing myapp, and will receive schemas that end with Payment
|
|
98
93
|
// this also does not map any schemas to your schemas
|
|
99
94
|
{ id: 'Payment Service', version: '1.0.0', sends: [{ prefix: "myapp"}], receives:[{ suffix: "Payment" }] }
|
|
@@ -166,56 +161,11 @@ generators: [
|
|
|
166
161
|
</TabItem>
|
|
167
162
|
</Tabs>
|
|
168
163
|
|
|
169
|
-
###
|
|
170
|
-
|
|
171
|
-
The EventCatalog AWS Glue Schema Registry plugin requires an EventCatalog Scale license key to work with EventCatalog.
|
|
172
|
-
|
|
173
|
-
You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
174
|
-
|
|
175
|
-
You have a few options for setting the license key:
|
|
176
|
-
|
|
177
|
-
1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
|
|
178
|
-
2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
|
|
179
|
-
|
|
180
|
-
#### 1. Setting license key in `.env` file (recommended) {#setting-license-key-in-env-file-recommended}
|
|
181
|
-
|
|
182
|
-
Create a `.env` file in the root of your project and add the following:
|
|
183
|
-
|
|
184
|
-
```bash title=".env"
|
|
185
|
-
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
:::tip Using an Older API Key?
|
|
189
|
-
|
|
190
|
-
If you already have an older AWS Glue Schema Registry plugin key, you can still use it with the plugin-specific environment variable.
|
|
191
|
-
|
|
192
|
-
```bash title=".env"
|
|
193
|
-
EVENTCATALOG_LICENSE_KEY_AWS_GLUE_SCHEMA_REGISTRY=your-license-key
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
:::
|
|
197
|
-
|
|
198
|
-
#### 2. Setting license key in eventcatalog.config.js {#setting-license-key-in-eventcatalogconfigjs}
|
|
199
|
-
|
|
200
|
-
If you prefer, you can set the license key in the `eventcatalog.config.js` file
|
|
201
|
-
using the `licenseKey` property in the EventCatalog AWS Glue Schema Registry plugin.
|
|
202
|
-
|
|
203
|
-
```js title="eventcatalog.config.js"
|
|
204
|
-
export default {
|
|
205
|
-
generators: [
|
|
206
|
-
[
|
|
207
|
-
'@eventcatalog/generator-aws-glue',
|
|
208
|
-
{
|
|
209
|
-
licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
|
|
210
|
-
},
|
|
211
|
-
],
|
|
212
|
-
],
|
|
213
|
-
};
|
|
214
|
-
```
|
|
164
|
+
### Licensing
|
|
215
165
|
|
|
216
|
-
|
|
166
|
+
The EventCatalog AWS Glue Schema Registry plugin is open source under the MIT License and doesn't need a license key.
|
|
217
167
|
|
|
218
|
-
If
|
|
168
|
+
If your config still sets `licenseKey` or an `EVENTCATALOG_LICENSE_KEY_*` variable, you can remove it; it's ignored.
|
|
219
169
|
|
|
220
170
|
## Required AWS Permissions
|
|
221
171
|
|
|
@@ -7,18 +7,12 @@ title: Introduction
|
|
|
7
7
|
description: Getting started with Azure Schema Registry plugin
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
<!-- import PluginLicense from '@site/src/components/MDX/PluginLicense'; -->
|
|
11
|
-
|
|
12
|
-
<!-- <PluginLicense url="#commercial-use" /> -->
|
|
13
|
-
|
|
14
10
|
---
|
|
15
11
|
|
|
16
|
-
|
|
17
12
|
The [EventCatalog Azure Schema Registry plugin](https://github.com/event-catalog/generators/tree/main/packages/generator-azure-schema-registry) allows you to import schemas from Azure Schema Registry into EventCatalog and keep them in sync alongside your documentation.
|
|
18
13
|
|
|
19
14
|
<iframe width="100%" height="515" src="https://www.youtube.com/embed/rNDa2JDyr_A?si=uFAbZbAiAxiy9dqJ" 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
15
|
|
|
21
|
-
|
|
22
16
|
:::info
|
|
23
17
|
**What is Azure Schema Registry?**: A schema registry for Azure Event Hubs. Use this to store and manage your schemas for event-driven applications. You can read more about it on the [Microsoft Learn website](https://learn.microsoft.com/en-us/azure/event-hubs/schema-registry-overview).
|
|
24
18
|
:::
|
|
@@ -53,6 +47,10 @@ EventCatalog supports [generators](/docs/plugins/generators). These are scripts
|
|
|
53
47
|
|
|
54
48
|
The EventCatalog Azure Schema Registry plugin is a generator. It will import your schemas from your Azure Schema Registry into EventCatalog.
|
|
55
49
|
|
|
50
|
+
### License
|
|
51
|
+
|
|
52
|
+
This plugin is open source under the MIT License and doesn't need a license key.
|
|
53
|
+
|
|
56
54
|
## Authentication
|
|
57
55
|
|
|
58
56
|
The plugin uses Azure's REST API with Bearer token authentication. You need to provide an Azure access token via the `AZURE_SCHEMA_REGISTRY_TOKEN` environment variable.
|
|
@@ -64,29 +62,3 @@ The schema registry SDK is limiting and doesn't allow you to fetch all schemas f
|
|
|
64
62
|
We use the REST API because it is simpler and more flexible. It doesn't require you to install any Azure SDK packages and works seamlessly across different environments without requiring any code changes.
|
|
65
63
|
|
|
66
64
|
:::
|
|
67
|
-
|
|
68
|
-
## Commercial and License
|
|
69
|
-
|
|
70
|
-
This plugin requires an EventCatalog Scale license key to be used.
|
|
71
|
-
|
|
72
|
-
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
73
|
-
|
|
74
|
-
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
75
|
-
|
|
76
|
-
See [pricing](/pricing) for more information.
|
|
77
|
-
|
|
78
|
-
_Have any questions? You can email us at `hello@eventcatalog.dev`._
|
|
79
|
-
|
|
80
|
-
## License FAQ
|
|
81
|
-
|
|
82
|
-
### What is the license key for?
|
|
83
|
-
The EventCatalog Scale license key is required to use the Azure Schema Registry plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
84
|
-
|
|
85
|
-
### How do I get an EventCatalog Scale license key?
|
|
86
|
-
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.
|
|
87
|
-
|
|
88
|
-
### Terms
|
|
89
|
-
- **Trial Period**: 30-day free trial no credit card required
|
|
90
|
-
- **Support**: Discord community support (extra for priority support)
|
|
91
|
-
|
|
92
|
-
After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
|