@eventcatalog/core 4.1.3 → 4.1.4

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.
Files changed (437) hide show
  1. package/dist/analytics/analytics.cjs +1 -1
  2. package/dist/analytics/analytics.js +2 -2
  3. package/dist/analytics/log-build.cjs +1 -1
  4. package/dist/analytics/log-build.js +3 -3
  5. package/dist/{chunk-TUKKXNQR.js → chunk-B3HQOT3D.js} +1 -1
  6. package/dist/{chunk-PDQER3NQ.js → chunk-CAYWT7E4.js} +1 -1
  7. package/dist/{chunk-DDGOJV25.js → chunk-RAB6LGHN.js} +1 -1
  8. package/dist/{chunk-G3D7IZ67.js → chunk-TCK7WEEE.js} +1 -1
  9. package/dist/{chunk-WEDJTUSQ.js → chunk-ZLQUICJD.js} +1 -1
  10. package/dist/constants.cjs +1 -1
  11. package/dist/constants.js +1 -1
  12. package/dist/docs/api/02-config.md +166 -14
  13. package/dist/docs/api/08-code-blocks.md +1 -1
  14. package/dist/docs/development/00-why-eventcatalog.md +29 -40
  15. package/dist/docs/development/01-fundamentals.md +58 -7
  16. package/dist/docs/development/01-getting-started/configuration-overview.md +1 -93
  17. package/dist/docs/development/01-getting-started/develop-and-build.md +4 -3
  18. package/dist/docs/development/01-getting-started/installation.md +3 -3
  19. package/dist/docs/development/01-getting-started/project-structure.md +74 -141
  20. package/dist/docs/development/ask-your-architecture/01-intro.md +8 -76
  21. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/01-what-is-eventcatalog-assistant.md +4 -3
  22. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/02-configuration.md +2 -1
  23. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/03-bring-your-own-tools.md +1 -3
  24. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/_category_.json +2 -2
  25. package/dist/docs/development/{developer-tools/llms.txt.md → ask-your-architecture/02-llms.txt.md} +1 -2
  26. package/dist/docs/development/ask-your-architecture/03-mcp-server/_category_.json +2 -2
  27. package/dist/docs/development/ask-your-architecture/03-mcp-server/getting-started.md +2 -2
  28. package/dist/docs/development/ask-your-architecture/03-mcp-server/introduction.md +2 -25
  29. package/dist/docs/development/{developer-tools/schemas.txt.md → ask-your-architecture/03-schemas.txt.md} +1 -2
  30. package/dist/docs/development/ask-your-architecture/04-agents/01-overview.md +27 -0
  31. package/dist/docs/development/ask-your-architecture/04-agents/02-code-to-docs.md +124 -0
  32. package/dist/docs/development/ask-your-architecture/04-agents/03-breaking-changes.md +170 -0
  33. package/dist/docs/development/ask-your-architecture/04-agents/_category_.json +12 -0
  34. package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/_category_.json +2 -2
  35. package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/03-installation.md +1 -1
  36. package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/_category_.json +2 -1
  37. package/dist/docs/development/ask-your-architecture/_category_.json +2 -2
  38. package/dist/docs/development/authentication/01-introduction.md +3 -3
  39. package/dist/docs/development/authentication/02-enabling-authentication.md +2 -2
  40. package/dist/docs/development/authentication/providers/03-setting-up-github.md +25 -1
  41. package/dist/docs/development/authentication/providers/03a-setting-up-google.md +0 -1
  42. package/dist/docs/development/bring-your-own-documentation/01-introduction.md +29 -25
  43. package/dist/docs/development/bring-your-own-documentation/custom-pages/01-introduction.md +9 -8
  44. package/dist/docs/development/bring-your-own-documentation/custom-pages/02-adding-custom-docs.md +70 -32
  45. package/dist/docs/development/bring-your-own-documentation/custom-pages/03-components.md +4 -1
  46. package/dist/docs/development/bring-your-own-documentation/custom-pages/04-owners.md +2 -1
  47. package/dist/docs/development/bring-your-own-documentation/custom-pages/_category_.json +1 -1
  48. package/dist/docs/development/bring-your-own-documentation/diagrams/01-introduction.md +56 -0
  49. package/dist/docs/development/bring-your-own-documentation/diagrams/02-creating-diagrams.md +262 -0
  50. package/dist/docs/development/{guides → bring-your-own-documentation}/diagrams/03-referencing-diagrams.md +3 -87
  51. package/dist/docs/development/bring-your-own-documentation/diagrams/05-comparing-diagrams.md +25 -0
  52. package/dist/docs/development/bring-your-own-documentation/diagrams/07-reference.md +144 -0
  53. package/dist/docs/development/{guides → bring-your-own-documentation}/diagrams/_category_.json +2 -1
  54. package/dist/docs/development/bring-your-own-documentation/resource-docs/01-introduction.md +2 -4
  55. package/dist/docs/development/bring-your-own-documentation/resource-docs/02-adding-resource-docs.md +138 -43
  56. package/dist/docs/development/bring-your-own-documentation/resource-docs/03-categories.md +38 -9
  57. package/dist/docs/development/bring-your-own-documentation/resource-docs/04-versioning.md +62 -13
  58. package/dist/docs/development/components/04-snippets.md +0 -2
  59. package/dist/docs/development/components/05-using-components.md +4 -16
  60. package/dist/docs/development/components/07-resource-references.md +1 -1
  61. package/dist/docs/development/components/_category_.json +3 -3
  62. package/dist/docs/development/components/components/01-accordian.md +1 -1
  63. package/dist/docs/development/components/components/03-admonitions.md +1 -1
  64. package/dist/docs/development/components/components/04-agent-tools.md +2 -2
  65. package/dist/docs/development/components/components/05-attachments.md +1 -1
  66. package/dist/docs/development/components/components/07-design.md +1 -2
  67. package/dist/docs/development/components/components/08-entitymap.md +2 -2
  68. package/dist/docs/development/components/components/09-flow.md +1 -1
  69. package/dist/docs/development/components/components/10-link.md +1 -1
  70. package/dist/docs/development/components/components/11-mermaid-file-loader.md +1 -1
  71. package/dist/docs/development/components/components/12-message-table.md +1 -1
  72. package/dist/docs/development/components/components/13-nodegraph.md +1 -1
  73. package/dist/docs/development/components/components/14-openapi.md +3 -3
  74. package/dist/docs/development/components/components/15-prompt.md +2 -6
  75. package/dist/docs/development/components/components/16-remote-schema.md +5 -3
  76. package/dist/docs/development/components/components/17-resource-group-table.md +1 -1
  77. package/dist/docs/development/components/components/18-resource-link.md +1 -1
  78. package/dist/docs/development/components/components/19-schema.md +1 -1
  79. package/dist/docs/development/components/components/20-schema-viewer.md +1 -1
  80. package/dist/docs/development/components/components/21-steps.md +1 -1
  81. package/dist/docs/development/components/components/22-tabs.md +1 -1
  82. package/dist/docs/development/components/components/23-tiles.md +1 -1
  83. package/dist/docs/development/components/components/24-visibility.md +1 -1
  84. package/dist/docs/development/components/components/_category_.json +1 -1
  85. package/dist/docs/development/components/custom-components/01-introduction.md +74 -0
  86. package/dist/docs/development/components/custom-components/02-create-your-first-component.md +71 -0
  87. package/dist/docs/development/components/custom-components/03-pass-data-into-components.md +86 -0
  88. package/dist/docs/development/components/custom-components/04-fetch-data-in-components.md +191 -0
  89. package/dist/docs/development/components/custom-components/05-style-components.md +60 -0
  90. package/dist/docs/development/components/custom-components/06-add-client-side-scripts.md +67 -0
  91. package/dist/docs/development/components/custom-components/07-reference.md +115 -0
  92. package/dist/docs/development/components/custom-components/_category_.json +11 -0
  93. package/dist/docs/development/components/{external-diagram-embeds/03-drawio.md → diagram-syntax/01-drawio.md} +2 -3
  94. package/dist/docs/development/components/{external-diagram-embeds/04-figjam.md → diagram-syntax/02-figjam.md} +1 -2
  95. package/dist/docs/development/components/diagram-syntax/{04-icepanel.md → 03-icepanel.md} +1 -2
  96. package/dist/docs/development/components/diagram-syntax/04-likec4.md +136 -0
  97. package/dist/docs/development/components/{external-diagram-embeds/02-lucid.md → diagram-syntax/05-lucid.md} +2 -3
  98. package/dist/docs/development/components/diagram-syntax/{01-mermaid.md → 06-mermaid.md} +1 -1
  99. package/dist/docs/development/components/{external-diagram-embeds/01-miro.md → diagram-syntax/07-miro.md} +2 -3
  100. package/dist/docs/development/components/diagram-syntax/{02-plantuml.md → 08-plantuml.md} +3 -3
  101. package/dist/docs/development/components/diagram-syntax/{03-structurizr.md → 09-structurizr.md} +1 -1
  102. package/dist/docs/development/components/diagram-syntax/_category_.json +3 -3
  103. package/dist/docs/development/customization/01-customize-landing-page.md +7 -15
  104. package/dist/docs/development/customization/02-themes.md +1 -0
  105. package/dist/docs/development/customization/03-application-sidebar.md +246 -0
  106. package/dist/docs/development/customization/03-search.md +2 -2
  107. package/dist/docs/development/customization/{customize-sidebars/01-documentation-sidebar.md → 04-documentation-sidebar.md} +4 -4
  108. package/dist/docs/development/customization/05-custom-pages-and-api-routes/01-introduction.md +94 -0
  109. package/dist/docs/development/customization/05-custom-pages-and-api-routes/02-create-a-custom-page.md +177 -0
  110. package/dist/docs/development/customization/05-custom-pages-and-api-routes/03-create-an-api-route.md +128 -0
  111. package/dist/docs/development/customization/05-custom-pages-and-api-routes/04-reference.md +138 -0
  112. package/dist/docs/development/customization/05-custom-pages-and-api-routes/_category_.json +12 -0
  113. package/dist/docs/development/customization/06-customize-tables.md +3 -3
  114. package/dist/docs/development/customization/07-resource-icons.md +190 -0
  115. package/dist/docs/development/customization/_category_.json +1 -1
  116. package/dist/docs/development/customization/customize-visualizer/_category_.json +2 -2
  117. package/dist/docs/development/deployment/hosting-options.md +1 -2
  118. package/dist/docs/development/developer-tools/api-catalog.md +1 -1
  119. package/dist/docs/development/developer-tools/eventcatalog-linter.md +137 -2
  120. package/dist/docs/development/governance/_category_.json +1 -0
  121. package/dist/docs/development/governance/architecture-change-detection/01-introduction.md +2 -2
  122. package/dist/docs/development/guides/98-versioning-resources.md +192 -0
  123. package/dist/docs/development/guides/99-adding-analytics.md +0 -1
  124. package/dist/docs/development/guides/changelogs/02-adding-changelogs.md +2 -2
  125. package/dist/docs/development/guides/changelogs/03-automated-changelogs.md +2 -2
  126. package/dist/docs/development/guides/changelogs/04-reference.md +77 -0
  127. package/dist/docs/development/guides/changelogs/_category_.json +2 -2
  128. package/dist/docs/development/guides/domains/01-introduction.md +14 -9
  129. package/dist/docs/development/guides/domains/{02-creating-domains/02-adding-domains.md → 02-create-domain.md} +32 -16
  130. package/dist/docs/development/guides/domains/{02-creating-domains/02a-subdomains.md → 03-model-subdomains.md} +22 -10
  131. package/dist/docs/development/guides/domains/03-ownership-and-language/01-owners.md +1 -1
  132. package/dist/docs/development/guides/domains/03-ownership-and-language/02-adding-ubiquitous-language.md +2 -6
  133. package/dist/docs/development/guides/domains/03-ownership-and-language/_category_.json +2 -2
  134. package/dist/docs/development/guides/domains/04-add-resources-to-domains/01-add-systems-to-domains.md +154 -0
  135. package/dist/docs/development/guides/domains/{02-creating-domains/03-adding-services-to-domains.md → 04-add-resources-to-domains/02-add-services-to-domains.md} +6 -37
  136. package/dist/docs/development/guides/domains/{02-creating-domains/04-adding-messages-to-domains.md → 04-add-resources-to-domains/03-add-messages-to-domains.md} +4 -6
  137. package/dist/docs/development/guides/domains/{02-creating-domains/05-adding-data-products-to-domains.md → 04-add-resources-to-domains/04-add-data-products-to-domains.md} +6 -5
  138. package/dist/docs/development/guides/domains/04-add-resources-to-domains/05-add-entities-to-domains.md +115 -0
  139. package/dist/docs/development/guides/domains/04-add-resources-to-domains/_category_.json +11 -0
  140. package/dist/docs/development/guides/domains/{08-domain-integration-map.md → 06-visualize-domains/01-domain-integration-map.md} +5 -6
  141. package/dist/docs/development/guides/domains/06-visualize-domains/_category_.json +12 -0
  142. package/dist/docs/development/guides/domains/{04-versioning-and-changelogs/01-versioning.md → 07-version-domains.md} +5 -6
  143. package/dist/docs/development/guides/domains/{04-versioning-and-changelogs/02-changelog.md → 08-add-changelog.md} +6 -7
  144. package/dist/docs/development/guides/domains/09-reference.md +517 -0
  145. package/dist/docs/development/guides/owners/01-what-are-teams-and-users.md +46 -0
  146. package/dist/docs/development/guides/owners/02-create-team.md +110 -0
  147. package/dist/docs/development/guides/owners/03-create-user.md +99 -0
  148. package/dist/docs/development/guides/owners/05-teams-reference.md +144 -0
  149. package/dist/docs/development/guides/owners/06-users-reference.md +128 -0
  150. package/dist/docs/development/guides/owners/_category_.json +2 -2
  151. package/dist/docs/development/guides/owners/automated-teams-and-users/_category_.json +11 -0
  152. package/dist/docs/development/guides/owners/automated-teams-and-users/create-your-own-connector.md +108 -0
  153. package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-github.md +156 -0
  154. package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-microsoft-entra.md +253 -0
  155. package/dist/docs/development/guides/resources/_category_.json +11 -0
  156. package/dist/docs/development/guides/resources/adrs/01-introduction.md +37 -0
  157. package/dist/docs/development/guides/resources/adrs/02-creating-adrs.md +211 -0
  158. package/dist/docs/development/guides/resources/adrs/03-linking-resources.md +52 -0
  159. package/dist/docs/development/guides/resources/adrs/04-relationships.md +80 -0
  160. package/dist/docs/development/guides/resources/adrs/06-reference.md +247 -0
  161. package/dist/docs/development/guides/resources/adrs/_category_.json +11 -0
  162. package/dist/docs/development/guides/{agents → resources/agents}/01-introduction.md +1 -16
  163. package/dist/docs/development/guides/resources/agents/02-create-agent.md +188 -0
  164. package/dist/docs/development/guides/{agents → resources/agents}/03-adding-tools.md +3 -4
  165. package/dist/docs/development/guides/{agents → resources/agents}/04-model-metadata.md +2 -2
  166. package/dist/docs/development/guides/{agents/adding-to-agents/01-messages.md → resources/agents/05-add-messages-to-agents.md} +5 -4
  167. package/dist/docs/development/guides/{agents/adding-to-agents/02-datastores.md → resources/agents/06-add-data-stores-to-agents.md} +4 -15
  168. package/dist/docs/development/guides/resources/agents/11-reference.md +238 -0
  169. package/dist/docs/development/guides/{agents → resources/agents}/_category_.json +2 -2
  170. package/dist/docs/development/guides/resources/data/01-introduction.md +15 -0
  171. package/dist/docs/development/guides/resources/data/02-adding-data.md +184 -0
  172. package/dist/docs/development/guides/resources/data/03-add-read-write-relationships.md +128 -0
  173. package/dist/docs/development/guides/resources/data/04-reference.md +211 -0
  174. package/dist/docs/development/guides/{data → resources/data}/_category_.json +3 -3
  175. package/dist/docs/development/guides/{data-products → resources/data-products}/01-introduction.md +1 -17
  176. package/dist/docs/development/guides/resources/data-products/02-adding-data-products.md +174 -0
  177. package/dist/docs/development/guides/{data-products → resources/data-products}/03-inputs-and-outputs.md +4 -6
  178. package/dist/docs/development/guides/{data-products → resources/data-products}/04-contracts.md +2 -4
  179. package/dist/docs/development/guides/resources/data-products/07-reference.md +201 -0
  180. package/dist/docs/development/guides/{data-products → resources/data-products}/_category_.json +3 -3
  181. package/dist/docs/development/guides/resources/entities/01-introduction.md +26 -0
  182. package/dist/docs/development/guides/resources/entities/02-create-entity.md +162 -0
  183. package/dist/docs/development/guides/resources/entities/03-model-entity-relationships.md +115 -0
  184. package/dist/docs/development/guides/resources/entities/04-add-entities-to-resources.md +188 -0
  185. package/dist/docs/development/guides/resources/entities/05-entity-maps.md +48 -0
  186. package/dist/docs/development/guides/resources/entities/06-reference.md +273 -0
  187. package/dist/docs/development/guides/{domains/05-entities → resources/entities}/_category_.json +4 -4
  188. package/dist/docs/development/guides/resources/flows/01-introduction.md +28 -0
  189. package/dist/docs/development/guides/resources/flows/02-create-flow.md +304 -0
  190. package/dist/docs/development/guides/{flows/03-flow-nodes.md → resources/flows/03-model-flow-steps.md} +6 -6
  191. package/dist/docs/development/guides/resources/flows/04-add-flows-to-resources.md +149 -0
  192. package/dist/docs/development/guides/resources/flows/06-reference.md +226 -0
  193. package/dist/docs/development/guides/{flows → resources/flows}/_category_.json +3 -3
  194. package/dist/docs/development/guides/resources/messages/01-what-are-messages.md +104 -0
  195. package/dist/docs/development/guides/{messages/events/01-introduction.md → resources/messages/02-message-types/01-events.md} +3 -7
  196. package/dist/docs/development/guides/{messages/commands/01-introduction.md → resources/messages/02-message-types/02-commands.md} +4 -7
  197. package/dist/docs/development/guides/resources/messages/02-message-types/03-queries.md +20 -0
  198. package/dist/docs/development/guides/resources/messages/02-message-types/_category_.json +11 -0
  199. package/dist/docs/development/guides/resources/messages/03-create-messages/01-create-event.md +137 -0
  200. package/dist/docs/development/guides/resources/messages/03-create-messages/02-create-command.md +156 -0
  201. package/dist/docs/development/guides/resources/messages/03-create-messages/03-create-query.md +158 -0
  202. package/dist/docs/development/guides/{messages/common/02-draft-messages.md → resources/messages/03-create-messages/04-create-draft-message.md} +5 -7
  203. package/dist/docs/development/guides/resources/messages/03-create-messages/_category_.json +11 -0
  204. package/dist/docs/development/guides/resources/messages/04-connect-messages/01-map-producers-and-consumers.md +32 -0
  205. package/dist/docs/development/guides/resources/messages/04-connect-messages/02-shared-messages-across-boundaries.md +170 -0
  206. package/dist/docs/development/guides/{messages/common/09-grouping-messages.md → resources/messages/04-connect-messages/03-group-messages.md} +2 -4
  207. package/dist/docs/development/guides/resources/messages/04-connect-messages/_category_.json +11 -0
  208. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/01-introduction.md +4 -28
  209. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/02-adding-channels.md +77 -62
  210. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/04-adding-messages-to-services.md +10 -14
  211. package/dist/docs/development/guides/resources/messages/04-message-channels/05-reference.md +177 -0
  212. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/_category_.json +3 -3
  213. package/dist/docs/development/guides/{messages/common/04-versioning.md → resources/messages/08-versioning-and-lifecycle/01-version-messages.md} +39 -4
  214. package/dist/docs/development/guides/{messages/common/05-changelog.md → resources/messages/08-versioning-and-lifecycle/02-add-changelog.md} +5 -6
  215. package/dist/docs/development/guides/{messages/common/02-deprecating.md → resources/messages/08-versioning-and-lifecycle/03-deprecate-messages.md} +4 -4
  216. package/dist/docs/development/guides/resources/messages/08-versioning-and-lifecycle/_category_.json +11 -0
  217. package/dist/docs/development/guides/{messages/common/02-examples.md → resources/messages/09-add-usage-examples.md} +59 -22
  218. package/dist/docs/development/guides/resources/messages/10-reference.md +439 -0
  219. package/dist/docs/development/guides/resources/messages/_category_.json +11 -0
  220. package/dist/docs/development/guides/resources/schemas/01-what-are-schemas-and-specifications.md +25 -0
  221. package/dist/docs/development/guides/resources/schemas/02-add-schemas-to-messages.md +63 -0
  222. package/dist/docs/development/guides/resources/schemas/03-add-schemas-to-data-stores.md +90 -0
  223. package/dist/docs/development/guides/{services/adding-to-services/04-openapi.md → resources/schemas/03-add-specifications-to-services/01-add-openapi-specifications.md} +33 -24
  224. package/dist/docs/development/guides/{services/adding-to-services/05-asyncapi.md → resources/schemas/03-add-specifications-to-services/02-add-asyncapi-specifications.md} +33 -23
  225. package/dist/docs/development/guides/{services/adding-to-services/06-graphql.md → resources/schemas/03-add-specifications-to-services/03-add-graphql-schemas.md} +36 -26
  226. package/dist/docs/development/guides/resources/schemas/03-add-specifications-to-services/_category_.json +11 -0
  227. package/dist/docs/development/guides/{schemas/02-schema-explorer.md → resources/schemas/04-explore-schemas/01-schema-explorer.md} +3 -26
  228. package/dist/docs/development/guides/{schemas/06-fields-explorer.md → resources/schemas/04-explore-schemas/02-fields-explorer.md} +8 -10
  229. package/dist/docs/development/guides/{schemas/05-field-usage.md → resources/schemas/04-explore-schemas/03-consumer-field-usage.md} +1 -3
  230. package/dist/docs/development/guides/resources/schemas/04-explore-schemas/_category_.json +11 -0
  231. package/dist/docs/development/guides/{schemas/03-schema-api.md → resources/schemas/05-schema-api.md} +6 -11
  232. package/dist/docs/development/guides/{schemas/04-schema-mcp.md → resources/schemas/06-schema-mcp.md} +5 -6
  233. package/dist/docs/development/guides/resources/schemas/07-reference.md +23 -0
  234. package/dist/docs/development/guides/{schemas → resources/schemas}/_category_.json +3 -3
  235. package/dist/docs/development/guides/resources/services/01-introduction.md +27 -0
  236. package/dist/docs/development/guides/resources/services/02-create-service.md +195 -0
  237. package/dist/docs/development/guides/resources/services/03-create-external-service.md +52 -0
  238. package/dist/docs/development/guides/resources/services/04-add-resources-to-services/01-add-messages-to-services.md +142 -0
  239. package/dist/docs/development/guides/resources/services/04-add-resources-to-services/02-add-data-stores-to-services.md +45 -0
  240. package/dist/docs/development/guides/{services/adding-to-services/03-entities.md → resources/services/04-add-resources-to-services/03-add-entities-to-services.md} +7 -11
  241. package/dist/docs/development/guides/resources/services/04-add-resources-to-services/_category_.json +11 -0
  242. package/dist/docs/development/guides/{services/ownership-and-components/01-owners.md → resources/services/06-ownership-and-components/01-add-service-owners.md} +3 -4
  243. package/dist/docs/development/guides/{services/ownership-and-components/02-components.md → resources/services/06-ownership-and-components/02-use-components.md} +4 -4
  244. package/dist/docs/development/guides/resources/services/06-ownership-and-components/_category_.json +11 -0
  245. package/dist/docs/development/guides/{services/versioning-and-lifecycle/01-versioning.md → resources/services/07-versioning-and-lifecycle/01-version-services.md} +4 -3
  246. package/dist/docs/development/guides/{services/versioning-and-lifecycle/02-changelog.md → resources/services/07-versioning-and-lifecycle/02-add-changelog.md} +5 -5
  247. package/dist/docs/development/guides/{services/versioning-and-lifecycle/03-deprecating.md → resources/services/07-versioning-and-lifecycle/03-deprecate-services.md} +5 -4
  248. package/dist/docs/development/guides/resources/services/07-versioning-and-lifecycle/_category_.json +11 -0
  249. package/dist/docs/development/guides/resources/services/08-reference.md +295 -0
  250. package/dist/docs/development/guides/{services → resources/services}/_category_.json +3 -3
  251. package/dist/docs/development/guides/systems/01-introduction.md +119 -0
  252. package/dist/docs/development/guides/systems/02-create-system.md +127 -0
  253. package/dist/docs/development/guides/systems/03-add-resources-to-systems.md +157 -0
  254. package/dist/docs/development/guides/systems/04-model-relationships-and-actors.md +86 -0
  255. package/dist/docs/development/guides/systems/05-system-context-maps.md +67 -0
  256. package/dist/docs/development/guides/systems/06-reference.md +329 -0
  257. package/dist/docs/development/guides/{messages/queries → systems}/_category_.json +5 -5
  258. package/dist/docs/development/license-keys/_category_.json +1 -1
  259. package/dist/docs/development/license-keys/integrations.md +20 -9
  260. package/dist/docs/development/license-keys/overview.md +7 -18
  261. package/dist/docs/development/license-keys/plans.md +9 -18
  262. package/dist/docs/development/upgrading/v2.md +1 -2
  263. package/dist/docs/development/upgrading/v3.md +2 -3
  264. package/dist/docs/development/upgrading/v4.md +377 -0
  265. package/dist/docs/editor/00-overview.md +3 -3
  266. package/dist/docs/editor/01-first-edit.md +1 -1
  267. package/dist/docs/editor/explanation/markdown-mdx-git.md +1 -1
  268. package/dist/docs/editor/how-to/add-schemas-and-specifications.md +5 -5
  269. package/dist/docs/editor/how-to/edit-resource.md +1 -1
  270. package/dist/docs/editor/how-to/use-flow-editor.md +5 -5
  271. package/dist/docs/editor/how-to/use-slash-commands.md +2 -2
  272. package/dist/docs/editor/reference/supported-content.md +2 -2
  273. package/dist/docs/editor/reference/supported-resources.md +14 -14
  274. package/dist/docs/plugins/amazon-apigateway/00-intro.md +8 -8
  275. package/dist/docs/plugins/amazon-apigateway/01-installation.md +10 -12
  276. package/dist/docs/plugins/amazon-apigateway/02-plugin-configuration.md +5 -4
  277. package/dist/docs/plugins/apicurio/00-intro.md +8 -8
  278. package/dist/docs/plugins/apicurio/01-installation.md +12 -2
  279. package/dist/docs/plugins/apicurio/02-plugin-configuration.md +7 -9
  280. package/dist/docs/plugins/apicurio/03-features.md +2 -2
  281. package/dist/docs/plugins/asyncapi/00-intro.md +8 -8
  282. package/dist/docs/plugins/asyncapi/01-installation.md +10 -11
  283. package/dist/docs/plugins/asyncapi/02-plugin-configuration.md +5 -5
  284. package/dist/docs/plugins/asyncapi/03-features.md +9 -9
  285. package/dist/docs/plugins/aws-glue-registry/00-intro.md +8 -8
  286. package/dist/docs/plugins/aws-glue-registry/00a-installation.md +16 -6
  287. package/dist/docs/plugins/aws-glue-registry/01-features.md +2 -2
  288. package/dist/docs/plugins/azure-schema-registry/00-intro.md +10 -10
  289. package/dist/docs/plugins/azure-schema-registry/01-installation.md +15 -5
  290. package/dist/docs/plugins/azure-schema-registry/02-plugin-configuration.md +4 -4
  291. package/dist/docs/plugins/azure-schema-registry/04-examples.md +1 -1
  292. package/dist/docs/plugins/backstage/00-intro.md +3 -3
  293. package/dist/docs/plugins/backstage/01-installation.md +7 -15
  294. package/dist/docs/plugins/confluent-schema-registry/00-intro.md +8 -8
  295. package/dist/docs/plugins/confluent-schema-registry/01-installation.md +12 -4
  296. package/dist/docs/plugins/confluent-schema-registry/02-plugin-configuration.md +3 -3
  297. package/dist/docs/plugins/eventbridge/00a-installation.md +21 -21
  298. package/dist/docs/plugins/eventbridge/01-features.md +3 -3
  299. package/dist/docs/plugins/eventbridge/03-api.md +5 -5
  300. package/dist/docs/plugins/eventcatalog-federation/00-introduction.md +6 -6
  301. package/dist/docs/plugins/eventcatalog-federation/01-installation.md +10 -11
  302. package/dist/docs/plugins/eventcatalog-federation/04-configuration.md +2 -2
  303. package/dist/docs/plugins/eventcatalog-federation/05-setup-team-catalog.md +5 -6
  304. package/dist/docs/plugins/github/00-intro.md +8 -8
  305. package/dist/docs/plugins/github/01-installation.md +12 -5
  306. package/dist/docs/plugins/graphql/00-intro.md +8 -8
  307. package/dist/docs/plugins/graphql/01-installation.md +11 -11
  308. package/dist/docs/plugins/graphql/02-plugin-configuration.md +3 -4
  309. package/dist/docs/plugins/graphql/03-features.md +4 -4
  310. package/dist/docs/plugins/openapi/00-intro.md +8 -8
  311. package/dist/docs/plugins/openapi/01-installation.md +10 -11
  312. package/dist/docs/plugins/openapi/02-plugin-configuration.md +7 -6
  313. package/dist/docs/plugins/openapi/03-features.md +6 -7
  314. package/dist/docs/tutorial/01-start-here.md +75 -0
  315. package/dist/docs/tutorial/02-install-eventcatalog.md +98 -0
  316. package/dist/docs/tutorial/04-add-ownership.md +184 -0
  317. package/dist/docs/tutorial/04-create-event.md +176 -0
  318. package/dist/docs/tutorial/05-create-a-domain.md +133 -0
  319. package/dist/docs/tutorial/05-publish-event.md +82 -0
  320. package/dist/docs/tutorial/06-consume-event.md +130 -0
  321. package/dist/docs/tutorial/06-create-a-service.md +99 -0
  322. package/dist/docs/tutorial/11-visualize-your-catalog.md +105 -0
  323. package/dist/docs/tutorial/12-build-your-catalog.md +79 -0
  324. package/dist/docs/tutorial/14-next-steps.md +108 -0
  325. package/dist/docs/tutorial/_category_.json +12 -0
  326. package/dist/eventcatalog.cjs +1 -1
  327. package/dist/eventcatalog.js +5 -5
  328. package/dist/generate.cjs +1 -1
  329. package/dist/generate.js +3 -3
  330. package/dist/utils/cli-logger.cjs +1 -1
  331. package/dist/utils/cli-logger.js +2 -2
  332. package/eventcatalog/src/layouts/VerticalSideBarLayout.astro +4 -1
  333. package/eventcatalog/src/toolkit/layouts/Layout.astro +7 -1
  334. package/package.json +3 -3
  335. package/dist/docs/api/03-domain-api.md +0 -440
  336. package/dist/docs/api/04-service-api.md +0 -414
  337. package/dist/docs/api/05-command-api.md +0 -365
  338. package/dist/docs/api/06-event-api.md +0 -364
  339. package/dist/docs/api/06-query-api.md +0 -362
  340. package/dist/docs/api/08-channel-api.md +0 -363
  341. package/dist/docs/api/09-flow-api.md +0 -446
  342. package/dist/docs/api/10-entity-api.md +0 -330
  343. package/dist/docs/api/11-data-api.md +0 -273
  344. package/dist/docs/api/12-data-product-api.md +0 -445
  345. package/dist/docs/development/components/external-diagram-embeds/05-icepanel.md +0 -68
  346. package/dist/docs/development/components/external-diagram-embeds/_category_.json +0 -12
  347. package/dist/docs/development/customization/custom-components/00-what-is-mdx.md +0 -73
  348. package/dist/docs/development/customization/custom-components/01-introduction.md +0 -28
  349. package/dist/docs/development/customization/custom-components/02-adding-components.md +0 -145
  350. package/dist/docs/development/customization/custom-components/03-component-styling.md +0 -27
  351. package/dist/docs/development/customization/custom-components/04-javascript-components.md +0 -32
  352. package/dist/docs/development/customization/custom-components/_category_.json +0 -11
  353. package/dist/docs/development/customization/customize-sidebars/00-application-sidebar.md +0 -85
  354. package/dist/docs/development/customization/customize-sidebars/_category_.json +0 -11
  355. package/dist/docs/development/developer-tools/github-action.md +0 -147
  356. package/dist/docs/development/guides/12-customize-your-sidebar.md +0 -12
  357. package/dist/docs/development/guides/agents/02-adding-agents.md +0 -152
  358. package/dist/docs/development/guides/agents/adding-to-agents/_category_.json +0 -10
  359. package/dist/docs/development/guides/agents/ownership/01-owners.md +0 -67
  360. package/dist/docs/development/guides/agents/ownership/_category_.json +0 -11
  361. package/dist/docs/development/guides/agents/versioning-and-lifecycle/01-versioning.md +0 -48
  362. package/dist/docs/development/guides/agents/versioning-and-lifecycle/02-changelog.md +0 -40
  363. package/dist/docs/development/guides/agents/versioning-and-lifecycle/03-deprecating.md +0 -41
  364. package/dist/docs/development/guides/agents/versioning-and-lifecycle/_category_.json +0 -11
  365. package/dist/docs/development/guides/channels/ownership-and-components/01-owners.md +0 -44
  366. package/dist/docs/development/guides/channels/ownership-and-components/02-components.md +0 -16
  367. package/dist/docs/development/guides/channels/ownership-and-components/_category_.json +0 -11
  368. package/dist/docs/development/guides/channels/versioning-and-lifecycle/01-versioning.md +0 -31
  369. package/dist/docs/development/guides/channels/versioning-and-lifecycle/02-changelog.md +0 -56
  370. package/dist/docs/development/guides/channels/versioning-and-lifecycle/_category_.json +0 -11
  371. package/dist/docs/development/guides/data/01-introduction.md +0 -34
  372. package/dist/docs/development/guides/data/02-adding-data.md +0 -86
  373. package/dist/docs/development/guides/data/03a-adding-schemas-to-data-stores.md +0 -73
  374. package/dist/docs/development/guides/data/ownership-and-components/01-owners.md +0 -45
  375. package/dist/docs/development/guides/data/ownership-and-components/02-components.md +0 -17
  376. package/dist/docs/development/guides/data/ownership-and-components/_category_.json +0 -11
  377. package/dist/docs/development/guides/data/versioning-and-lifecycle/01-versioning.md +0 -32
  378. package/dist/docs/development/guides/data/versioning-and-lifecycle/02-changelog.md +0 -57
  379. package/dist/docs/development/guides/data/versioning-and-lifecycle/03-deprecating.md +0 -71
  380. package/dist/docs/development/guides/data/versioning-and-lifecycle/_category_.json +0 -11
  381. package/dist/docs/development/guides/data-products/02-adding-data-products.md +0 -157
  382. package/dist/docs/development/guides/data-products/05-versioning.md +0 -240
  383. package/dist/docs/development/guides/data-products/06-adding-to-domains.md +0 -52
  384. package/dist/docs/development/guides/diagrams/01-introduction.md +0 -78
  385. package/dist/docs/development/guides/diagrams/02-creating-diagrams.md +0 -195
  386. package/dist/docs/development/guides/diagrams/04-versioning-diagrams.md +0 -204
  387. package/dist/docs/development/guides/diagrams/05-comparing-diagrams.md +0 -145
  388. package/dist/docs/development/guides/diagrams/06-diagrams-with-llms.md +0 -165
  389. package/dist/docs/development/guides/domains/02-creating-domains/_category_.json +0 -11
  390. package/dist/docs/development/guides/domains/04-versioning-and-changelogs/_category_.json +0 -10
  391. package/dist/docs/development/guides/domains/05-entities/01-introduction.md +0 -24
  392. package/dist/docs/development/guides/domains/05-entities/02-adding-entities.md +0 -157
  393. package/dist/docs/development/guides/domains/05-entities/03-adding-entities-to-domains.md +0 -30
  394. package/dist/docs/development/guides/domains/05-entities/04-domain-entity-map.md +0 -134
  395. package/dist/docs/development/guides/flows/01-introduction.md +0 -36
  396. package/dist/docs/development/guides/flows/02-adding-flows.md +0 -198
  397. package/dist/docs/development/guides/flows/04-adding-flows-to-services.md +0 -42
  398. package/dist/docs/development/guides/flows/05-adding-flows-to-domains.md +0 -43
  399. package/dist/docs/development/guides/flows/06-versioning.md +0 -27
  400. package/dist/docs/development/guides/flows/07-create-flow-with-ai.md +0 -171
  401. package/dist/docs/development/guides/messages/01-overview.md +0 -57
  402. package/dist/docs/development/guides/messages/_category_.json +0 -11
  403. package/dist/docs/development/guides/messages/commands/02-adding-commands.md +0 -131
  404. package/dist/docs/development/guides/messages/commands/_category_.json +0 -11
  405. package/dist/docs/development/guides/messages/common/01-map-to-producers-and-consumers.md +0 -37
  406. package/dist/docs/development/guides/messages/common/02-adding-schemas.md +0 -58
  407. package/dist/docs/development/guides/messages/common/03-owners.md +0 -40
  408. package/dist/docs/development/guides/messages/common/07-components.md +0 -12
  409. package/dist/docs/development/guides/messages/common/08-shared-messages-across-boundaries.md +0 -70
  410. package/dist/docs/development/guides/messages/common/_category_.json +0 -11
  411. package/dist/docs/development/guides/messages/events/02-adding-events.md +0 -130
  412. package/dist/docs/development/guides/messages/events/_category_.json +0 -11
  413. package/dist/docs/development/guides/messages/queries/01-introduction.md +0 -25
  414. package/dist/docs/development/guides/messages/queries/02-adding-queries.md +0 -130
  415. package/dist/docs/development/guides/owners/teams/01-introduction.md +0 -21
  416. package/dist/docs/development/guides/owners/teams/02-adding-teams.md +0 -73
  417. package/dist/docs/development/guides/owners/teams/_category_.json +0 -11
  418. package/dist/docs/development/guides/owners/users/01-introduction.md +0 -20
  419. package/dist/docs/development/guides/owners/users/02-adding-users.md +0 -69
  420. package/dist/docs/development/guides/owners/users/_category_.json +0 -11
  421. package/dist/docs/development/guides/schemas/01-introduction.md +0 -64
  422. package/dist/docs/development/guides/services/01-introduction.md +0 -33
  423. package/dist/docs/development/guides/services/02-adding-services.md +0 -113
  424. package/dist/docs/development/guides/services/03-creating-external-systems.md +0 -71
  425. package/dist/docs/development/guides/services/adding-to-services/01-messages.md +0 -229
  426. package/dist/docs/development/guides/services/adding-to-services/02-datastores.md +0 -77
  427. package/dist/docs/development/guides/services/adding-to-services/_category_.json +0 -10
  428. package/dist/docs/development/guides/services/ownership-and-components/_category_.json +0 -11
  429. package/dist/docs/development/guides/services/versioning-and-lifecycle/_category_.json +0 -11
  430. /package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/01-introduction.md +0 -0
  431. /package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/02-installation.md +0 -0
  432. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/01-introduction.md +0 -0
  433. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/02-slack-app-setup.md +0 -0
  434. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/04-deployment.md +0 -0
  435. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/05-usage.md +0 -0
  436. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/06-troubleshooting.md +0 -0
  437. /package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/09-configuration +0 -0
@@ -127,36 +127,35 @@ export default {
127
127
 
128
128
  The API Gateway and OpenAPI plugin both require a license key to work with EventCatalog.
129
129
 
130
- You can get a trial license key from [EventCatalog Cloud](https://eventcatalog.cloud).
130
+ You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
131
131
 
132
132
  You have a few options for setting the license key:
133
133
 
134
134
  1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
135
135
  2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
136
136
 
137
- #### 1. Setting license key in `.env` file (recommended)
137
+ #### 1. Setting license key in `.env` file (recommended) {#setting-license-key-in-env-file-recommended}
138
138
 
139
139
  <AddedIn version="2.35.4" />
140
140
 
141
141
  Create a `.env` file in the root of your project and add the following:
142
142
 
143
143
  ```bash title=".env"
144
- EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY=your-license-key
145
- EVENTCATALOG_LICENSE_KEY_OPENAPI=your-license-key
144
+ EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
146
145
  ```
147
146
 
148
- :::tip Using an older version of EventCatalog?
147
+ :::tip Using an Older API Key?
149
148
 
150
- If you are using an older version of EventCatalog that does not support the `.env` file, you can just export the license key as an environment variable.
149
+ If you already have older Amazon API Gateway and OpenAPI plugin keys, you can still use them with the plugin-specific environment variables.
151
150
 
152
- ```bash title="Setting license key in environment variables"
153
- export EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY=your-license-key
154
- export EVENTCATALOG_LICENSE_KEY_OPENAPI=your-license-key
151
+ ```bash title=".env"
152
+ EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY=your-license-key
153
+ EVENTCATALOG_LICENSE_KEY_OPENAPI=your-license-key
155
154
  ```
156
155
 
157
156
  :::
158
157
 
159
- #### 2. Setting license key in eventcatalog.config.js
158
+ #### 2. Setting license key in eventcatalog.config.js {#setting-license-key-in-eventcatalogconfigjs}
160
159
 
161
160
  If you prefer, you can set the license key in the `eventcatalog.config.js` file
162
161
  using the `licenseKey` property in both the API Gateway and OpenAPI plugin.
@@ -167,7 +166,7 @@ export default {
167
166
  [
168
167
  '@eventcatalog/generator-eventbridge',
169
168
  {
170
- licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY
169
+ licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
171
170
  },
172
171
  ],
173
172
  ],
@@ -195,4 +194,3 @@ npm run dev
195
194
  ```
196
195
 
197
196
 
198
-
@@ -7,9 +7,11 @@ title: Plugin Configuration
7
7
  description: Configuration of the Amazon API Gateway plugin
8
8
  ---
9
9
 
10
- This plugin requires a license key. You can get a 14 day free trial license key by signing up to [EventCatalog Cloud](https://eventcatalog.dev/cloud).
10
+ This plugin requires an EventCatalog Scale license key.
11
11
 
12
- Once you have your license key you can set the `EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY` environment variable.
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.
13
15
 
14
16
  ## Overview
15
17
 
@@ -21,7 +23,7 @@ The Amazon API Gateway plugin is configured in the `eventcatalog.config.js` file
21
23
  |--------|------|----------|---------|-------------|
22
24
  | `output` | string | No | `amazon-apigateway-specs` | The output directory for the OpenAPI specifications (used by the OpenAPI Generator plugin) |
23
25
  | `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. |
24
- | `licenseKey` | string | No | - | You can either pass the license key directly or set the `EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY` environment variable. |
26
+ | `licenseKey` | string | No | - | You can either pass the license key directly or set the `EVENTCATALOG_SCALE_LICENSE_KEY` environment variable. |
25
27
  | `apis` | API[] | Yes | - | Array of API configurations |
26
28
 
27
29
  ## API Configuration
@@ -133,4 +135,3 @@ You can view an example configuration in the [EventCatalog Amazon API Gateway p
133
135
 
134
136
 
135
137
 
136
-
@@ -69,11 +69,11 @@ The EventCatalog Apicurio Registry plugin is a generator. It will import your sc
69
69
 
70
70
  ## Commercial and License
71
71
 
72
- This plugin requires a license key to be used.
72
+ This plugin requires an EventCatalog Scale license key to be used.
73
73
 
74
- You can get a 14 day trial license key to try the plugin out by going to [EventCatalog Cloud](https://eventcatalog.cloud).
74
+ You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
75
75
 
76
- After the trial you can purchase a license to continue using this plugin, we have different plans to suit your organization based on where you are in your governance and documentation journey.
76
+ After the trial, you can continue using this plugin with EventCatalog Scale.
77
77
 
78
78
  See [pricing](/pricing) for more information.
79
79
 
@@ -86,16 +86,16 @@ If you would like a demo of the plugin, please feel free to reach out to us and
86
86
  ## License FAQ
87
87
 
88
88
  ### What is the license key for?
89
- The license key is required to use the Apicurio Registry plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
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
90
 
91
- ### How do I get a license key?
92
- You can obtain a license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 14-day free trial.
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
93
 
94
94
  ### Terms
95
- - **Trial Period**: 14 days free trial no credit card required
95
+ - **Trial Period**: 30-day free trial no credit card required
96
96
  - **Support**: Discord community support (extra for priority support)
97
97
 
98
- After your trial period ends, you can purchase a full license through [EventCatalog Cloud](https://eventcatalog.cloud) to continue using the plugin.
98
+ After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
99
99
 
100
100
  ## Any questions or need help?
101
101
 
@@ -117,19 +117,29 @@ We create an `orders` domain and an `Orders Service` that sends and receives mes
117
117
 
118
118
  The EventCatalog Apicurio Registry plugin requires API keys in your environment variables.
119
119
 
120
- 1. A license key for the Apicurio Registry plugin (14 days trial, at [EventCatalog Cloud](https://eventcatalog.cloud))
120
+ 1. An EventCatalog Scale license key for the Apicurio Registry plugin (30-day trial, at [EventCatalog Cloud](https://eventcatalog.cloud))
121
121
  2. Apicurio Registry access token (optional - only if your registry requires authentication)
122
122
 
123
123
  Create a `.env` file in the root, and add your keys to the project.
124
124
 
125
125
  ```bash title=".env"
126
126
  # EventCatalog license key
127
- EVENTCATALOG_LICENSE_KEY_APICURIO_SCHEMA_REGISTRY=your-license-key
127
+ EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
128
128
 
129
129
  # Apicurio Registry Bearer Token (optional - only if your registry requires authentication)
130
130
  APICURIO_ACCESS_TOKEN=your-access-token-here
131
131
  ```
132
132
 
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
+
133
143
  #### White listing EventCatalog domains
134
144
 
135
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.
@@ -74,12 +74,11 @@ You can attach OpenAPI or AsyncAPI specifications stored in your Apicurio Regist
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
76
  :::info Plugin Licenses Required
77
- The OpenAPI and AsyncAPI generators are separate licensed plugins. To use them with the Apicurio plugin, you'll need to:
77
+ The OpenAPI and AsyncAPI generators require an EventCatalog Scale license key. To use them with the Apicurio plugin, you'll need to:
78
78
  - Install the respective plugins: `npm install @eventcatalog/generator-openapi @eventcatalog/generator-asyncapi`
79
- - Obtain license keys from [EventCatalog Cloud](https://eventcatalog.cloud) (14-day free trial available)
80
- - Configure the license keys in your `.env` file:
81
- - `EVENTCATALOG_LICENSE_KEY_OPENAPI=your-openapi-license-key`
82
- - `EVENTCATALOG_LICENSE_KEY_ASYNCAPI=your-asyncapi-license-key`
79
+ - Obtain an EventCatalog Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud) (30-day free trial available)
80
+ - Configure the license key in your `.env` file:
81
+ - `EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key`
83
82
 
84
83
  Learn more: [OpenAPI Plugin Docs](/docs/plugins/openapi/intro) | [AsyncAPI Plugin Docs](/docs/plugins/asyncapi/intro)
85
84
  :::
@@ -534,11 +533,10 @@ When using nested generators, make sure to:
534
533
  ```bash
535
534
  npm install @eventcatalog/generator-openapi @eventcatalog/generator-asyncapi
536
535
  ```
537
- 2. Obtain license keys from [EventCatalog Cloud](https://eventcatalog.cloud) (14-day free trial available)
538
- 3. Add the license keys to your `.env` file:
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:
539
538
  ```bash
540
- EVENTCATALOG_LICENSE_KEY_OPENAPI=your-openapi-license-key
541
- EVENTCATALOG_LICENSE_KEY_ASYNCAPI=your-asyncapi-license-key
539
+ EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
542
540
  ```
543
541
 
544
542
  See [OpenAPI Plugin Docs](/docs/plugins/openapi/intro) | [AsyncAPI Plugin Docs](/docs/plugins/asyncapi/intro) for more information.
@@ -65,8 +65,8 @@ 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 Plugin Licenses Required
69
- The OpenAPI and AsyncAPI generators are separate licensed plugins. You'll need to obtain license keys for each plugin you want to use from [EventCatalog Cloud](https://eventcatalog.cloud). A 14-day free trial is available for both plugins.
68
+ :::info EventCatalog Scale License Required
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
70
 
71
71
  See the [OpenAPI Plugin](/docs/plugins/openapi/intro) and [AsyncAPI Plugin](/docs/plugins/asyncapi/intro) documentation for more details on installation and configuration.
72
72
  :::
@@ -56,11 +56,11 @@ The EventCatalog AsyncAPI plugin let's you define 1 or many AsyncAPI files. When
56
56
 
57
57
  ## Commercial and License
58
58
 
59
- This plugin requires a license key to be used.
59
+ This plugin requires an EventCatalog Scale license key to be used.
60
60
 
61
- You can get a 14 day trial license key to try the plugin out by going to [EventCatalog Cloud](https://eventcatalog.cloud).
61
+ You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
62
62
 
63
- After the trial you can purchase a license to continue using this plugin, we have different plans to suit your organization.
63
+ After the trial, you can continue using this plugin with EventCatalog Scale.
64
64
 
65
65
  See [pricing](/pricing) for more information.
66
66
 
@@ -69,13 +69,13 @@ _Have any questions? You can email us at `hello@eventcatalog.dev`._
69
69
  ## License FAQ
70
70
 
71
71
  ### What is the license key for?
72
- The license key is required to use the OpenAPI plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
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
73
 
74
- ### How do I get a license key?
75
- You can obtain a license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 14-day free trial.
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
76
 
77
77
  ### Terms
78
- - **Trial Period**: 14 days free trial no credit card required
78
+ - **Trial Period**: 30-day free trial no credit card required
79
79
  - **Support**: Discord community support (extra for priority support)
80
80
 
81
- After your trial period ends, you can purchase a full license through [EventCatalog Cloud](https://eventcatalog.cloud) to continue using the plugin.
81
+ After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
@@ -80,36 +80,36 @@ generators: [
80
80
 
81
81
  ### Configure license key
82
82
 
83
- The EventCatalog AsyncAPI plugin requires a license key to work with EventCatalog.
83
+ The EventCatalog AsyncAPI plugin requires an EventCatalog Scale license key to work with EventCatalog.
84
84
 
85
- You can get a trial license key from [EventCatalog Cloud](https://eventcatalog.cloud).
85
+ You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
86
86
 
87
87
  You have a few options for setting the license key:
88
88
 
89
89
  1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
90
90
  2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
91
91
 
92
- #### 1. Setting license key in `.env` file (recommended)
92
+ #### 1. Setting license key in `.env` file (recommended) {#setting-license-key-in-env-file-recommended}
93
93
 
94
94
  <AddedIn version="2.35.4" />
95
95
 
96
96
  Create a `.env` file in the root of your project and add the following:
97
97
 
98
98
  ```bash title=".env"
99
- EVENTCATALOG_LICENSE_KEY_ASYNCAPI=your-license-key
99
+ EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
100
100
  ```
101
101
 
102
- :::tip Using an older version of EventCatalog?
102
+ :::tip Using an Older API Key?
103
103
 
104
- If you are using an older version of EventCatalog that does not support the `.env` file, you can just export the license key as an environment variable.
104
+ If you already have an older AsyncAPI plugin key, you can still use it with the AsyncAPI-specific environment variable.
105
105
 
106
- ```bash title="Setting license key in environment variables"
107
- export EVENTCATALOG_LICENSE_KEY_ASYNCAPI=your-license-key
106
+ ```bash title=".env"
107
+ EVENTCATALOG_LICENSE_KEY_ASYNCAPI=your-license-key
108
108
  ```
109
109
 
110
110
  :::
111
111
 
112
- #### 2. Setting license key in eventcatalog.config.js
112
+ #### 2. Setting license key in eventcatalog.config.js {#setting-license-key-in-eventcatalogconfigjs}
113
113
 
114
114
  If you prefer, you can set the license key in the `eventcatalog.config.js` file
115
115
  using the `licenseKey` property in the EventCatalog AsyncAPI plugin.
@@ -120,7 +120,7 @@ export default {
120
120
  [
121
121
  '@eventcatalog/generator-asyncapi',
122
122
  {
123
- licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_LICENSE_KEY_ASYNCAPI
123
+ licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
124
124
  },
125
125
  ],
126
126
  ],
@@ -152,4 +152,3 @@ npm run dev
152
152
  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
153
 
154
154
 
155
-
@@ -22,7 +22,7 @@ The EventCatalog AsyncAPI plugin is configured in the `eventcatalog.config.js` f
22
22
  | Option | Type | Required | Description |
23
23
  |--------|------|----------|-------------|
24
24
  | `services` | `Service[]` | Yes | List of AsyncAPI files to add to your catalog |
25
- | `licenseKey` | string | Yes* | License key for the plugin. Get a 14-day trial at [EventCatalog Cloud](https://eventcatalog.cloud). Can also be set via `EVENTCATALOG_LICENSE_KEY_ASYNCAPI` environment variable. |
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
26
 
27
27
  ### Service Configuration
28
28
 
@@ -32,12 +32,13 @@ Each service in the `services` array requires the following properties:
32
32
  |----------|------|----------|-------------|
33
33
  | `id` | string | Yes | EventCatalog ID for the service. |
34
34
  | `path` | string | Yes | Path to your AsyncAPI file or remote URL to the AsyncAPI file |
35
+ | `version` | string | No | Version for the generated EventCatalog service. If not provided, the version from the AsyncAPI `info.version` field is used. Messages and channels default to this version unless overridden by `x-eventcatalog-message-version` or `x-eventcatalog-channel-version`. |
35
36
  | `name` | string | No | Display name for the service. If not provided, the specification will be used. _Added in v4.5.3_|
36
37
  | `summary` | string | No | Short summary of the service. If not provided, the specification will be used. _Added in v4.5.3_|
37
38
  | `owners` | string[] | No | Owners of the service. You can assign EventCatalog users or teams to services. Setting owners on the service will also set the owners of the messages in the AsyncAPI file. If owners are already set on any resource, those owners are persisted. |
38
39
  | `generateMarkdown` | function | - | Function to override the default markdown generation for the service. See [Markdown templates](#markdown-templates) for more information. |
39
- | `writesTo` | array[\{id: string, version?: string\}] | No | Array of [data stores](/docs/development/guides/data/introduction) id and version (optional) that the service writes to. (Added in v4.5.4) |
40
- | `readsFrom` | array[\{id: string, version?: string\}] | No | Array of [data stores](/docs/development/guides/data/introduction) id and version (optional) that the service reads from. (Added in v4.5.4) |
40
+ | `writesTo` | array[\{id: string, version?: string\}] | No | Array of [data stores](/docs/development/guides/resources/data/introduction) id and version (optional) that the service writes to. (Added in v4.5.4) |
41
+ | `readsFrom` | array[\{id: string, version?: string\}] | No | Array of [data stores](/docs/development/guides/resources/data/introduction) id and version (optional) that the service reads from. (Added in v4.5.4) |
41
42
  | `headers` | `Record<string, string>` | No | HTTP headers for authenticated remote URLs (e.g., `{ Authorization: 'Bearer token' }`). Used when fetching AsyncAPI files from URLs that require authentication. |
42
43
 
43
44
  ## Optional Configuration Options
@@ -103,7 +104,7 @@ export default {
103
104
  '@eventcatalog/generator-asyncapi',
104
105
  {
105
106
  services: [
106
- { path: path.join(__dirname, 'asyncapi-files', 'orders-service.yml'), id: 'Orders Service' },
107
+ { path: path.join(__dirname, 'asyncapi-files', 'orders-service.yml'), id: 'Orders Service', version: '1.0.0' },
107
108
  { path: path.join(__dirname, 'asyncapi-files', 'order-fulfillment-service.yml'), id: 'Order Fulfillment' },
108
109
  { path: path.join(__dirname, 'asyncapi-files', 'inventory-service.yml'), id: 'Inventory Service' },
109
110
  ],
@@ -309,4 +310,3 @@ or refer to the [AsyncAPI examples on GitHub](https://github.com/event-catalog/g
309
310
 
310
311
 
311
312
 
312
-
@@ -17,9 +17,9 @@ import TabItem from '@theme/TabItem';
17
17
  | [Mapping messages events, commands or queries](#mapping-messages-events-commands-or-queries) | AsyncAPI does not distinguish between commands, events and queries, everything is a message. Using the EventCatalog custom AsyncAPI [extension](https://www.asyncapi.com/docs/concepts/asyncapi-document/extending-specification) `x-eventcatalog-message-type` you can specify if your messages are events, command or queries. |
18
18
  | [Defining message ownership roles](#defining-message-ownership-roles) | AsyncAPI specification files do not define who owns the message and it's contract. Your AsyncAPI file my define messages your service consumes and produces but that service may not be the service that owns it's contract. (e.g An order service that consumes a Payment event. The order service (AsyncAPI file) would specify it consumes the payment event, but it is not the owner of the contract or event). |
19
19
  | [Defining message versions](#defining-message-versions) | In EventCatalog you can version your domains, services and all your messages. This can be useful as you can specify which version of a message your service produces or consumes. |
20
- | [Mapping channels into EventCatalog](#mapping-channels-into-eventcatalog) | EventCatalog supports [Channels](/docs/development/guides/channels/introduction) ([see demo](https://demo.eventcatalog.dev/docs/channels/inventory.%7Benv%7D.events/1.0.0)). This let's you document how messages or organized and transported in your event-driven architecture. |
20
+ | [Mapping channels into EventCatalog](#mapping-channels-into-eventcatalog) | EventCatalog supports [Channels](/docs/development/guides/resources/messages/message-channels/introduction) ([see demo](https://demo.eventcatalog.dev/docs/channels/inventory.%7Benv%7D.events/1.0.0)). This let's you document how messages or organized and transported in your event-driven architecture. |
21
21
  | [Creating draft domains, services and messages](#creating-draft-domains-services-and-messages) | You can create draft domains, services and messages in EventCatalog from your AsyncAPI files. This will be used to mark the resources as draft in EventCatalog. |
22
- | [Persist markdown](#persist-markdown) | When you generate your AsyncAPI files your markdown on your domains,services, and messages in EventCatalog is persisted between versions. This allows you to add [custom components](/docs/custom-components), our [MDX components](/docs/components) and customize your EventCatalog pages without losing changes when you version your AsyncAPI files. |
22
+ | [Persist markdown](#persist-markdown) | When you generate your AsyncAPI files your markdown on your domains,services, and messages in EventCatalog is persisted between versions. This allows you to add [custom components](/docs/components/custom-components), our [MDX components](/docs/components) and customize your EventCatalog pages without losing changes when you version your AsyncAPI files. |
23
23
  | [Fetch AsyncAPI files by URL](#fetch-asyncapi-files-by-url) | You can use the `path` property of the generator to specify a path to your local file system or an external URL, or you can mix both of them. |
24
24
  | [Authenticate remote URLs](#authenticate-remote-urls) | Use HTTP headers to access protected AsyncAPI files from authenticated URLs. |
25
25
  | [Automatic versioning](#automatic-versioning) | When you change versions in your AsyncAPI file and run generate, your services and messages are automatically versioned. This allows you to keep an audit log of changes between AsyncAPI files, schemas and more. |
@@ -182,7 +182,7 @@ UserSignedUp:
182
182
 
183
183
  <AddedIn version="2.7.0" pkg="@eventcatalog/generator-asyncapi" url="https://github.com/event-catalog/generators/releases/tag/v"/>
184
184
 
185
- EventCatalog supports [Channels](/docs/development/guides/channels/introduction) ([see demo](https://demo.eventcatalog.dev/docs/channels/inventory.%7Benv%7D.events/1.0.0)). This let's you document how messages or organized and transported in your event-driven architecture.
185
+ EventCatalog supports [Channels](/docs/development/guides/resources/messages/message-channels/introduction) ([see demo](https://demo.eventcatalog.dev/docs/channels/inventory.%7Benv%7D.events/1.0.0)). This let's you document how messages or organized and transported in your event-driven architecture.
186
186
 
187
187
  ![Example](../../../docs/development/guides/img/channels/channels-example.png)
188
188
 
@@ -581,7 +581,7 @@ _Example of a deprecated resource in EventCatalog:_
581
581
 
582
582
  When you generate your AsyncAPI files your markdown on your domains,services, and messages in EventCatalog is persisted between versions.
583
583
 
584
- This allows you to add [custom components](/docs/custom-components), our [MDX components](/docs/components) and customize your EventCatalog pages without losing changes when you version your AsyncAPI files.
584
+ This allows you to add [custom components](/docs/components/custom-components), our [MDX components](/docs/components) and customize your EventCatalog pages without losing changes when you version your AsyncAPI files.
585
585
 
586
586
  ### Fetch AsyncAPI files by URL
587
587
 
@@ -641,7 +641,7 @@ The headers are passed with every HTTP request when fetching the AsyncAPI file f
641
641
 
642
642
  When you change versions in your AsyncAPI file and run generate, your services and messages are automatically versioned. This allows you to keep an audit log of changes between AsyncAPI files, schemas and more.
643
643
 
644
- You can also add changelogs between different versions of your services and messages. [Read here for more information](/docs/development/guides/messages/common/changelog).
644
+ You can also add changelogs between different versions of your services and messages. [Read here for more information](/docs/development/guides/resources/messages/versioning-and-lifecycle/add-changelog).
645
645
 
646
646
  ### Downloading schemas
647
647
 
@@ -659,11 +659,11 @@ The generator supports AsyncAPI specification files up to and including version
659
659
 
660
660
  <AddedIn version="6.4.0" pkg="@eventcatalog/generator-asyncapi" url="https://github.com/event-catalog/generators/releases/tag/v"/>
661
661
 
662
- When a service sends or receives many messages, the [visualiser](/docs/development/guides/messages/common/grouping-messages) can become crowded. The `groupMessagesBy` option lets you automatically group related messages together so they collapse into a single node in the visualiser map, making your architecture easier to understand at a glance.
662
+ When a service sends or receives many messages, the [visualiser](/docs/development/guides/resources/messages/connect-messages/group-messages) can become crowded. The `groupMessagesBy` option lets you automatically group related messages together so they collapse into a single node in the visualiser map, making your architecture easier to understand at a glance.
663
663
 
664
664
  ![Message group expanded in the visualiser](./img/message-group-expanded.png)
665
665
 
666
- To learn more about how groups work in the visualiser, see [Grouping messages](/docs/development/guides/messages/common/grouping-messages).
666
+ To learn more about how groups work in the visualiser, see [Grouping messages](/docs/development/guides/resources/messages/connect-messages/group-messages).
667
667
 
668
668
  Set `groupMessagesBy: 'x-extension'` in your generator config, then add `x-eventcatalog-group` to each message in your AsyncAPI components.
669
669
 
@@ -690,9 +690,9 @@ components:
690
690
  When `parseChannels` is also enabled, group assignments and channel pointers are both preserved on the generated messages.
691
691
 
692
692
  :::tip
693
- Once grouped, messages appear as a compact stacked card in the visualiser. Click the group to expand it and see the full downstream graph — channels, consumers, and producers — just as if the messages were ungrouped. See [Grouping messages](/docs/development/guides/messages/common/grouping-messages) for more details.
693
+ Once grouped, messages appear as a compact stacked card in the visualiser. Click the group to expand it and see the full downstream graph — channels, consumers, and producers — just as if the messages were ungrouped. See [Grouping messages](/docs/development/guides/resources/messages/connect-messages/group-messages) for more details.
694
694
  :::
695
695
 
696
696
  ### Example
697
697
 
698
- See the [eventcatalog-asyncapi-example](https://github.com/event-catalog/generators/tree/main/examples/generator-asyncapi) for a working example.
698
+ See the [eventcatalog-asyncapi-example](https://github.com/event-catalog/generators/tree/main/examples/generator-asyncapi) for a working example.
@@ -75,11 +75,11 @@ If you would like to get started with our example project, [you can find it on G
75
75
 
76
76
  ## Commercial and License
77
77
 
78
- This plugin requires a license key to be used.
78
+ This plugin requires an EventCatalog Scale license key to be used.
79
79
 
80
- You can get a 14 day trial license key to try the plugin out by going to [EventCatalog Cloud](https://eventcatalog.cloud).
80
+ You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
81
81
 
82
- After the trial you can purchase a license to continue using this plugin, we have different plans to suit your organization.
82
+ After the trial, you can continue using this plugin with EventCatalog Scale.
83
83
 
84
84
  See [pricing](/pricing) for more information.
85
85
 
@@ -88,16 +88,16 @@ _Have any questions? You can email us at `hello@eventcatalog.dev`._
88
88
  ## License FAQ
89
89
 
90
90
  ### What is the license key for?
91
- The 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.
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
92
 
93
- ### How do I get a license key?
94
- You can obtain a license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 14-day free trial.
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
95
 
96
96
  ### Terms
97
- - **Trial Period**: 14 days free trial no credit card required
97
+ - **Trial Period**: 30-day free trial no credit card required
98
98
  - **Support**: Discord community support (extra for priority support)
99
99
 
100
- After your trial period ends, you can purchase a full license through [EventCatalog Cloud](https://eventcatalog.cloud) to continue using the plugin.
100
+ After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
101
101
 
102
102
  ## Issues
103
103
 
@@ -168,24 +168,34 @@ generators: [
168
168
 
169
169
  ### Configure license key
170
170
 
171
- The EventCatalog AWS Glue Schema Registry plugin requires a license key to work with EventCatalog.
171
+ The EventCatalog AWS Glue Schema Registry plugin requires an EventCatalog Scale license key to work with EventCatalog.
172
172
 
173
- You can get a trial license key from [EventCatalog Cloud](https://eventcatalog.cloud).
173
+ You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
174
174
 
175
175
  You have a few options for setting the license key:
176
176
 
177
177
  1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
178
178
  2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
179
179
 
180
- #### 1. Setting license key in `.env` file (recommended)
180
+ #### 1. Setting license key in `.env` file (recommended) {#setting-license-key-in-env-file-recommended}
181
181
 
182
182
  Create a `.env` file in the root of your project and add the following:
183
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
+
184
192
  ```bash title=".env"
185
193
  EVENTCATALOG_LICENSE_KEY_AWS_GLUE_SCHEMA_REGISTRY=your-license-key
186
194
  ```
187
195
 
188
- #### 2. Setting license key in eventcatalog.config.js
196
+ :::
197
+
198
+ #### 2. Setting license key in eventcatalog.config.js {#setting-license-key-in-eventcatalogconfigjs}
189
199
 
190
200
  If you prefer, you can set the license key in the `eventcatalog.config.js` file
191
201
  using the `licenseKey` property in the EventCatalog AWS Glue Schema Registry plugin.
@@ -196,7 +206,7 @@ export default {
196
206
  [
197
207
  '@eventcatalog/generator-aws-glue',
198
208
  {
199
- licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_LICENSE_KEY_AWS_GLUE_SCHEMA_REGISTRY
209
+ licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
200
210
  },
201
211
  ],
202
212
  ],
@@ -302,4 +312,4 @@ Once configured, generate your catalog:
302
312
  npm run generate
303
313
  ```
304
314
 
305
- This will connect to your AWS Glue Schema Registry and generate EventCatalog documentation for all your schemas.
315
+ This will connect to your AWS Glue Schema Registry and generate EventCatalog documentation for all your schemas.
@@ -218,7 +218,7 @@ When multiple filter criteria are specified in a single filter object, ALL crite
218
218
 
219
219
  Your markdown is persisted between generation runs on EventCatalog. Initially the generator will generate markdown for you for your domains, services and events, but any edits to the markdown file will be persisted between versions.
220
220
 
221
- This allows you to add [custom components](/docs/custom-components), our [MDX components](/docs/components) and customize your EventCatalog pages without losing changes when your schemas are versioned.
221
+ This allows you to add [custom components](/docs/components/custom-components), our [MDX components](/docs/components) and customize your EventCatalog pages without losing changes when your schemas are versioned.
222
222
 
223
223
  This can be useful for adding extra additional context to your events, example payloads, example CLI commands on how to produce/consume them and any other useful information.
224
224
 
@@ -284,4 +284,4 @@ generators: [
284
284
  ],
285
285
  ```
286
286
 
287
- This is useful for organizations that centralize schema management across multiple AWS accounts.
287
+ This is useful for organizations that centralize schema management across multiple AWS accounts.
@@ -29,11 +29,11 @@ The EventCatalog Azure Schema Registry plugin can provide you with many features
29
29
 
30
30
  - Keep your schemas in sync with your architecture documentation
31
31
  - Automatic versioning; as your schemas change they are versioned in EventCatalog alongside your documentation
32
- - Understand how your schemas have evolved over time with the Schema diff explorer with the [Schema Explorer](/docs/development/guides/schemas/schema-explorer)
32
+ - Understand how your schemas have evolved over time with the Schema diff explorer with the [Schema Explorer](/docs/development/guides/resources/schemas/explore-schemas/schema-explorer)
33
33
  - Add meaning (markdown) to your schemas. Provide business context to your schemas and add value
34
34
  - Quickly find who is producing or consuming your schemas
35
35
  - Visualize your Azure Event Hubs architecture with the [EventCatalog Visualizer](/features/visualization)
36
- - Download and view schemas in EventCatalog (Avro, JSON Schema) or through the [Schema API](/docs/development/guides/schemas/schema-api)
36
+ - Download and view schemas in EventCatalog (Avro, JSON Schema) or through the [Schema API](/docs/development/guides/resources/schemas/schema-api)
37
37
  - Use [EventCatalog MCP server](/docs/development/ask-your-architecture/mcp-server/introduction) to get schemas for your LLMs
38
38
 
39
39
  ### How it works
@@ -67,11 +67,11 @@ We use the REST API because it is simpler and more flexible. It doesn't require
67
67
 
68
68
  ## Commercial and License
69
69
 
70
- This plugin requires a license key to be used.
70
+ This plugin requires an EventCatalog Scale license key to be used.
71
71
 
72
- You can get a 14 day trial license key to try the plugin out by going to [EventCatalog Cloud](https://eventcatalog.cloud).
72
+ You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
73
73
 
74
- After the trial you can purchase a license to continue using this plugin, we have different plans to suit your organization based on where you are in your governance and documentation journey.
74
+ After the trial, you can continue using this plugin with EventCatalog Scale.
75
75
 
76
76
  See [pricing](/pricing) for more information.
77
77
 
@@ -80,13 +80,13 @@ _Have any questions? You can email us at `hello@eventcatalog.dev`._
80
80
  ## License FAQ
81
81
 
82
82
  ### What is the license key for?
83
- The 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.
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
84
 
85
- ### How do I get a license key?
86
- You can obtain a license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 14-day free trial.
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
87
 
88
88
  ### Terms
89
- - **Trial Period**: 14 days free trial no credit card required
89
+ - **Trial Period**: 30-day free trial no credit card required
90
90
  - **Support**: Discord community support (extra for priority support)
91
91
 
92
- After your trial period ends, you can purchase a full license through [EventCatalog Cloud](https://eventcatalog.cloud) to continue using the plugin.
92
+ After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
@@ -26,9 +26,9 @@ npm i @eventcatalog/generator-azure-schema-registry
26
26
  ```
27
27
 
28
28
  :::info License Key
29
- The EventCatalog Azure Schema Registry plugin requires a license key to work with EventCatalog.
29
+ The EventCatalog Azure Schema Registry plugin requires an EventCatalog Scale license key to work with EventCatalog.
30
30
 
31
- You can get a trial license key from [EventCatalog Cloud](https://eventcatalog.cloud).
31
+ You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
32
32
  :::
33
33
 
34
34
  ## Configuration
@@ -201,9 +201,9 @@ The EventCatalog Azure Schema Registry plugin uses Azure's REST API with Bearer
201
201
 
202
202
  ### Configure Azure Schema Registry License Key
203
203
 
204
- The EventCatalog Azure Schema Registry plugin requires a license key to work with EventCatalog.
204
+ The EventCatalog Azure Schema Registry plugin requires an EventCatalog Scale license key to work with EventCatalog.
205
205
 
206
- You can get a trial license key from [EventCatalog Cloud](https://eventcatalog.cloud).
206
+ You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
207
207
 
208
208
 
209
209
  ---
@@ -286,12 +286,22 @@ Create or update your `.env` file in your EventCatalog project root:
286
286
 
287
287
  ```bash title=".env"
288
288
  # EventCatalog license key
289
- EVENTCATALOG_LICENSE_KEY_AZURE_SCHEMA_REGISTRY=your-license-key
289
+ EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
290
290
 
291
291
  # Azure Schema Registry access token (paste the token from step 1)
292
292
  AZURE_SCHEMA_REGISTRY_TOKEN=eyJ0eXAiOiJKV1QiLCJhbGciOi...
293
293
  ```
294
294
 
295
+ :::tip Using an Older API Key?
296
+
297
+ If you already have an older Azure Schema Registry plugin key, you can still use it with the plugin-specific environment variable.
298
+
299
+ ```bash title=".env"
300
+ EVENTCATALOG_LICENSE_KEY_AZURE_SCHEMA_REGISTRY=your-license-key
301
+ ```
302
+
303
+ :::
304
+
295
305
  **Step 3: Run the Generator**
296
306
 
297
307
  ```bash