@meshery/schemas 1.3.112 → 1.3.113

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/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- interface components$B {
1
+ interface components$C {
2
2
  schemas: {
3
3
  /**
4
4
  * @description Meshery manages entities in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.
@@ -109,7 +109,7 @@ interface components$B {
109
109
  pathItems: never;
110
110
  }
111
111
 
112
- interface components$A {
112
+ interface components$B {
113
113
  schemas: {
114
114
  CatalogData: {
115
115
  /** @description Tracks the specific content version that has been made available in the Catalog. */
@@ -149,7 +149,7 @@ interface components$A {
149
149
  pathItems: never;
150
150
  }
151
151
 
152
- interface components$z {
152
+ interface components$A {
153
153
  schemas: {
154
154
  /**
155
155
  * @description Meshery manages entities in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.
@@ -260,7 +260,7 @@ interface components$z {
260
260
  pathItems: never;
261
261
  }
262
262
 
263
- interface components$y {
263
+ interface components$z {
264
264
  schemas: {
265
265
  /** @description Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components */
266
266
  ComponentDefinition: {
@@ -1022,7 +1022,7 @@ interface components$y {
1022
1022
  pathItems: never;
1023
1023
  }
1024
1024
 
1025
- interface components$x {
1025
+ interface components$y {
1026
1026
  schemas: {
1027
1027
  /** @description Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections */
1028
1028
  Connection: {
@@ -1434,7 +1434,7 @@ interface components$x {
1434
1434
  pathItems: never;
1435
1435
  }
1436
1436
 
1437
- interface components$w {
1437
+ interface components$x {
1438
1438
  schemas: {
1439
1439
  /** @description Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems. */
1440
1440
  Credential: {
@@ -1571,7 +1571,7 @@ interface components$w {
1571
1571
  pathItems: never;
1572
1572
  }
1573
1573
 
1574
- interface components$v {
1574
+ interface components$w {
1575
1575
  schemas: {
1576
1576
  /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1577
1577
  Model: {
@@ -2319,7 +2319,7 @@ interface components$v {
2319
2319
  pathItems: never;
2320
2320
  }
2321
2321
 
2322
- interface components$u {
2322
+ interface components$v {
2323
2323
  schemas: {
2324
2324
  /** @description Represents a user */
2325
2325
  User: {
@@ -3316,7 +3316,7 @@ interface components$u {
3316
3316
  pathItems: never;
3317
3317
  }
3318
3318
 
3319
- interface components$t {
3319
+ interface components$u {
3320
3320
  schemas: {
3321
3321
  DeletePatternModel: {
3322
3322
  /** Format: uuid */
@@ -10644,7 +10644,7 @@ interface components$t {
10644
10644
  pathItems: never;
10645
10645
  }
10646
10646
 
10647
- interface components$s {
10647
+ interface components$t {
10648
10648
  schemas: {
10649
10649
  /** @description Category of the model. */
10650
10650
  CategoryDefinition: {
@@ -10670,7 +10670,7 @@ interface components$s {
10670
10670
  pathItems: never;
10671
10671
  }
10672
10672
 
10673
- interface components$r {
10673
+ interface components$s {
10674
10674
  schemas: {
10675
10675
  /**
10676
10676
  * SubCategory
@@ -10687,7 +10687,7 @@ interface components$r {
10687
10687
  pathItems: never;
10688
10688
  }
10689
10689
 
10690
- interface components$q {
10690
+ interface components$r {
10691
10691
  schemas: {
10692
10692
  /**
10693
10693
  * Environment
@@ -10943,7 +10943,7 @@ interface components$q {
10943
10943
  pathItems: never;
10944
10944
  }
10945
10945
 
10946
- interface components$p {
10946
+ interface components$q {
10947
10947
  schemas: {
10948
10948
  EvaluationRequest: {
10949
10949
  /**
@@ -13905,7 +13905,7 @@ interface components$p {
13905
13905
  pathItems: never;
13906
13906
  }
13907
13907
 
13908
- interface components$o {
13908
+ interface components$p {
13909
13909
  schemas: {
13910
13910
  /** @description A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design. */
13911
13911
  Feature: {
@@ -14094,7 +14094,7 @@ interface components$o {
14094
14094
  pathItems: never;
14095
14095
  }
14096
14096
 
14097
- interface components$n {
14097
+ interface components$o {
14098
14098
  schemas: {
14099
14099
  /** @description Represents an authorization key used for access control. */
14100
14100
  Key: {
@@ -14247,7 +14247,7 @@ interface components$n {
14247
14247
  pathItems: never;
14248
14248
  }
14249
14249
 
14250
- interface components$m {
14250
+ interface components$n {
14251
14251
  schemas: {
14252
14252
  /** @description Represents a collection of keys. */
14253
14253
  Keychain: {
@@ -14382,7 +14382,7 @@ interface components$m {
14382
14382
  pathItems: never;
14383
14383
  }
14384
14384
 
14385
- interface components$l {
14385
+ interface components$m {
14386
14386
  schemas: {
14387
14387
  /**
14388
14388
  * Format: uuid
@@ -15091,7 +15091,7 @@ interface components$l {
15091
15091
  pathItems: never;
15092
15092
  }
15093
15093
 
15094
- interface components$k {
15094
+ interface components$l {
15095
15095
  schemas: {
15096
15096
  /** @description Role definition */
15097
15097
  Role: {
@@ -15311,7 +15311,7 @@ interface components$k {
15311
15311
  pathItems: never;
15312
15312
  }
15313
15313
 
15314
- interface components$j {
15314
+ interface components$k {
15315
15315
  schemas: {
15316
15316
  /** @description A schedule defines a recurring cron-based trigger for performance tests or other automated tasks. */
15317
15317
  Schedule: {
@@ -15432,7 +15432,7 @@ interface components$j {
15432
15432
  pathItems: never;
15433
15433
  }
15434
15434
 
15435
- interface components$i {
15435
+ interface components$j {
15436
15436
  schemas: {
15437
15437
  /** @description Request body for sending a test email through the configured SMTP provider. */
15438
15438
  EmailTestRequest: {
@@ -15927,7 +15927,7 @@ interface components$i {
15927
15927
  pathItems: never;
15928
15928
  }
15929
15929
 
15930
- interface components$h {
15930
+ interface components$i {
15931
15931
  schemas: {
15932
15932
  /** @description A Team is a group of one or more users. Teams are often used as a grouping mechanism for assigning permissions, whether in the context of an organization, a workspace, or some other domain within Meshery. Learn more at https://docs.meshery.io/concepts/logical/teams */
15933
15933
  Team: {
@@ -16164,7 +16164,7 @@ interface components$h {
16164
16164
  pathItems: never;
16165
16165
  }
16166
16166
 
16167
- interface components$g {
16167
+ interface components$h {
16168
16168
  schemas: {
16169
16169
  /** @description A workspace is a logical grouping of resources within an organization. Workspaces provide a way to organize environments, designs, teams, and views. Learn more at https://docs.meshery.io/concepts/logical/workspaces */
16170
16170
  Workspace: {
@@ -18193,7 +18193,7 @@ interface components$g {
18193
18193
  pathItems: never;
18194
18194
  }
18195
18195
 
18196
- interface components$f {
18196
+ interface components$g {
18197
18197
  schemas: {
18198
18198
  /**
18199
18199
  * Format: uuid
@@ -18411,7 +18411,7 @@ interface components$f {
18411
18411
  pathItems: never;
18412
18412
  }
18413
18413
 
18414
- interface components$e {
18414
+ interface components$f {
18415
18415
  schemas: {
18416
18416
  /** @description Payload for creating or updating a badge. */
18417
18417
  BadgePayload: {
@@ -18604,7 +18604,7 @@ interface components$e {
18604
18604
  pathItems: never;
18605
18605
  }
18606
18606
 
18607
- interface components$d {
18607
+ interface components$e {
18608
18608
  schemas: {
18609
18609
  /**
18610
18610
  * @description Organization ID that owns this learning path
@@ -22641,7 +22641,7 @@ interface components$d {
22641
22641
  pathItems: never;
22642
22642
  }
22643
22643
 
22644
- interface components$c {
22644
+ interface components$d {
22645
22645
  schemas: {
22646
22646
  CatalogData: {
22647
22647
  /** @description Tracks the specific content version that has been made available in the Catalog. */
@@ -22681,7 +22681,7 @@ interface components$c {
22681
22681
  pathItems: never;
22682
22682
  }
22683
22683
 
22684
- interface components$b {
22684
+ interface components$c {
22685
22685
  schemas: {
22686
22686
  /** @description Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components */
22687
22687
  ComponentDefinition: {
@@ -23461,7 +23461,7 @@ interface components$b {
23461
23461
  pathItems: never;
23462
23462
  }
23463
23463
 
23464
- interface components$a {
23464
+ interface components$b {
23465
23465
  schemas: {
23466
23466
  /** @description Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections */
23467
23467
  Connection: {
@@ -23893,7 +23893,7 @@ interface components$a {
23893
23893
  pathItems: never;
23894
23894
  }
23895
23895
 
23896
- interface components$9 {
23896
+ interface components$a {
23897
23897
  schemas: {
23898
23898
  DeletePatternModel: {
23899
23899
  /** Format: uuid */
@@ -31504,7 +31504,7 @@ interface components$9 {
31504
31504
  pathItems: never;
31505
31505
  }
31506
31506
 
31507
- interface components$8 {
31507
+ interface components$9 {
31508
31508
  schemas: {
31509
31509
  UpdateEventStatusRequest: {
31510
31510
  /**
@@ -31681,7 +31681,7 @@ interface components$8 {
31681
31681
  pathItems: never;
31682
31682
  }
31683
31683
 
31684
- interface components$7 {
31684
+ interface components$8 {
31685
31685
  schemas: {
31686
31686
  /**
31687
31687
  * Format: uuid
@@ -31922,7 +31922,7 @@ interface components$7 {
31922
31922
  pathItems: never;
31923
31923
  }
31924
31924
 
31925
- interface components$6 {
31925
+ interface components$7 {
31926
31926
  schemas: {
31927
31927
  /**
31928
31928
  * Format: uuid
@@ -33836,7 +33836,7 @@ interface components$6 {
33836
33836
  pathItems: never;
33837
33837
  }
33838
33838
 
33839
- interface components$5 {
33839
+ interface components$6 {
33840
33840
  schemas: {
33841
33841
  PlanPage: {
33842
33842
  /** @description Current page number of the result set. */
@@ -33939,7 +33939,7 @@ interface components$5 {
33939
33939
  pathItems: never;
33940
33940
  }
33941
33941
 
33942
- interface components$4 {
33942
+ interface components$5 {
33943
33943
  schemas: {
33944
33944
  /** @description Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships. */
33945
33945
  RelationshipDefinition: {
@@ -35913,7 +35913,7 @@ interface components$4 {
35913
35913
  pathItems: never;
35914
35914
  }
35915
35915
 
35916
- interface components$3 {
35916
+ interface components$4 {
35917
35917
  schemas: {
35918
35918
  /**
35919
35919
  * @description Supported payment processors
@@ -36168,7 +36168,7 @@ interface components$3 {
36168
36168
  pathItems: never;
36169
36169
  }
36170
36170
 
36171
- interface components$2 {
36171
+ interface components$3 {
36172
36172
  schemas: {
36173
36173
  /** @description Represents a user-owned API token or OAuth session. */
36174
36174
  UserToken: {
@@ -36317,6 +36317,501 @@ interface components$2 {
36317
36317
  pathItems: never;
36318
36318
  }
36319
36319
 
36320
+ interface components$2 {
36321
+ schemas: {
36322
+ /** @description Payload for creating a new event. */
36323
+ EventPayload: {
36324
+ /**
36325
+ * Format: uuid
36326
+ * @description UUID of the user associated with the event.
36327
+ */
36328
+ owner?: string;
36329
+ /** @description The category of the event. */
36330
+ category?: string;
36331
+ /** @description The action of the event. */
36332
+ action?: string;
36333
+ /** @description Description of the event. */
36334
+ description?: string;
36335
+ /** @description Optional client-chosen key that makes recording this event safe to retry. Keys are scoped to the authenticated caller (organization and user), never to the client-settable `owner` field, so `owner` may be omitted without affecting deduplication. The first event a caller records with a key is kept, and a later create with the same key records nothing and answers 200 with that event, whatever the rest of the payload says. Use a value that names the occurrence, for example a run id, so a client replaying a local queue after a timeout never records a duplicate. Omit it for events that need no deduplication. */
36336
+ idempotencyKey?: string;
36337
+ } & {
36338
+ [key: string]: unknown;
36339
+ };
36340
+ /** @description Payload for updating the status of a single event. */
36341
+ UpdateEventStatusRequest: {
36342
+ /**
36343
+ * @description Current status of the event.
36344
+ * @example completed
36345
+ */
36346
+ status: string;
36347
+ };
36348
+ /** @description Response body returned after updating an event's status. */
36349
+ UpdateEventStatusResponse: {
36350
+ /** @description Human-readable status message. */
36351
+ message?: string;
36352
+ /**
36353
+ * Format: uuid
36354
+ * @description UUID of the event whose status was updated.
36355
+ */
36356
+ eventId?: string;
36357
+ /** @description Updated status of the event. */
36358
+ status?: string;
36359
+ };
36360
+ /** @description Payload for bulk-deleting events by ID. */
36361
+ BulkDeleteRequest: {
36362
+ /** @description UUIDs of the events to delete. */
36363
+ ids: string[];
36364
+ };
36365
+ /** @description Response body returned after bulk event deletion. */
36366
+ BulkDeleteResponse: {
36367
+ /** @description UUIDs of events that were deleted. */
36368
+ deleted?: string[];
36369
+ };
36370
+ /** @description Payload for bulk-updating the status of events. */
36371
+ BulkUpdateStatusRequest: {
36372
+ /** @description UUIDs of the events to update. */
36373
+ ids: string[];
36374
+ /**
36375
+ * @description New status to apply to the selected events.
36376
+ * @example failed
36377
+ */
36378
+ status: string;
36379
+ };
36380
+ /** @description Response body returned after bulk event status update. */
36381
+ BulkUpdateStatusResponse: {
36382
+ /** @description UUIDs of events whose status was updated. */
36383
+ updated?: string[];
36384
+ };
36385
+ /** @description EventResult entity schema. */
36386
+ EventResult: {
36387
+ /**
36388
+ * Format: uuid
36389
+ * @description UUID of the user associated with the event.
36390
+ */
36391
+ owner: string;
36392
+ /** @description System identifier of the event source: a Meshery Server instance ID, the nil UUID for an event the provider emits itself, or the connection ID of the client machine that emitted it (for example a desktop client recording a run). Asserted by the sender, not checked. */
36393
+ systemId?: string;
36394
+ /**
36395
+ * Format: uuid
36396
+ * @description The organization the event belongs to (see Event.organizationId). Set by the server; lets an organization-scope listing show each row's tenant.
36397
+ */
36398
+ readonly organizationId?: string;
36399
+ /** @description The category of the event. */
36400
+ category: string;
36401
+ /** @description The action of the event. */
36402
+ action: string;
36403
+ /** @description Description of the event. */
36404
+ description?: string;
36405
+ /** @description The first name of the user associated with the event. */
36406
+ firstName?: string;
36407
+ /** @description The last name of the user associated with the event. */
36408
+ lastName?: string;
36409
+ /**
36410
+ * Format: email
36411
+ * @description Email address of the user associated with the event.
36412
+ */
36413
+ email?: string;
36414
+ /** @description Authentication provider of the user associated with the event. */
36415
+ provider?: string;
36416
+ /**
36417
+ * Format: date-time
36418
+ * @description Timestamp when the event was recorded.
36419
+ */
36420
+ createdAt?: string;
36421
+ };
36422
+ /** @description One recorded event (an `event_trackers` row) in the wire form MeshKit's `models/events.Event` serializes. Meshery Cloud returns these, for example, as the per-path failure records of a GitHub repository import (`importGithubRepository`, `errors`). Unlike EventResult, it carries no joined user profile fields. */
36423
+ Event: {
36424
+ /**
36425
+ * Format: uuid
36426
+ * @description Event ID.
36427
+ */
36428
+ id: string;
36429
+ /**
36430
+ * Format: uuid
36431
+ * @description ID of the entity on which the event was performed.
36432
+ */
36433
+ actedUpon: string;
36434
+ /** @description Action taken on the resource, for example `import`. */
36435
+ action: string;
36436
+ /** @description Resource kind the operation was invoked on, for example `pattern`. */
36437
+ category: string;
36438
+ /** @description Human-readable summary of what happened. */
36439
+ description: string;
36440
+ /** @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. 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. */
36441
+ metadata: {
36442
+ [key: string]: unknown;
36443
+ } | null;
36444
+ /**
36445
+ * Format: uuid
36446
+ * @description ID correlating the events one operation emitted.
36447
+ */
36448
+ operationId: string;
36449
+ /** @description Event level. MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire - the event write APIs persist the value they are given - so consumers must tolerate other values. */
36450
+ severity: string;
36451
+ /** @description Read state of the event. MeshKit records new events as `unread`, and acknowledged ones become `read`; the event status APIs persist any value they are given, so consumers must tolerate other values. */
36452
+ status: string;
36453
+ /**
36454
+ * Format: uuid
36455
+ * @description ID of the system instance that emitted the event. A Meshery Server sends its server instance ID; an event the provider emits itself carries the nil UUID. A client that registered a connection for its machine (for example a desktop client) sets its connection ID, so an event that records a run names the computer that ran it and can be joined to the claim it released (`Claim.outcomeEventId`) and to the connection (`connections.id`). The value is asserted by the sender and is not checked against the caller's connections.
36456
+ */
36457
+ systemId: string;
36458
+ /**
36459
+ * Format: uuid
36460
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
36461
+ */
36462
+ owner?: string;
36463
+ /**
36464
+ * Format: uuid
36465
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
36466
+ */
36467
+ readonly organizationId: string;
36468
+ /**
36469
+ * Format: date-time
36470
+ * @description Timestamp when the event was recorded.
36471
+ */
36472
+ createdAt: string;
36473
+ /**
36474
+ * Format: date-time
36475
+ * @description Timestamp when the event was last updated.
36476
+ */
36477
+ updatedAt: string;
36478
+ /**
36479
+ * Format: date-time
36480
+ * @description Timestamp when the event was soft-deleted; omitted when it was not.
36481
+ */
36482
+ deletedAt?: string | null;
36483
+ };
36484
+ /** @description Paginated list of events. */
36485
+ EventsPage: {
36486
+ /** @description Zero-based page index returned in this response. */
36487
+ page?: number;
36488
+ /** @description Maximum number of items returned on each page. */
36489
+ pageSize?: number;
36490
+ /** @description Total number of items across all pages. */
36491
+ totalCount?: number;
36492
+ /** @description The events returned on the current page. */
36493
+ data?: {
36494
+ /**
36495
+ * Format: uuid
36496
+ * @description UUID of the user associated with the event.
36497
+ */
36498
+ owner: string;
36499
+ /** @description System identifier of the event source: a Meshery Server instance ID, the nil UUID for an event the provider emits itself, or the connection ID of the client machine that emitted it (for example a desktop client recording a run). Asserted by the sender, not checked. */
36500
+ systemId?: string;
36501
+ /**
36502
+ * Format: uuid
36503
+ * @description The organization the event belongs to (see Event.organizationId). Set by the server; lets an organization-scope listing show each row's tenant.
36504
+ */
36505
+ readonly organizationId?: string;
36506
+ /** @description The category of the event. */
36507
+ category: string;
36508
+ /** @description The action of the event. */
36509
+ action: string;
36510
+ /** @description Description of the event. */
36511
+ description?: string;
36512
+ /** @description The first name of the user associated with the event. */
36513
+ firstName?: string;
36514
+ /** @description The last name of the user associated with the event. */
36515
+ lastName?: string;
36516
+ /**
36517
+ * Format: email
36518
+ * @description Email address of the user associated with the event.
36519
+ */
36520
+ email?: string;
36521
+ /** @description Authentication provider of the user associated with the event. */
36522
+ provider?: string;
36523
+ /**
36524
+ * Format: date-time
36525
+ * @description Timestamp when the event was recorded.
36526
+ */
36527
+ createdAt?: string;
36528
+ }[];
36529
+ };
36530
+ /** @description Aggregated event counts across categories. */
36531
+ EventsAggregate: {
36532
+ /** @description Count of audit-category events. */
36533
+ audit?: number;
36534
+ } & {
36535
+ [key: string]: unknown;
36536
+ };
36537
+ /** @description Per-user event summary entry. */
36538
+ EventSummary: {
36539
+ [key: string]: unknown;
36540
+ };
36541
+ /** @description Paginated list of per-user event summaries. */
36542
+ EventSummaryPage: {
36543
+ /** @description Current page number of the result set. */
36544
+ page?: number;
36545
+ /** @description Number of items per page. */
36546
+ pageSize?: number;
36547
+ /** @description Total number of items available. */
36548
+ totalCount?: number;
36549
+ /** @description The event summaries returned on the current page. */
36550
+ data?: {
36551
+ [key: string]: unknown;
36552
+ }[];
36553
+ };
36554
+ /** @description A category/action pair describing one kind of event. */
36555
+ EventType: {
36556
+ /** @description The category of the event type. */
36557
+ category?: string;
36558
+ /** @description The action of the event type. */
36559
+ action?: string;
36560
+ };
36561
+ /** @description Generic error envelope returned for non-2xx responses. */
36562
+ ErrorResponse: {
36563
+ /** @description Human-readable error message. */
36564
+ error?: string;
36565
+ };
36566
+ /** @description The fields that identify the design a design event is about. Every design event that names a design carries them, and they are what remains when Meshery Server's 16 KB guard drops oversized metadata. Event metadata names a design, it never carries one: 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 these identity fields. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys instead of `designName` and `viewLink`; readers should fall back to them. */
36567
+ DesignEventIdentity: {
36568
+ /**
36569
+ * Format: uuid
36570
+ * @description ID of the design the event is about.
36571
+ */
36572
+ designId: string;
36573
+ /** @description Name of the design when the event was recorded. */
36574
+ designName?: string;
36575
+ /** @description Version of the design when the event was recorded, for example `v0.0.3`; omitted when the producer does not know it. */
36576
+ designVersion?: string;
36577
+ /**
36578
+ * Format: uri
36579
+ * @description Link that opens the design in the designer view, for example `<base>/extension/meshmap?mode=design&design=<designId>`.
36580
+ */
36581
+ designLink?: string;
36582
+ /**
36583
+ * Format: uri
36584
+ * @description Link that opens the design in the operator view, for example `<base>/extension/meshmap?mode=operator&type=view&design_id=<designId>`; omitted when the producer has no operator view to link.
36585
+ */
36586
+ viewLink?: string;
36587
+ };
36588
+ /** @description Metadata of a relationship evaluation event (category `relationship`, action `evaluation`): the design's identity fields (DesignEventIdentity) plus counts of what the evaluation changed. It summarizes the evaluation; it does not carry it. 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. */
36589
+ RelationshipEvaluationEventMetadata: {
36590
+ /**
36591
+ * Format: uuid
36592
+ * @description ID of the design the event is about.
36593
+ */
36594
+ designId: string;
36595
+ /** @description Name of the design when the event was recorded. */
36596
+ designName?: string;
36597
+ /** @description Version of the design when the event was recorded, for example `v0.0.3`; omitted when the producer does not know it. */
36598
+ designVersion?: string;
36599
+ /**
36600
+ * Format: uri
36601
+ * @description Link that opens the design in the designer view, for example `<base>/extension/meshmap?mode=design&design=<designId>`.
36602
+ */
36603
+ designLink?: string;
36604
+ /**
36605
+ * Format: uri
36606
+ * @description Link that opens the design in the operator view, for example `<base>/extension/meshmap?mode=operator&type=view&design_id=<designId>`; omitted when the producer has no operator view to link.
36607
+ */
36608
+ viewLink?: string;
36609
+ /** @description One-line title of the evaluation for the design's history, for example `3 changes made at version v0.0.3`. */
36610
+ historyTitle?: string;
36611
+ /**
36612
+ * Format: date-time
36613
+ * @description When the evaluation ran.
36614
+ */
36615
+ evaluatedAt?: string;
36616
+ /** @description Number of relationships the evaluation added to the design. */
36617
+ relationshipsAdded?: number;
36618
+ /** @description Number of relationships the evaluation removed from the design. */
36619
+ relationshipsRemoved?: number;
36620
+ /** @description Number of existing relationships the evaluation updated. */
36621
+ relationshipsUpdated?: number;
36622
+ /** @description Outcome of the evaluation as the evaluator reports it, for example `completed`; consumers must tolerate values they do not know. */
36623
+ evaluationStatus?: string;
36624
+ /** @description How long the evaluation took, in milliseconds. */
36625
+ evaluationDurationMs?: number;
36626
+ };
36627
+ /** @description Metadata of a design validate, deploy, undeploy or dry-run event (category `pattern`, action `validate`, `deploy`, `undeploy` or `dry-run`): the design's identity fields (DesignEventIdentity) plus the outcome and at most 20 of its errors. It summarizes the result; it does not carry it. 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. */
36628
+ DesignValidationEventMetadata: {
36629
+ /**
36630
+ * Format: uuid
36631
+ * @description ID of the design the event is about.
36632
+ */
36633
+ designId: string;
36634
+ /** @description Name of the design when the event was recorded. */
36635
+ designName?: string;
36636
+ /** @description Version of the design when the event was recorded, for example `v0.0.3`; omitted when the producer does not know it. */
36637
+ designVersion?: string;
36638
+ /**
36639
+ * Format: uri
36640
+ * @description Link that opens the design in the designer view, for example `<base>/extension/meshmap?mode=design&design=<designId>`.
36641
+ */
36642
+ designLink?: string;
36643
+ /**
36644
+ * Format: uri
36645
+ * @description Link that opens the design in the operator view, for example `<base>/extension/meshmap?mode=operator&type=view&design_id=<designId>`; omitted when the producer has no operator view to link.
36646
+ */
36647
+ viewLink?: string;
36648
+ /** @description Outcome of the operation as the producer reports it, for example `failed`; consumers must tolerate values they do not know. */
36649
+ status?: string;
36650
+ /** @description Total number of errors the operation found. It may exceed the number of entries in `errors`, which lists at most 20. */
36651
+ errorCount?: number;
36652
+ /** @description Up to 20 of the errors the operation found, each naming its error code and the component it is about. `truncated` says whether more were found than are listed. */
36653
+ errors?: {
36654
+ /** @description The error's code: a JSON-schema validator keyword such as `required` or `type` when design validation rejected the design, or a MeshKit error code (for example `meshery-server-1234`) when a server-side step failed. Consumers must tolerate codes they do not know. */
36655
+ code: string;
36656
+ /** @description ID of the design component the error is about, as the design names it; omitted when the error is about the design as a whole. It is not checked as a UUID, because an invalid design can carry any value here and one bad value must not make the event unreadable. */
36657
+ componentId?: string;
36658
+ }[];
36659
+ /** @description True when `errorCount` is greater than the number of entries in `errors`, so the list is not complete. */
36660
+ truncated?: boolean;
36661
+ };
36662
+ /** @description One error a design validate, deploy, undeploy or dry-run operation found: a code and the component it is about, never the offending component itself. */
36663
+ DesignValidationEventError: {
36664
+ /** @description The error's code: a JSON-schema validator keyword such as `required` or `type` when design validation rejected the design, or a MeshKit error code (for example `meshery-server-1234`) when a server-side step failed. Consumers must tolerate codes they do not know. */
36665
+ code: string;
36666
+ /** @description ID of the design component the error is about, as the design names it; omitted when the error is about the design as a whole. It is not checked as a UUID, because an invalid design can carry any value here and one bad value must not make the event unreadable. */
36667
+ componentId?: string;
36668
+ };
36669
+ /** @description Metadata of a design saved event (category `pattern`, action `create` or `update`): a history title and the saved design's ID and name, never its contents. 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. */
36670
+ DesignSavedEventMetadata: {
36671
+ /** @description One-line title of the save for the design's history, for example `Version v0.0.3 - 12 components and 9 relationships`. */
36672
+ historyTitle?: string;
36673
+ /** @description The saved design's ID and name. */
36674
+ design: {
36675
+ /**
36676
+ * Format: uuid
36677
+ * @description ID of the saved design.
36678
+ */
36679
+ id: string;
36680
+ /** @description Name of the saved design. */
36681
+ name?: string;
36682
+ };
36683
+ };
36684
+ /** @description The ID and name of the design a saved event is about - only those two fields, never the design file or any of its contents. */
36685
+ DesignSavedEventDesign: {
36686
+ /**
36687
+ * Format: uuid
36688
+ * @description ID of the saved design.
36689
+ */
36690
+ id: string;
36691
+ /** @description Name of the saved design. */
36692
+ name?: string;
36693
+ };
36694
+ };
36695
+ responses: {
36696
+ /** @description Invalid request body or request param */
36697
+ 400: {
36698
+ headers: {
36699
+ [name: string]: unknown;
36700
+ };
36701
+ content: {
36702
+ "text/plain": string;
36703
+ };
36704
+ };
36705
+ /** @description Expired JWT token used or insufficient privilege */
36706
+ 401: {
36707
+ headers: {
36708
+ [name: string]: unknown;
36709
+ };
36710
+ content: {
36711
+ "text/plain": string;
36712
+ };
36713
+ };
36714
+ /** @description Result not found */
36715
+ 404: {
36716
+ headers: {
36717
+ [name: string]: unknown;
36718
+ };
36719
+ content: {
36720
+ "text/plain": string;
36721
+ };
36722
+ };
36723
+ /** @description Internal server error */
36724
+ 500: {
36725
+ headers: {
36726
+ [name: string]: unknown;
36727
+ };
36728
+ content: {
36729
+ "text/plain": string;
36730
+ };
36731
+ };
36732
+ /** @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. */
36733
+ MeshkitError429: {
36734
+ headers: {
36735
+ /** @description Number of seconds the caller must wait before retrying. */
36736
+ "Retry-After": number;
36737
+ [name: string]: unknown;
36738
+ };
36739
+ content: {
36740
+ "application/json": {
36741
+ /** @description The sentence the caller is shown. */
36742
+ error: string;
36743
+ /** @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. */
36744
+ code?: string;
36745
+ /**
36746
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
36747
+ * @enum {string}
36748
+ */
36749
+ severity?: "emergency" | "alert" | "critical" | "fatal";
36750
+ /** @description MeshKit's probable causes of the error. */
36751
+ probableCause?: string[];
36752
+ /** @description MeshKit's suggested remediations for the error. */
36753
+ suggestedRemediation?: string[];
36754
+ };
36755
+ };
36756
+ };
36757
+ /** @description Forbidden */
36758
+ MeshkitError403: {
36759
+ headers: {
36760
+ [name: string]: unknown;
36761
+ };
36762
+ content: {
36763
+ "application/json": {
36764
+ /** @description The sentence the caller is shown. */
36765
+ error: string;
36766
+ /** @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. */
36767
+ code?: string;
36768
+ /**
36769
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
36770
+ * @enum {string}
36771
+ */
36772
+ severity?: "emergency" | "alert" | "critical" | "fatal";
36773
+ /** @description MeshKit's probable causes of the error. */
36774
+ probableCause?: string[];
36775
+ /** @description MeshKit's suggested remediations for the error. */
36776
+ suggestedRemediation?: string[];
36777
+ };
36778
+ };
36779
+ };
36780
+ };
36781
+ parameters: {
36782
+ /** @description ID of the event. */
36783
+ eventId: string;
36784
+ /** @description Workspace ID */
36785
+ workspaceId: string;
36786
+ /** @description Get responses by page */
36787
+ page: number;
36788
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
36789
+ pageSize: number;
36790
+ /** @description Get responses by pagesize */
36791
+ pagesize: number;
36792
+ /**
36793
+ * @deprecated
36794
+ * @description Get responses by pagesize. Deprecated alias of pageSize.
36795
+ */
36796
+ pagesizeLegacy: number;
36797
+ /** @description Get responses that match search param value */
36798
+ search: string;
36799
+ /** @description Get ordered responses */
36800
+ order: string;
36801
+ /** @description When true, return cumulative aggregate counts across all time. */
36802
+ cumulative: boolean;
36803
+ /** @description Get filtered reponses */
36804
+ filter: string;
36805
+ /** @description Get filtered reponses */
36806
+ eventsFilter: string;
36807
+ /** @description Which events are returned. `user` (default): only the caller's own events (unchanged behavior). `organization`: every member's events in the caller's session organization. Requires organization administration permission in the session organization; callers without it get 403. */
36808
+ eventsScope: "user" | "organization";
36809
+ };
36810
+ requestBodies: never;
36811
+ headers: never;
36812
+ pathItems: never;
36813
+ }
36814
+
36320
36815
  interface components$1 {
36321
36816
  schemas: {
36322
36817
  /** @description Represents a user */
@@ -38127,54 +38622,60 @@ declare const SupportRequestRjsfSchemaV1Beta1: RJSFSchema;
38127
38622
  declare const SupportRequestRjsfUiSchemaV1Beta1: UiSchema;
38128
38623
 
38129
38624
  declare namespace v1alpha1 {
38130
- type CatalogData = components$A["schemas"]["CatalogData"];
38131
- type Capability = components$B["schemas"];
38625
+ type CatalogData = components$B["schemas"]["CatalogData"];
38626
+ type Capability = components$C["schemas"];
38132
38627
  }
38133
38628
  declare namespace v1alpha2 {
38134
- type CatalogData = components$A["schemas"]["CatalogData"];
38629
+ type CatalogData = components$B["schemas"]["CatalogData"];
38135
38630
  }
38136
38631
  declare namespace v1beta1 {
38137
- type Badge = components$e["schemas"]["Badge"];
38138
- type Capability = components$z["schemas"]["Capability"];
38139
- type Category = components$s["schemas"]["CategoryDefinition"];
38140
- type Component = components$y["schemas"]["ComponentDefinition"];
38141
- type Connection = components$x["schemas"]["Connection"];
38142
- type ConnectionStatusValue = components$x["schemas"]["ConnectionStatusValue"];
38143
- type ControllerStatusValue = components$i["schemas"]["ControllerStatusValue"];
38144
- type Credential = components$w["schemas"]["Credential"];
38145
- type Design = components$t["schemas"]["PatternFile"];
38146
- type Environment = components$q["schemas"]["Environment"];
38147
- type EvaluationRequest = components$p["schemas"]["EvaluationRequest"];
38148
- type EvaluationResponse = components$p["schemas"]["EvaluationResponse"];
38149
- type Feature = components$o["schemas"]["Feature"];
38150
- type Invitation = components$f["schemas"]["Invitation"];
38151
- type Key = components$n["schemas"]["Key"];
38152
- type Keychain = components$m["schemas"]["Keychain"];
38153
- type Model = components$v["schemas"]["ModelDefinition"];
38154
- type Organization = components$l["schemas"]["Organization"];
38155
- type Role = components$k["schemas"]["Role"];
38156
- type Schedule = components$j["schemas"]["Schedule"];
38157
- type Subcategory = components$r["schemas"]["SubCategoryDefinition"];
38158
- type Team = components$h["schemas"]["Team"];
38159
- type User = components$u["schemas"]["User"];
38160
- type Workspace = components$g["schemas"]["Workspace"];
38632
+ type Badge = components$f["schemas"]["Badge"];
38633
+ type Capability = components$A["schemas"]["Capability"];
38634
+ type Category = components$t["schemas"]["CategoryDefinition"];
38635
+ type Component = components$z["schemas"]["ComponentDefinition"];
38636
+ type Connection = components$y["schemas"]["Connection"];
38637
+ type ConnectionStatusValue = components$y["schemas"]["ConnectionStatusValue"];
38638
+ type ControllerStatusValue = components$j["schemas"]["ControllerStatusValue"];
38639
+ type Credential = components$x["schemas"]["Credential"];
38640
+ type Design = components$u["schemas"]["PatternFile"];
38641
+ type Environment = components$r["schemas"]["Environment"];
38642
+ type EvaluationRequest = components$q["schemas"]["EvaluationRequest"];
38643
+ type EvaluationResponse = components$q["schemas"]["EvaluationResponse"];
38644
+ type Feature = components$p["schemas"]["Feature"];
38645
+ type Invitation = components$g["schemas"]["Invitation"];
38646
+ type Key = components$o["schemas"]["Key"];
38647
+ type Keychain = components$n["schemas"]["Keychain"];
38648
+ type Model = components$w["schemas"]["ModelDefinition"];
38649
+ type Organization = components$m["schemas"]["Organization"];
38650
+ type Role = components$l["schemas"]["Role"];
38651
+ type Schedule = components$k["schemas"]["Schedule"];
38652
+ type Subcategory = components$s["schemas"]["SubCategoryDefinition"];
38653
+ type Team = components$i["schemas"]["Team"];
38654
+ type User = components$v["schemas"]["User"];
38655
+ type Workspace = components$h["schemas"]["Workspace"];
38161
38656
  }
38162
38657
 
38163
38658
  declare namespace v1beta2 {
38164
- type Academy = components$d["schemas"]["AcademyCurricula"];
38165
- type CatalogData = components$c["schemas"]["CatalogData"];
38166
- type Component = components$b["schemas"]["ComponentDefinition"];
38167
- type Connection = components$a["schemas"]["Connection"];
38168
- type Design = components$9["schemas"]["PatternFile"];
38169
- type EventResult = components$8["schemas"]["EventResult"];
38170
- type Invitation = components$7["schemas"]["Invitation"];
38171
- type Organization = components$6["schemas"]["Organization"];
38172
- type Plan = components$5["schemas"]["Plan"];
38173
- type Relationship = components$4["schemas"]["RelationshipDefinition"];
38174
- type Subscription = components$3["schemas"]["Subscription"];
38175
- type Token = components$2["schemas"]["UserToken"];
38659
+ type Academy = components$e["schemas"]["AcademyCurricula"];
38660
+ type CatalogData = components$d["schemas"]["CatalogData"];
38661
+ type Component = components$c["schemas"]["ComponentDefinition"];
38662
+ type Connection = components$b["schemas"]["Connection"];
38663
+ type Design = components$a["schemas"]["PatternFile"];
38664
+ type EventResult = components$9["schemas"]["EventResult"];
38665
+ type Invitation = components$8["schemas"]["Invitation"];
38666
+ type Organization = components$7["schemas"]["Organization"];
38667
+ type Plan = components$6["schemas"]["Plan"];
38668
+ type Relationship = components$5["schemas"]["RelationshipDefinition"];
38669
+ type Subscription = components$4["schemas"]["Subscription"];
38670
+ type Token = components$3["schemas"]["UserToken"];
38176
38671
  }
38177
38672
  declare namespace v1beta3 {
38673
+ type DesignEventIdentity = components$2["schemas"]["DesignEventIdentity"];
38674
+ type RelationshipEvaluationEventMetadata = components$2["schemas"]["RelationshipEvaluationEventMetadata"];
38675
+ type DesignValidationEventMetadata = components$2["schemas"]["DesignValidationEventMetadata"];
38676
+ type DesignValidationEventError = components$2["schemas"]["DesignValidationEventError"];
38677
+ type DesignSavedEventMetadata = components$2["schemas"]["DesignSavedEventMetadata"];
38678
+ type DesignSavedEventDesign = components$2["schemas"]["DesignSavedEventDesign"];
38178
38679
  type User = components$1["schemas"]["User"];
38179
38680
  type PublicUser = components$1["schemas"]["PublicUser"];
38180
38681
  type PublicUsersPage = components$1["schemas"]["PublicUsersPage"];