@meshery/schemas 1.3.114 → 1.3.115
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/cloudApi.d.mts +631 -4
- package/dist/cloudApi.d.ts +631 -4
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +8 -0
- package/dist/constructs/v1beta2/core/CoreSchema.js +2 -2
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +2 -2
- package/dist/constructs/v1beta2/credential/Credential.d.ts +144 -0
- package/dist/constructs/v1beta2/credential/CredentialSchema.js +4 -1
- package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +4 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +14 -2
- package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
- package/dist/constructs/v1beta3/event/Event.d.ts +386 -4
- package/dist/constructs/v1beta3/event/EventSchema.js +6 -6
- package/dist/constructs/v1beta3/event/EventSchema.mjs +6 -6
- package/dist/constructs/v1beta3/user/User.d.ts +8 -0
- package/dist/constructs/v1beta3/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta3/user/UserSchema.mjs +1 -1
- package/dist/index.d.mts +190 -2
- package/dist/index.d.ts +190 -2
- package/dist/mesheryApi.d.mts +8 -2
- package/dist/mesheryApi.d.ts +8 -2
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
@@ -130,6 +130,32 @@ export interface paths {
|
|
|
130
130
|
patch?: never;
|
|
131
131
|
trace?: never;
|
|
132
132
|
};
|
|
133
|
+
"/api/events/feed": {
|
|
134
|
+
parameters: {
|
|
135
|
+
query?: never;
|
|
136
|
+
header?: never;
|
|
137
|
+
path?: never;
|
|
138
|
+
cookie?: never;
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* Get event feed
|
|
142
|
+
* @description Generic, unauthenticated feed of events whose visibility is `public`
|
|
143
|
+
* and whose owner's `shareActivityPublicly` preference is on at read
|
|
144
|
+
* time. Results are ordered newest first by `createdAt` and can be
|
|
145
|
+
* filtered by category and action. Rate limited per client IP; an
|
|
146
|
+
* over-limit client receives 429 with `Retry-After`. Responses carry
|
|
147
|
+
* `Cache-Control: public, max-age=N` where N is at most 30 seconds.
|
|
148
|
+
* See docs/event-feed-contract.md.
|
|
149
|
+
*/
|
|
150
|
+
get: operations["getEventFeed"];
|
|
151
|
+
put?: never;
|
|
152
|
+
post?: never;
|
|
153
|
+
delete?: never;
|
|
154
|
+
options?: never;
|
|
155
|
+
head?: never;
|
|
156
|
+
patch?: never;
|
|
157
|
+
trace?: never;
|
|
158
|
+
};
|
|
133
159
|
"/api/events/summary": {
|
|
134
160
|
parameters: {
|
|
135
161
|
query?: never;
|
|
@@ -168,7 +194,7 @@ export interface paths {
|
|
|
168
194
|
export type webhooks = Record<string, never>;
|
|
169
195
|
export interface components {
|
|
170
196
|
schemas: {
|
|
171
|
-
/** @description Payload for creating a new event. */
|
|
197
|
+
/** @description Payload for creating a new event. If visibility is absent, the event is private. */
|
|
172
198
|
EventPayload: {
|
|
173
199
|
/**
|
|
174
200
|
* Format: uuid
|
|
@@ -177,6 +203,12 @@ export interface components {
|
|
|
177
203
|
owner?: string;
|
|
178
204
|
/** @description The category of the event. */
|
|
179
205
|
category?: string;
|
|
206
|
+
/**
|
|
207
|
+
* @description Who can see the event. `private` is the default; clients may set `public` for events eligible for the unauthenticated feed.
|
|
208
|
+
* @default private
|
|
209
|
+
* @enum {string}
|
|
210
|
+
*/
|
|
211
|
+
visibility: "private" | "public";
|
|
180
212
|
/** @description The action of the event. */
|
|
181
213
|
action?: string;
|
|
182
214
|
/** @description Description of the event. */
|
|
@@ -233,6 +265,12 @@ export interface components {
|
|
|
233
265
|
};
|
|
234
266
|
/** @description EventResult entity schema. */
|
|
235
267
|
EventResult: {
|
|
268
|
+
/**
|
|
269
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.
|
|
270
|
+
* @default private
|
|
271
|
+
* @enum {string}
|
|
272
|
+
*/
|
|
273
|
+
visibility: "private" | "public";
|
|
236
274
|
/**
|
|
237
275
|
* Format: uuid
|
|
238
276
|
* @description UUID of the user associated with the event.
|
|
@@ -255,6 +293,11 @@ export interface components {
|
|
|
255
293
|
firstName?: string;
|
|
256
294
|
/** @description The last name of the user associated with the event. */
|
|
257
295
|
lastName?: string;
|
|
296
|
+
/**
|
|
297
|
+
* Format: uri
|
|
298
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
299
|
+
*/
|
|
300
|
+
avatarUrl?: string;
|
|
258
301
|
/**
|
|
259
302
|
* Format: email
|
|
260
303
|
* @description Email address of the user associated with the event.
|
|
@@ -286,7 +329,7 @@ export interface components {
|
|
|
286
329
|
category: string;
|
|
287
330
|
/** @description Human-readable summary of what happened. */
|
|
288
331
|
description: string;
|
|
289
|
-
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
|
|
332
|
+
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); ScheduleCompletedEventMetadata (category `schedule`, action `completed`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
|
|
290
333
|
metadata: {
|
|
291
334
|
[key: string]: unknown;
|
|
292
335
|
} | null;
|
|
@@ -324,6 +367,12 @@ export interface components {
|
|
|
324
367
|
* @description Timestamp when the event was last updated.
|
|
325
368
|
*/
|
|
326
369
|
updatedAt: string;
|
|
370
|
+
/**
|
|
371
|
+
* @description Who can see the event. Defaults to `private`.
|
|
372
|
+
* @default private
|
|
373
|
+
* @enum {string}
|
|
374
|
+
*/
|
|
375
|
+
visibility: "private" | "public";
|
|
327
376
|
/**
|
|
328
377
|
* Format: date-time
|
|
329
378
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
@@ -340,6 +389,12 @@ export interface components {
|
|
|
340
389
|
totalCount?: number;
|
|
341
390
|
/** @description The events returned on the current page. */
|
|
342
391
|
data?: {
|
|
392
|
+
/**
|
|
393
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.
|
|
394
|
+
* @default private
|
|
395
|
+
* @enum {string}
|
|
396
|
+
*/
|
|
397
|
+
visibility: "private" | "public";
|
|
343
398
|
/**
|
|
344
399
|
* Format: uuid
|
|
345
400
|
* @description UUID of the user associated with the event.
|
|
@@ -362,6 +417,11 @@ export interface components {
|
|
|
362
417
|
firstName?: string;
|
|
363
418
|
/** @description The last name of the user associated with the event. */
|
|
364
419
|
lastName?: string;
|
|
420
|
+
/**
|
|
421
|
+
* Format: uri
|
|
422
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
423
|
+
*/
|
|
424
|
+
avatarUrl?: string;
|
|
365
425
|
/**
|
|
366
426
|
* Format: email
|
|
367
427
|
* @description Email address of the user associated with the event.
|
|
@@ -376,6 +436,134 @@ export interface components {
|
|
|
376
436
|
createdAt?: string;
|
|
377
437
|
}[];
|
|
378
438
|
};
|
|
439
|
+
/**
|
|
440
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time. Clients such as Blowhorn decide whether to mark their own events public.
|
|
441
|
+
* @default private
|
|
442
|
+
* @enum {string}
|
|
443
|
+
*/
|
|
444
|
+
EventVisibility: "private" | "public";
|
|
445
|
+
/**
|
|
446
|
+
* @description An event projected into the public feed. It never includes email,
|
|
447
|
+
* firstName, lastName, description, provider or raw metadata.
|
|
448
|
+
* `platform`, `role`, `line` and `networks` are projected from
|
|
449
|
+
* ScheduleCompletedEventMetadata; events without valid required
|
|
450
|
+
* metadata are skipped. Public profile fields are resolved by Cloud at
|
|
451
|
+
* read time and are included only when the user's profile is public.
|
|
452
|
+
*/
|
|
453
|
+
EventFeedItem: {
|
|
454
|
+
/**
|
|
455
|
+
* Format: uuid
|
|
456
|
+
* @description Event ID.
|
|
457
|
+
*/
|
|
458
|
+
id: string;
|
|
459
|
+
/**
|
|
460
|
+
* Format: uuid
|
|
461
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
462
|
+
*/
|
|
463
|
+
userId: string;
|
|
464
|
+
/** @description Event category. */
|
|
465
|
+
category: string;
|
|
466
|
+
/** @description Event action. */
|
|
467
|
+
action: string;
|
|
468
|
+
/**
|
|
469
|
+
* Format: date-time
|
|
470
|
+
* @description Event creation time; the feed is ordered newest first.
|
|
471
|
+
*/
|
|
472
|
+
createdAt: string;
|
|
473
|
+
/**
|
|
474
|
+
* @description Always `public` in the feed.
|
|
475
|
+
* @default private
|
|
476
|
+
* @enum {string}
|
|
477
|
+
*/
|
|
478
|
+
visibility: "private" | "public";
|
|
479
|
+
/**
|
|
480
|
+
* @description Platform from ScheduleCompletedEventMetadata.
|
|
481
|
+
* @enum {string}
|
|
482
|
+
*/
|
|
483
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
484
|
+
/** @description Role from ScheduleCompletedEventMetadata. */
|
|
485
|
+
role: string;
|
|
486
|
+
/** @description One-line result from ScheduleCompletedEventMetadata. */
|
|
487
|
+
line: string;
|
|
488
|
+
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
489
|
+
networks?: string[];
|
|
490
|
+
/** @description Public username, never a real name; present only for a public profile. */
|
|
491
|
+
displayName?: string;
|
|
492
|
+
/**
|
|
493
|
+
* Format: uri
|
|
494
|
+
* @description Public avatar URL; present only for a public profile.
|
|
495
|
+
*/
|
|
496
|
+
avatarUrl?: string;
|
|
497
|
+
/** @description Public organization name; present only for a public profile. */
|
|
498
|
+
organizationName?: string;
|
|
499
|
+
/**
|
|
500
|
+
* Format: uri
|
|
501
|
+
* @description HTTPS URL of the user's public profile.
|
|
502
|
+
*/
|
|
503
|
+
publicProfileUrl?: string;
|
|
504
|
+
};
|
|
505
|
+
/** @description One page of event feed items, newest first. */
|
|
506
|
+
EventFeedPage: {
|
|
507
|
+
/** @description Current page number of the result set. */
|
|
508
|
+
page: number;
|
|
509
|
+
/** @description Number of items per page. */
|
|
510
|
+
pageSize: number;
|
|
511
|
+
/** @description Total number of matching feed events. */
|
|
512
|
+
totalCount: number;
|
|
513
|
+
/** @description Events for the requested page, newest first. */
|
|
514
|
+
data: {
|
|
515
|
+
/**
|
|
516
|
+
* Format: uuid
|
|
517
|
+
* @description Event ID.
|
|
518
|
+
*/
|
|
519
|
+
id: string;
|
|
520
|
+
/**
|
|
521
|
+
* Format: uuid
|
|
522
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
523
|
+
*/
|
|
524
|
+
userId: string;
|
|
525
|
+
/** @description Event category. */
|
|
526
|
+
category: string;
|
|
527
|
+
/** @description Event action. */
|
|
528
|
+
action: string;
|
|
529
|
+
/**
|
|
530
|
+
* Format: date-time
|
|
531
|
+
* @description Event creation time; the feed is ordered newest first.
|
|
532
|
+
*/
|
|
533
|
+
createdAt: string;
|
|
534
|
+
/**
|
|
535
|
+
* @description Always `public` in the feed.
|
|
536
|
+
* @default private
|
|
537
|
+
* @enum {string}
|
|
538
|
+
*/
|
|
539
|
+
visibility: "private" | "public";
|
|
540
|
+
/**
|
|
541
|
+
* @description Platform from ScheduleCompletedEventMetadata.
|
|
542
|
+
* @enum {string}
|
|
543
|
+
*/
|
|
544
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
545
|
+
/** @description Role from ScheduleCompletedEventMetadata. */
|
|
546
|
+
role: string;
|
|
547
|
+
/** @description One-line result from ScheduleCompletedEventMetadata. */
|
|
548
|
+
line: string;
|
|
549
|
+
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
550
|
+
networks?: string[];
|
|
551
|
+
/** @description Public username, never a real name; present only for a public profile. */
|
|
552
|
+
displayName?: string;
|
|
553
|
+
/**
|
|
554
|
+
* Format: uri
|
|
555
|
+
* @description Public avatar URL; present only for a public profile.
|
|
556
|
+
*/
|
|
557
|
+
avatarUrl?: string;
|
|
558
|
+
/** @description Public organization name; present only for a public profile. */
|
|
559
|
+
organizationName?: string;
|
|
560
|
+
/**
|
|
561
|
+
* Format: uri
|
|
562
|
+
* @description HTTPS URL of the user's public profile.
|
|
563
|
+
*/
|
|
564
|
+
publicProfileUrl?: string;
|
|
565
|
+
}[];
|
|
566
|
+
};
|
|
379
567
|
/** @description Aggregated event counts across categories. */
|
|
380
568
|
EventsAggregate: {
|
|
381
569
|
/** @description Count of audit-category events. */
|
|
@@ -554,6 +742,20 @@ export interface components {
|
|
|
554
742
|
/** @description Name of the saved design. */
|
|
555
743
|
name?: string;
|
|
556
744
|
};
|
|
745
|
+
/** @description Metadata for a completed scheduled run (category `schedule`, action `completed`). This typed shape keeps client-specific display data out of the core Event fields and is projected into EventFeedItem. */
|
|
746
|
+
ScheduleCompletedEventMetadata: {
|
|
747
|
+
/**
|
|
748
|
+
* @description Platform the completed run acted on.
|
|
749
|
+
* @enum {string}
|
|
750
|
+
*/
|
|
751
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
752
|
+
/** @description Role the completed run acted in. */
|
|
753
|
+
role: string;
|
|
754
|
+
/** @description One-line result of the run. */
|
|
755
|
+
line: string;
|
|
756
|
+
/** @description Networks or communities where the run acted. */
|
|
757
|
+
networks?: string[];
|
|
758
|
+
};
|
|
557
759
|
};
|
|
558
760
|
responses: {
|
|
559
761
|
/** @description Invalid request body or request param */
|
|
@@ -657,6 +859,12 @@ export interface components {
|
|
|
657
859
|
* @description Get responses by pagesize. Deprecated alias of pageSize.
|
|
658
860
|
*/
|
|
659
861
|
pagesizeLegacy: number;
|
|
862
|
+
/** @description Number of feed items per page. */
|
|
863
|
+
feedPagesize: number;
|
|
864
|
+
/** @description Optional event category filter. */
|
|
865
|
+
feedCategory: string;
|
|
866
|
+
/** @description Optional event action filter. */
|
|
867
|
+
feedAction: string;
|
|
660
868
|
/** @description Get responses that match search param value */
|
|
661
869
|
search: string;
|
|
662
870
|
/** @description Get ordered responses */
|
|
@@ -1072,6 +1280,12 @@ export interface operations {
|
|
|
1072
1280
|
totalCount?: number;
|
|
1073
1281
|
/** @description The events returned on the current page. */
|
|
1074
1282
|
data?: {
|
|
1283
|
+
/**
|
|
1284
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.
|
|
1285
|
+
* @default private
|
|
1286
|
+
* @enum {string}
|
|
1287
|
+
*/
|
|
1288
|
+
visibility: "private" | "public";
|
|
1075
1289
|
/**
|
|
1076
1290
|
* Format: uuid
|
|
1077
1291
|
* @description UUID of the user associated with the event.
|
|
@@ -1094,6 +1308,11 @@ export interface operations {
|
|
|
1094
1308
|
firstName?: string;
|
|
1095
1309
|
/** @description The last name of the user associated with the event. */
|
|
1096
1310
|
lastName?: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* Format: uri
|
|
1313
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
1314
|
+
*/
|
|
1315
|
+
avatarUrl?: string;
|
|
1097
1316
|
/**
|
|
1098
1317
|
* Format: email
|
|
1099
1318
|
* @description Email address of the user associated with the event.
|
|
@@ -1286,6 +1505,12 @@ export interface operations {
|
|
|
1286
1505
|
owner?: string;
|
|
1287
1506
|
/** @description The category of the event. */
|
|
1288
1507
|
category?: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* @description Who can see the event. `private` is the default; clients may set `public` for events eligible for the unauthenticated feed.
|
|
1510
|
+
* @default private
|
|
1511
|
+
* @enum {string}
|
|
1512
|
+
*/
|
|
1513
|
+
visibility?: "private" | "public";
|
|
1289
1514
|
/** @description The action of the event. */
|
|
1290
1515
|
action?: string;
|
|
1291
1516
|
/** @description Description of the event. */
|
|
@@ -1321,7 +1546,7 @@ export interface operations {
|
|
|
1321
1546
|
category: string;
|
|
1322
1547
|
/** @description Human-readable summary of what happened. */
|
|
1323
1548
|
description: string;
|
|
1324
|
-
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
|
|
1549
|
+
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); ScheduleCompletedEventMetadata (category `schedule`, action `completed`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
|
|
1325
1550
|
metadata: {
|
|
1326
1551
|
[key: string]: unknown;
|
|
1327
1552
|
} | null;
|
|
@@ -1359,6 +1584,12 @@ export interface operations {
|
|
|
1359
1584
|
* @description Timestamp when the event was last updated.
|
|
1360
1585
|
*/
|
|
1361
1586
|
updatedAt: string;
|
|
1587
|
+
/**
|
|
1588
|
+
* @description Who can see the event. Defaults to `private`.
|
|
1589
|
+
* @default private
|
|
1590
|
+
* @enum {string}
|
|
1591
|
+
*/
|
|
1592
|
+
visibility: "private" | "public";
|
|
1362
1593
|
/**
|
|
1363
1594
|
* Format: date-time
|
|
1364
1595
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
@@ -1390,7 +1621,7 @@ export interface operations {
|
|
|
1390
1621
|
category: string;
|
|
1391
1622
|
/** @description Human-readable summary of what happened. */
|
|
1392
1623
|
description: string;
|
|
1393
|
-
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
|
|
1624
|
+
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); ScheduleCompletedEventMetadata (category `schedule`, action `completed`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
|
|
1394
1625
|
metadata: {
|
|
1395
1626
|
[key: string]: unknown;
|
|
1396
1627
|
} | null;
|
|
@@ -1428,6 +1659,12 @@ export interface operations {
|
|
|
1428
1659
|
* @description Timestamp when the event was last updated.
|
|
1429
1660
|
*/
|
|
1430
1661
|
updatedAt: string;
|
|
1662
|
+
/**
|
|
1663
|
+
* @description Who can see the event. Defaults to `private`.
|
|
1664
|
+
* @default private
|
|
1665
|
+
* @enum {string}
|
|
1666
|
+
*/
|
|
1667
|
+
visibility: "private" | "public";
|
|
1431
1668
|
/**
|
|
1432
1669
|
* Format: date-time
|
|
1433
1670
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
@@ -1527,6 +1764,12 @@ export interface operations {
|
|
|
1527
1764
|
totalCount?: number;
|
|
1528
1765
|
/** @description The events returned on the current page. */
|
|
1529
1766
|
data?: {
|
|
1767
|
+
/**
|
|
1768
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.
|
|
1769
|
+
* @default private
|
|
1770
|
+
* @enum {string}
|
|
1771
|
+
*/
|
|
1772
|
+
visibility: "private" | "public";
|
|
1530
1773
|
/**
|
|
1531
1774
|
* Format: uuid
|
|
1532
1775
|
* @description UUID of the user associated with the event.
|
|
@@ -1549,6 +1792,11 @@ export interface operations {
|
|
|
1549
1792
|
firstName?: string;
|
|
1550
1793
|
/** @description The last name of the user associated with the event. */
|
|
1551
1794
|
lastName?: string;
|
|
1795
|
+
/**
|
|
1796
|
+
* Format: uri
|
|
1797
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
1798
|
+
*/
|
|
1799
|
+
avatarUrl?: string;
|
|
1552
1800
|
/**
|
|
1553
1801
|
* Format: email
|
|
1554
1802
|
* @description Email address of the user associated with the event.
|
|
@@ -1636,6 +1884,140 @@ export interface operations {
|
|
|
1636
1884
|
};
|
|
1637
1885
|
};
|
|
1638
1886
|
};
|
|
1887
|
+
getEventFeed: {
|
|
1888
|
+
parameters: {
|
|
1889
|
+
query?: {
|
|
1890
|
+
/** @description Get responses by page */
|
|
1891
|
+
page?: number;
|
|
1892
|
+
/** @description Number of feed items per page. */
|
|
1893
|
+
pagesize?: number;
|
|
1894
|
+
/** @description Optional event category filter. */
|
|
1895
|
+
category?: string;
|
|
1896
|
+
/** @description Optional event action filter. */
|
|
1897
|
+
action?: string;
|
|
1898
|
+
};
|
|
1899
|
+
header?: never;
|
|
1900
|
+
path?: never;
|
|
1901
|
+
cookie?: never;
|
|
1902
|
+
};
|
|
1903
|
+
requestBody?: never;
|
|
1904
|
+
responses: {
|
|
1905
|
+
/** @description Event feed page */
|
|
1906
|
+
200: {
|
|
1907
|
+
headers: {
|
|
1908
|
+
/** @description `public, max-age=N` with N from 0 to 30; max-age never exceeds 30 seconds. */
|
|
1909
|
+
"Cache-Control": string;
|
|
1910
|
+
[name: string]: unknown;
|
|
1911
|
+
};
|
|
1912
|
+
content: {
|
|
1913
|
+
"application/json": {
|
|
1914
|
+
/** @description Current page number of the result set. */
|
|
1915
|
+
page: number;
|
|
1916
|
+
/** @description Number of items per page. */
|
|
1917
|
+
pageSize: number;
|
|
1918
|
+
/** @description Total number of matching feed events. */
|
|
1919
|
+
totalCount: number;
|
|
1920
|
+
/** @description Events for the requested page, newest first. */
|
|
1921
|
+
data: {
|
|
1922
|
+
/**
|
|
1923
|
+
* Format: uuid
|
|
1924
|
+
* @description Event ID.
|
|
1925
|
+
*/
|
|
1926
|
+
id: string;
|
|
1927
|
+
/**
|
|
1928
|
+
* Format: uuid
|
|
1929
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1930
|
+
*/
|
|
1931
|
+
userId: string;
|
|
1932
|
+
/** @description Event category. */
|
|
1933
|
+
category: string;
|
|
1934
|
+
/** @description Event action. */
|
|
1935
|
+
action: string;
|
|
1936
|
+
/**
|
|
1937
|
+
* Format: date-time
|
|
1938
|
+
* @description Event creation time; the feed is ordered newest first.
|
|
1939
|
+
*/
|
|
1940
|
+
createdAt: string;
|
|
1941
|
+
/**
|
|
1942
|
+
* @description Always `public` in the feed.
|
|
1943
|
+
* @default private
|
|
1944
|
+
* @enum {string}
|
|
1945
|
+
*/
|
|
1946
|
+
visibility: "private" | "public";
|
|
1947
|
+
/**
|
|
1948
|
+
* @description Platform from ScheduleCompletedEventMetadata.
|
|
1949
|
+
* @enum {string}
|
|
1950
|
+
*/
|
|
1951
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
1952
|
+
/** @description Role from ScheduleCompletedEventMetadata. */
|
|
1953
|
+
role: string;
|
|
1954
|
+
/** @description One-line result from ScheduleCompletedEventMetadata. */
|
|
1955
|
+
line: string;
|
|
1956
|
+
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
1957
|
+
networks?: string[];
|
|
1958
|
+
/** @description Public username, never a real name; present only for a public profile. */
|
|
1959
|
+
displayName?: string;
|
|
1960
|
+
/**
|
|
1961
|
+
* Format: uri
|
|
1962
|
+
* @description Public avatar URL; present only for a public profile.
|
|
1963
|
+
*/
|
|
1964
|
+
avatarUrl?: string;
|
|
1965
|
+
/** @description Public organization name; present only for a public profile. */
|
|
1966
|
+
organizationName?: string;
|
|
1967
|
+
/**
|
|
1968
|
+
* Format: uri
|
|
1969
|
+
* @description HTTPS URL of the user's public profile.
|
|
1970
|
+
*/
|
|
1971
|
+
publicProfileUrl?: string;
|
|
1972
|
+
}[];
|
|
1973
|
+
};
|
|
1974
|
+
};
|
|
1975
|
+
};
|
|
1976
|
+
/** @description Invalid request body or request param */
|
|
1977
|
+
400: {
|
|
1978
|
+
headers: {
|
|
1979
|
+
[name: string]: unknown;
|
|
1980
|
+
};
|
|
1981
|
+
content: {
|
|
1982
|
+
"text/plain": string;
|
|
1983
|
+
};
|
|
1984
|
+
};
|
|
1985
|
+
/** @description Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying. */
|
|
1986
|
+
429: {
|
|
1987
|
+
headers: {
|
|
1988
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
1989
|
+
"Retry-After": number;
|
|
1990
|
+
[name: string]: unknown;
|
|
1991
|
+
};
|
|
1992
|
+
content: {
|
|
1993
|
+
"application/json": {
|
|
1994
|
+
/** @description The sentence the caller is shown. */
|
|
1995
|
+
error: string;
|
|
1996
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
1997
|
+
code?: string;
|
|
1998
|
+
/**
|
|
1999
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
2000
|
+
* @enum {string}
|
|
2001
|
+
*/
|
|
2002
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
2003
|
+
/** @description MeshKit's probable causes of the error. */
|
|
2004
|
+
probableCause?: string[];
|
|
2005
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
2006
|
+
suggestedRemediation?: string[];
|
|
2007
|
+
};
|
|
2008
|
+
};
|
|
2009
|
+
};
|
|
2010
|
+
/** @description Internal server error */
|
|
2011
|
+
500: {
|
|
2012
|
+
headers: {
|
|
2013
|
+
[name: string]: unknown;
|
|
2014
|
+
};
|
|
2015
|
+
content: {
|
|
2016
|
+
"text/plain": string;
|
|
2017
|
+
};
|
|
2018
|
+
};
|
|
2019
|
+
};
|
|
2020
|
+
};
|
|
1639
2021
|
getEventSummaryByUser: {
|
|
1640
2022
|
parameters: {
|
|
1641
2023
|
query?: {
|