@eventcatalog/core 3.39.2 → 3.39.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.
- package/dist/analytics/analytics.cjs +1 -1
- package/dist/analytics/analytics.js +2 -2
- package/dist/analytics/log-build.cjs +1 -1
- package/dist/analytics/log-build.js +3 -3
- package/dist/{chunk-K2IR7X4Z.js → chunk-NSR4DZXS.js} +1 -1
- package/dist/{chunk-2VUYMTYY.js → chunk-O2CZERUN.js} +1 -1
- package/dist/{chunk-EC633RFS.js → chunk-ONQOIF2X.js} +1 -1
- package/dist/{chunk-Z3G6IPPF.js → chunk-PVOVC2UV.js} +1 -1
- package/dist/{chunk-4NHSANWO.js → chunk-WLUQZCIH.js} +1 -1
- package/dist/constants.cjs +1 -1
- package/dist/constants.js +1 -1
- package/dist/docs/api/02-config.md +25 -0
- package/dist/docs/api/03-domain-api.md +32 -2
- package/dist/docs/api/04-service-api.md +32 -2
- package/dist/docs/api/05-command-api.md +32 -2
- package/dist/docs/api/06-event-api.md +32 -2
- package/dist/docs/api/06-query-api.md +32 -2
- package/dist/docs/api/08-channel-api.md +32 -2
- package/dist/docs/api/09-flow-api.md +32 -2
- package/dist/docs/api/10-entity-api.md +32 -2
- package/dist/docs/api/12-data-product-api.md +14 -2
- package/dist/docs/development/guides/diagrams/05-comparing-diagrams.md +1 -1
- package/dist/docs/development/license-keys/_category_.json +12 -0
- package/dist/docs/development/license-keys/integrations.md +41 -0
- package/dist/docs/development/license-keys/license-validation.md +34 -0
- package/dist/docs/development/license-keys/overview.md +52 -0
- package/dist/docs/development/license-keys/plans.md +50 -0
- package/dist/eventcatalog.cjs +1 -1
- package/dist/eventcatalog.js +5 -5
- package/dist/generate.cjs +1 -1
- package/dist/generate.js +3 -3
- package/dist/utils/cli-logger.cjs +1 -1
- package/dist/utils/cli-logger.js +2 -2
- package/eventcatalog/src/components/Grids/DomainGrid.tsx +2 -1
- package/eventcatalog/src/components/Tables/Discover/columns.tsx +2 -0
- package/eventcatalog/src/components/Tables/columns/SharedColumns.tsx +2 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/[docVersion]/index.astro +4 -4
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/index.astro +4 -4
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/changelog/index.astro +16 -10
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/graphql/[filename].astro +6 -5
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/index.astro +22 -51
- package/eventcatalog/src/pages/docs/[type]/[id]/_index.data.ts +67 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/index.astro +4 -41
- package/eventcatalog/src/styles/theme.css +92 -0
- package/eventcatalog/src/utils/badge-styles.ts +206 -0
- package/eventcatalog/src/utils/page-loaders/page-data-loader.ts +16 -13
- package/package.json +3 -3
- package/dist/docs/development/deployment/licenses.md +0 -50
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import {
|
|
2
2
|
log_build_default
|
|
3
|
-
} from "../chunk-
|
|
4
|
-
import "../chunk-
|
|
3
|
+
} from "../chunk-O2CZERUN.js";
|
|
4
|
+
import "../chunk-ONQOIF2X.js";
|
|
5
5
|
import "../chunk-4UVFXLPI.js";
|
|
6
|
-
import "../chunk-
|
|
6
|
+
import "../chunk-WLUQZCIH.js";
|
|
7
7
|
import "../chunk-5T63CXKU.js";
|
|
8
8
|
export {
|
|
9
9
|
log_build_default as default
|
package/dist/constants.cjs
CHANGED
package/dist/constants.js
CHANGED
|
@@ -175,6 +175,30 @@ module.exports = {
|
|
|
175
175
|
};
|
|
176
176
|
```
|
|
177
177
|
|
|
178
|
+
### `security` {#security}
|
|
179
|
+
|
|
180
|
+
<AddedIn version="3.39.2" />
|
|
181
|
+
|
|
182
|
+
- Type: `Record<"checkOrigin", boolean> | undefined`
|
|
183
|
+
- Default: `{checkOrigin: true}`
|
|
184
|
+
|
|
185
|
+
Enables security measures for an EventCatalog website.
|
|
186
|
+
|
|
187
|
+
These features only exist for pages rendered on demand (SSR) using server mode or pages that opt out of prerendering in static mode.
|
|
188
|
+
|
|
189
|
+
By default, EventCatalog will automatically check that the “origin” header matches the URL sent by each request in on-demand rendered pages. You can disable this behavior by setting checkOrigin to false:
|
|
190
|
+
|
|
191
|
+
You can read more on the Astro documentation [here](https://docs.astro.build/en/reference/configuration-reference/#security).
|
|
192
|
+
|
|
193
|
+
```js title="eventcatalog.config.js"
|
|
194
|
+
module.exports = {
|
|
195
|
+
output: "server",
|
|
196
|
+
security: {
|
|
197
|
+
checkOrigin: false
|
|
198
|
+
}
|
|
199
|
+
};
|
|
200
|
+
```
|
|
201
|
+
|
|
178
202
|
### `generators` {#generators}
|
|
179
203
|
|
|
180
204
|
- Type: `Generator[]`
|
|
@@ -389,6 +413,7 @@ The `chat` property requires a Starter or Scale plan and `output: 'server'` to t
|
|
|
389
413
|
|
|
390
414
|
```js title="eventcatalog.config.js"
|
|
391
415
|
module.exports = {
|
|
416
|
+
output: 'server',
|
|
392
417
|
chat: {
|
|
393
418
|
// Set to false to disable the AI chat feature entirely
|
|
394
419
|
enabled: false,
|
|
@@ -239,20 +239,50 @@ You can store these anywhere in your catalog, and your domain can just reference
|
|
|
239
239
|
|
|
240
240
|
### `badges` {#badges}
|
|
241
241
|
|
|
242
|
+
<AddedIn version="3.39.4" />
|
|
243
|
+
|
|
242
244
|
An array of badges that get rendered on the page.
|
|
243
245
|
|
|
244
246
|
```md title="Example"
|
|
245
247
|
---
|
|
246
248
|
badges:
|
|
247
249
|
- content: My badge
|
|
248
|
-
backgroundColor:
|
|
249
|
-
textColor:
|
|
250
|
+
backgroundColor: green
|
|
251
|
+
textColor: green
|
|
250
252
|
# Optional icon to display (from https://heroicons.com/)
|
|
251
253
|
# Or the name of the broker (e.g Kafka, EventBridge, etc)
|
|
252
254
|
icon: BoltIcon
|
|
253
255
|
---
|
|
254
256
|
```
|
|
255
257
|
|
|
258
|
+
#### Use named colors
|
|
259
|
+
|
|
260
|
+
Set `backgroundColor` or `textColor` to a named palette token for automatic light/dark mode adaptation.
|
|
261
|
+
|
|
262
|
+
Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
|
|
263
|
+
|
|
264
|
+
```md title="Named color example"
|
|
265
|
+
---
|
|
266
|
+
badges:
|
|
267
|
+
- content: Critical
|
|
268
|
+
backgroundColor: red
|
|
269
|
+
textColor: red
|
|
270
|
+
---
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
#### Use any CSS color
|
|
274
|
+
|
|
275
|
+
You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`, `hsl()`, `oklch()`, or a CSS variable (`var(--my-color)`).
|
|
276
|
+
|
|
277
|
+
```md title="CSS color example"
|
|
278
|
+
---
|
|
279
|
+
badges:
|
|
280
|
+
- content: Custom
|
|
281
|
+
backgroundColor: "#6366f1"
|
|
282
|
+
textColor: "#ffffff"
|
|
283
|
+
---
|
|
284
|
+
```
|
|
285
|
+
|
|
256
286
|
### `specifications` {#specifications}
|
|
257
287
|
|
|
258
288
|
<AddedIn version="2.6.0" />
|
|
@@ -220,19 +220,49 @@ An array of [flows](/docs/development/guides/flows/introduction) ids that are as
|
|
|
220
220
|
|
|
221
221
|
### `badges` {#badges}
|
|
222
222
|
|
|
223
|
+
<AddedIn version="3.39.4" />
|
|
224
|
+
|
|
223
225
|
An array of badges that get rendered on the page.
|
|
224
226
|
|
|
225
227
|
```md title="Example"
|
|
226
228
|
---
|
|
227
229
|
badges:
|
|
228
230
|
- content: My badge
|
|
229
|
-
backgroundColor:
|
|
230
|
-
textColor:
|
|
231
|
+
backgroundColor: green
|
|
232
|
+
textColor: green
|
|
231
233
|
# Optional icon to display (from https://heroicons.com/)
|
|
232
234
|
icon: BoltIcon
|
|
233
235
|
---
|
|
234
236
|
```
|
|
235
237
|
|
|
238
|
+
#### Use named colors
|
|
239
|
+
|
|
240
|
+
Set `backgroundColor` or `textColor` to a named palette token for automatic light/dark mode adaptation.
|
|
241
|
+
|
|
242
|
+
Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
|
|
243
|
+
|
|
244
|
+
```md title="Named color example"
|
|
245
|
+
---
|
|
246
|
+
badges:
|
|
247
|
+
- content: Critical
|
|
248
|
+
backgroundColor: red
|
|
249
|
+
textColor: red
|
|
250
|
+
---
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
#### Use any CSS color
|
|
254
|
+
|
|
255
|
+
You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`, `hsl()`, `oklch()`, or a CSS variable (`var(--my-color)`).
|
|
256
|
+
|
|
257
|
+
```md title="CSS color example"
|
|
258
|
+
---
|
|
259
|
+
badges:
|
|
260
|
+
- content: Custom
|
|
261
|
+
backgroundColor: "#6366f1"
|
|
262
|
+
textColor: "#ffffff"
|
|
263
|
+
---
|
|
264
|
+
```
|
|
265
|
+
|
|
236
266
|
### `specifications` {#specifications}
|
|
237
267
|
|
|
238
268
|
<AddedIn version="2.39.1" />
|
|
@@ -142,20 +142,50 @@ An array of user ids that own the command.
|
|
|
142
142
|
|
|
143
143
|
### `badges` {#badges}
|
|
144
144
|
|
|
145
|
+
<AddedIn version="3.39.4" />
|
|
146
|
+
|
|
145
147
|
An array of badges that get rendered on the page.
|
|
146
148
|
|
|
147
149
|
```md title="Example"
|
|
148
150
|
---
|
|
149
151
|
badges:
|
|
150
152
|
- content: My badge
|
|
151
|
-
backgroundColor:
|
|
152
|
-
textColor:
|
|
153
|
+
backgroundColor: green
|
|
154
|
+
textColor: green
|
|
153
155
|
# Optional icon to display (from https://heroicons.com/)
|
|
154
156
|
# Or the name of the broker (e.g Kafka, EventBridge, etc)
|
|
155
157
|
icon: BoltIcon
|
|
156
158
|
---
|
|
157
159
|
```
|
|
158
160
|
|
|
161
|
+
#### Use named colors
|
|
162
|
+
|
|
163
|
+
Set `backgroundColor` or `textColor` to a named palette token for automatic light/dark mode adaptation.
|
|
164
|
+
|
|
165
|
+
Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
|
|
166
|
+
|
|
167
|
+
```md title="Named color example"
|
|
168
|
+
---
|
|
169
|
+
badges:
|
|
170
|
+
- content: Critical
|
|
171
|
+
backgroundColor: red
|
|
172
|
+
textColor: red
|
|
173
|
+
---
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
#### Use any CSS color
|
|
177
|
+
|
|
178
|
+
You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`, `hsl()`, `oklch()`, or a CSS variable (`var(--my-color)`).
|
|
179
|
+
|
|
180
|
+
```md title="CSS color example"
|
|
181
|
+
---
|
|
182
|
+
badges:
|
|
183
|
+
- content: Custom
|
|
184
|
+
backgroundColor: "#6366f1"
|
|
185
|
+
textColor: "#ffffff"
|
|
186
|
+
---
|
|
187
|
+
```
|
|
188
|
+
|
|
159
189
|
### `schemaPath` {#schemaPath}
|
|
160
190
|
|
|
161
191
|
Path to the schema of the message.
|
|
@@ -141,20 +141,50 @@ An array of user ids that own the event.
|
|
|
141
141
|
|
|
142
142
|
### `badges` {#badges}
|
|
143
143
|
|
|
144
|
+
<AddedIn version="3.39.4" />
|
|
145
|
+
|
|
144
146
|
An array of badges that get rendered on the page.
|
|
145
147
|
|
|
146
148
|
```md title="Example"
|
|
147
149
|
---
|
|
148
150
|
badges:
|
|
149
151
|
- content: My badge
|
|
150
|
-
backgroundColor:
|
|
151
|
-
textColor:
|
|
152
|
+
backgroundColor: green
|
|
153
|
+
textColor: green
|
|
152
154
|
# Optional icon to display (from https://heroicons.com/)
|
|
153
155
|
# Or the name of the broker (e.g Kafka, EventBridge, etc)
|
|
154
156
|
icon: BoltIcon
|
|
155
157
|
---
|
|
156
158
|
```
|
|
157
159
|
|
|
160
|
+
#### Use named colors
|
|
161
|
+
|
|
162
|
+
Set `backgroundColor` or `textColor` to a named palette token for automatic light/dark mode adaptation.
|
|
163
|
+
|
|
164
|
+
Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
|
|
165
|
+
|
|
166
|
+
```md title="Named color example"
|
|
167
|
+
---
|
|
168
|
+
badges:
|
|
169
|
+
- content: Critical
|
|
170
|
+
backgroundColor: red
|
|
171
|
+
textColor: red
|
|
172
|
+
---
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
#### Use any CSS color
|
|
176
|
+
|
|
177
|
+
You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`, `hsl()`, `oklch()`, or a CSS variable (`var(--my-color)`).
|
|
178
|
+
|
|
179
|
+
```md title="CSS color example"
|
|
180
|
+
---
|
|
181
|
+
badges:
|
|
182
|
+
- content: Custom
|
|
183
|
+
backgroundColor: "#6366f1"
|
|
184
|
+
textColor: "#ffffff"
|
|
185
|
+
---
|
|
186
|
+
```
|
|
187
|
+
|
|
158
188
|
### `schemaPath` {#schemaPath}
|
|
159
189
|
|
|
160
190
|
Path to the schema of the message.
|
|
@@ -139,20 +139,50 @@ An array of user ids that own the query.
|
|
|
139
139
|
|
|
140
140
|
### `badges` {#badges}
|
|
141
141
|
|
|
142
|
+
<AddedIn version="3.39.4" />
|
|
143
|
+
|
|
142
144
|
An array of badges that get rendered on the page.
|
|
143
145
|
|
|
144
146
|
```md title="Example"
|
|
145
147
|
---
|
|
146
148
|
badges:
|
|
147
149
|
- content: My badge
|
|
148
|
-
backgroundColor:
|
|
149
|
-
textColor:
|
|
150
|
+
backgroundColor: green
|
|
151
|
+
textColor: green
|
|
150
152
|
# Optional icon to display (from https://heroicons.com/)
|
|
151
153
|
# Or the name of the broker (e.g Kafka, EventBridge, etc)
|
|
152
154
|
icon: BoltIcon
|
|
153
155
|
---
|
|
154
156
|
```
|
|
155
157
|
|
|
158
|
+
#### Use named colors
|
|
159
|
+
|
|
160
|
+
Set `backgroundColor` or `textColor` to a named palette token for automatic light/dark mode adaptation.
|
|
161
|
+
|
|
162
|
+
Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
|
|
163
|
+
|
|
164
|
+
```md title="Named color example"
|
|
165
|
+
---
|
|
166
|
+
badges:
|
|
167
|
+
- content: Critical
|
|
168
|
+
backgroundColor: red
|
|
169
|
+
textColor: red
|
|
170
|
+
---
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
#### Use any CSS color
|
|
174
|
+
|
|
175
|
+
You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`, `hsl()`, `oklch()`, or a CSS variable (`var(--my-color)`).
|
|
176
|
+
|
|
177
|
+
```md title="CSS color example"
|
|
178
|
+
---
|
|
179
|
+
badges:
|
|
180
|
+
- content: Custom
|
|
181
|
+
backgroundColor: "#6366f1"
|
|
182
|
+
textColor: "#ffffff"
|
|
183
|
+
---
|
|
184
|
+
```
|
|
185
|
+
|
|
156
186
|
### `schemaPath` {#schemaPath}
|
|
157
187
|
|
|
158
188
|
Path to the schema of the message.
|
|
@@ -207,20 +207,50 @@ An array of user ids that own the channel.
|
|
|
207
207
|
|
|
208
208
|
### `badges` {#badges}
|
|
209
209
|
|
|
210
|
+
<AddedIn version="3.39.4" />
|
|
211
|
+
|
|
210
212
|
An array of badges that get rendered on the page.
|
|
211
213
|
|
|
212
214
|
```md title="Example"
|
|
213
215
|
---
|
|
214
216
|
badges:
|
|
215
217
|
- content: My badge
|
|
216
|
-
backgroundColor:
|
|
217
|
-
textColor:
|
|
218
|
+
backgroundColor: green
|
|
219
|
+
textColor: green
|
|
218
220
|
# Optional icon to display (from https://heroicons.com/)
|
|
219
221
|
# Or the name of the broker (e.g Kafka, EventBridge, etc)
|
|
220
222
|
icon: BoltIcon
|
|
221
223
|
---
|
|
222
224
|
```
|
|
223
225
|
|
|
226
|
+
#### Use named colors
|
|
227
|
+
|
|
228
|
+
Set `backgroundColor` or `textColor` to a named palette token for automatic light/dark mode adaptation.
|
|
229
|
+
|
|
230
|
+
Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
|
|
231
|
+
|
|
232
|
+
```md title="Named color example"
|
|
233
|
+
---
|
|
234
|
+
badges:
|
|
235
|
+
- content: Critical
|
|
236
|
+
backgroundColor: red
|
|
237
|
+
textColor: red
|
|
238
|
+
---
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
#### Use any CSS color
|
|
242
|
+
|
|
243
|
+
You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`, `hsl()`, `oklch()`, or a CSS variable (`var(--my-color)`).
|
|
244
|
+
|
|
245
|
+
```md title="CSS color example"
|
|
246
|
+
---
|
|
247
|
+
badges:
|
|
248
|
+
- content: Custom
|
|
249
|
+
backgroundColor: "#6366f1"
|
|
250
|
+
textColor: "#ffffff"
|
|
251
|
+
---
|
|
252
|
+
```
|
|
253
|
+
|
|
224
254
|
### `repository` {#repository}
|
|
225
255
|
|
|
226
256
|
<AddedIn version="2.11.2" />
|
|
@@ -316,20 +316,50 @@ Short summary of your flow, shown on flow summary pages.
|
|
|
316
316
|
|
|
317
317
|
### `badges` {#badges}
|
|
318
318
|
|
|
319
|
+
<AddedIn version="3.39.4" />
|
|
320
|
+
|
|
319
321
|
An array of badges that get rendered on the page.
|
|
320
322
|
|
|
321
323
|
```md title="Example"
|
|
322
324
|
---
|
|
323
325
|
badges:
|
|
324
326
|
- content: My badge
|
|
325
|
-
backgroundColor:
|
|
326
|
-
textColor:
|
|
327
|
+
backgroundColor: green
|
|
328
|
+
textColor: green
|
|
327
329
|
# Optional icon to display (from https://heroicons.com/)
|
|
328
330
|
# Or the name of the broker (e.g Kafka, EventBridge, etc)
|
|
329
331
|
icon: BoltIcon
|
|
330
332
|
---
|
|
331
333
|
```
|
|
332
334
|
|
|
335
|
+
#### Use named colors
|
|
336
|
+
|
|
337
|
+
Set `backgroundColor` or `textColor` to a named palette token for automatic light/dark mode adaptation.
|
|
338
|
+
|
|
339
|
+
Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
|
|
340
|
+
|
|
341
|
+
```md title="Named color example"
|
|
342
|
+
---
|
|
343
|
+
badges:
|
|
344
|
+
- content: Critical
|
|
345
|
+
backgroundColor: red
|
|
346
|
+
textColor: red
|
|
347
|
+
---
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
#### Use any CSS color
|
|
351
|
+
|
|
352
|
+
You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`, `hsl()`, `oklch()`, or a CSS variable (`var(--my-color)`).
|
|
353
|
+
|
|
354
|
+
```md title="CSS color example"
|
|
355
|
+
---
|
|
356
|
+
badges:
|
|
357
|
+
- content: Custom
|
|
358
|
+
backgroundColor: "#6366f1"
|
|
359
|
+
textColor: "#ffffff"
|
|
360
|
+
---
|
|
361
|
+
```
|
|
362
|
+
|
|
333
363
|
### `editUrl` {#editUrl}
|
|
334
364
|
|
|
335
365
|
<AddedIn version="2.49.4" />
|
|
@@ -190,19 +190,49 @@ Each property can have the following fields:
|
|
|
190
190
|
|
|
191
191
|
### `badges` {#badges}
|
|
192
192
|
|
|
193
|
+
<AddedIn version="3.39.4" />
|
|
194
|
+
|
|
193
195
|
An array of badges that get rendered on the page.
|
|
194
196
|
|
|
195
197
|
```md title="Example"
|
|
196
198
|
---
|
|
197
199
|
badges:
|
|
198
200
|
- content: Core Entity
|
|
199
|
-
backgroundColor:
|
|
200
|
-
textColor:
|
|
201
|
+
backgroundColor: green
|
|
202
|
+
textColor: green
|
|
201
203
|
# Optional icon to display (from https://heroicons.com/)
|
|
202
204
|
icon: BoltIcon
|
|
203
205
|
---
|
|
204
206
|
```
|
|
205
207
|
|
|
208
|
+
#### Use named colors
|
|
209
|
+
|
|
210
|
+
Set `backgroundColor` or `textColor` to a named palette token for automatic light/dark mode adaptation.
|
|
211
|
+
|
|
212
|
+
Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
|
|
213
|
+
|
|
214
|
+
```md title="Named color example"
|
|
215
|
+
---
|
|
216
|
+
badges:
|
|
217
|
+
- content: Critical
|
|
218
|
+
backgroundColor: red
|
|
219
|
+
textColor: red
|
|
220
|
+
---
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
#### Use any CSS color
|
|
224
|
+
|
|
225
|
+
You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`, `hsl()`, `oklch()`, or a CSS variable (`var(--my-color)`).
|
|
226
|
+
|
|
227
|
+
```md title="CSS color example"
|
|
228
|
+
---
|
|
229
|
+
badges:
|
|
230
|
+
- content: Custom
|
|
231
|
+
backgroundColor: "#6366f1"
|
|
232
|
+
textColor: "#ffffff"
|
|
233
|
+
---
|
|
234
|
+
```
|
|
235
|
+
|
|
206
236
|
|
|
207
237
|
### `editUrl` {#editUrl}
|
|
208
238
|
|
|
@@ -204,6 +204,8 @@ owners:
|
|
|
204
204
|
|
|
205
205
|
### `badges`
|
|
206
206
|
|
|
207
|
+
<AddedIn version="3.39.4" />
|
|
208
|
+
|
|
207
209
|
- Type: `array`
|
|
208
210
|
|
|
209
211
|
Array of badges to display on the data product page.
|
|
@@ -225,8 +227,18 @@ Badge properties:
|
|
|
225
227
|
| Property | Type | Required | Description |
|
|
226
228
|
| -------- | ---- | -------- | ----------- |
|
|
227
229
|
| `content` | `string` | Yes | Text content of the badge |
|
|
228
|
-
| `backgroundColor` | `string` | Yes | Background color |
|
|
229
|
-
| `textColor` | `string` | Yes | Text color |
|
|
230
|
+
| `backgroundColor` | `string` | Yes | Background color (named token or CSS value) |
|
|
231
|
+
| `textColor` | `string` | Yes | Text color (named token or CSS value) |
|
|
232
|
+
|
|
233
|
+
#### Use named colors
|
|
234
|
+
|
|
235
|
+
Set `backgroundColor` or `textColor` to a named palette token for automatic light/dark mode adaptation.
|
|
236
|
+
|
|
237
|
+
Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
|
|
238
|
+
|
|
239
|
+
#### Use any CSS color
|
|
240
|
+
|
|
241
|
+
You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`, `hsl()`, `oklch()`, or a CSS variable (`var(--my-color)`).
|
|
230
242
|
|
|
231
243
|
### `repository`
|
|
232
244
|
|
|
@@ -14,7 +14,7 @@ import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
|
14
14
|
<AddedIn version="3.3.0" />
|
|
15
15
|
|
|
16
16
|
:::info EventCatalog Scale Feature
|
|
17
|
-
Diagram comparison is available exclusively with the [EventCatalog Scale](/docs/development/
|
|
17
|
+
Diagram comparison is available exclusively with the [EventCatalog Scale](/docs/development/license-keys/plans) license. This feature enables side-by-side visualization of different diagram versions.
|
|
18
18
|
:::
|
|
19
19
|
|
|
20
20
|
The diagram comparison feature allows you to view two versions of a diagram side-by-side, making it easy to understand architectural changes and evolution over time.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"label": "License Keys",
|
|
3
|
+
"position": 11,
|
|
4
|
+
"collapsible": true,
|
|
5
|
+
"collapsed": true,
|
|
6
|
+
"link": {
|
|
7
|
+
"type": "generated-index",
|
|
8
|
+
"slug": "development/license-keys",
|
|
9
|
+
"title": "License Keys",
|
|
10
|
+
"description": "How to get and use license keys for EventCatalog plans (Starter, Scale) and integrations (OpenAPI, AsyncAPI, and more)."
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 3
|
|
3
|
+
keywords:
|
|
4
|
+
- licenses
|
|
5
|
+
- integrations
|
|
6
|
+
- plugins
|
|
7
|
+
- openapi
|
|
8
|
+
- asyncapi
|
|
9
|
+
sidebar_label: Integrations
|
|
10
|
+
title: Getting a license key for integrations
|
|
11
|
+
description: How to activate EventCatalog integrations (OpenAPI, AsyncAPI, Backstage, and more) and get your license key.
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
EventCatalog integrations (sometimes called plugins) let you generate your catalog from sources you already have — OpenAPI specs, AsyncAPI documents, Backstage, federated catalogs, and more. You can see the full list on the [integrations page](/integrations).
|
|
15
|
+
|
|
16
|
+
Each integration is licensed individually and comes with a **14 day free trial**. Activate one from your [integrations dashboard](https://eventcatalog.cloud/dashboard/integrations) — see the [Quick start in the overview](/docs/development/license-keys/overview#quick-start) for the full step-by-step.
|
|
17
|
+
|
|
18
|
+

|
|
19
|
+
|
|
20
|
+
Once activated, your license key for the integration appears on your [API keys page](https://eventcatalog.cloud/dashboard/api-keys):
|
|
21
|
+
|
|
22
|
+

|
|
23
|
+
|
|
24
|
+
## Adding your license key to your catalog
|
|
25
|
+
|
|
26
|
+
Copy the license key from your dashboard into your `.env` file. Each integration uses its own environment variable — the exact name is shown next to the key on your dashboard and in the integration's own documentation. For example:
|
|
27
|
+
|
|
28
|
+
```bash title=".env"
|
|
29
|
+
EVENTCATALOG_OPENAPI_LICENSE_KEY=your-license-key-here
|
|
30
|
+
EVENTCATALOG_ASYNCAPI_LICENSE_KEY=your-license-key-here
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Then configure the integration in your `eventcatalog.config.js` as described in the [integration's documentation](/integrations).
|
|
34
|
+
|
|
35
|
+
## Trying multiple integrations
|
|
36
|
+
|
|
37
|
+
You can activate as many integrations as you want from your [integrations dashboard](https://eventcatalog.cloud/dashboard/integrations). Each one has its own 14 day trial and its own license key.
|
|
38
|
+
|
|
39
|
+
## Need more time?
|
|
40
|
+
|
|
41
|
+
If 14 days isn't enough to evaluate an integration in your environment, email us at `hello@eventcatalog.dev` and we'll extend your trial.
|