@meshery/schemas 1.3.115 → 1.3.117
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 +912 -11
- package/dist/cloudApi.d.ts +912 -11
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +17 -5
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
- package/dist/constructs/v1beta3/design/Design.d.ts +72 -2
- package/dist/constructs/v1beta3/design/DesignSchema.js +4 -2
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +4 -2
- package/dist/constructs/v1beta3/environment/Environment.d.ts +710 -4
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/errorcode/Errorcode.d.ts +193 -0
- package/dist/constructs/v1beta3/errorcode/Errorcode.js +1 -0
- package/dist/constructs/v1beta3/errorcode/Errorcode.mjs +0 -0
- package/dist/constructs/v1beta3/errorcode/ErrorcodeSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/errorcode/ErrorcodeSchema.js +9 -0
- package/dist/constructs/v1beta3/errorcode/ErrorcodeSchema.mjs +9 -0
- package/dist/constructs/v1beta3/event/Event.d.ts +558 -17
- package/dist/constructs/v1beta3/event/EventSchema.js +28 -9
- package/dist/constructs/v1beta3/event/EventSchema.mjs +28 -9
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +390 -1
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +35 -15
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +35 -15
- package/dist/index.d.mts +624 -85
- package/dist/index.d.ts +624 -85
- package/dist/index.js +10 -10
- package/dist/index.mjs +10 -10
- package/dist/mesheryApi.d.mts +332 -6
- package/dist/mesheryApi.d.ts +332 -6
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
@@ -104,7 +104,15 @@ export interface paths {
|
|
|
104
104
|
put?: never;
|
|
105
105
|
/**
|
|
106
106
|
* Create a new event
|
|
107
|
-
* @description Records an event and answers 201 with it.
|
|
107
|
+
* @description Records an event and answers 201 with it. The server assigns the organization from the session; clients do not send it. A server MAY answer a legacy create, one carrying neither `correlationKey` nor `idempotencyKey`, with 200 and `Event-Disposition: created`, for compatibility with released Meshery Servers that treat any non-200 answer as failure. Clients accept any 2xx and read `Event-Disposition` rather than the status code to tell created from replayed.
|
|
108
|
+
*
|
|
109
|
+
* **Retries (`idempotencyKey`).** When the payload carries an `idempotencyKey` the authenticated caller already used, nothing is recorded or changed and the answer is 200 with the event that key is bound to (`Event-Disposition: replayed`). This check runs first, so a retried create never counts an occurrence twice.
|
|
110
|
+
*
|
|
111
|
+
* **Conditions (`correlationKey`).** A payload that carries a `correlationKey` reports an occurrence of an ongoing condition. A call that identifies no user records a new event and stores the correlation fields exactly as sent: no defaults are applied and no open event is matched, whether or not the payload carries `resolvedAt` (201, `Event-Disposition: created`). The open, increment and resolution rules below apply only to a call that identifies a user. A condition is open while its event has no `resolvedAt`, and that caller (organization and user, as for `idempotencyKey`) has at most one open event per key; the server enforces that atomically. For a payload without `resolvedAt`: when that caller has an open event with the key, no event is recorded; that event's `occurrenceCount` grows by the payload's `occurrenceCount` (1 when omitted), its `lastSeenAt` becomes the later of its own and the payload's `lastSeenAt` (the time of receipt when omitted), and its `updatedAt` advances. The answer is 200 with it (`Event-Disposition: incremented`). Every other field keeps the value it was first recorded with. Otherwise a new event is recorded, which opens the condition: `occurrenceCount` defaults to 1, `firstSeenAt` to the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt, and `lastSeenAt` to the payload's `lastSeenAt`, else `firstSeenAt` (201, `Event-Disposition: created`).
|
|
112
|
+
*
|
|
113
|
+
* **Resolution.** Only a call that identifies a user resolves. A producer closes a condition by creating an event with the condition's `correlationKey` and a `resolvedAt` time, after the condition clears. When that caller has an open event with the key, nothing new is recorded: that event gets the `resolvedAt`, its `severity` and `description` become the payload's when the payload carries them (an omitted field keeps the stored value) so the closed condition reads as cleared, its `lastSeenAt` becomes the later of its own and the payload's `lastSeenAt` (the time of receipt when omitted), and its `updatedAt` advances. The answer is 200 with the closed event (`Event-Disposition: resolved`). Every other field keeps the value it was recorded with, so `occurrenceCount` does not grow. When none is open, the payload is recorded as a new, already resolved event, using the opening defaults: `occurrenceCount` is the payload's (1 when omitted), and `firstSeenAt` and `lastSeenAt` are the payload's, else `resolvedAt` (201, `created`). Once closed, the next occurrence opens a new condition with a new event. Send a resolution only when the condition changes from present to cleared, never on every healthy check.
|
|
114
|
+
*
|
|
115
|
+
* **Composition.** When a create that carries both keys does not replay, its `idempotencyKey` is bound to the event the create recorded, incremented or resolved, so a retry answers 200 with that event and changes nothing. Deduplication a server applies on its own, without a client key, must not swallow an occurrence of an event that carries a `correlationKey`. A call that identifies a user counts the occurrence; a call that identifies no user is recorded as a new event with the correlation fields stored exactly as sent. Whether a counted occurrence notifies anyone again is the reader's policy, not this operation's. See docs/event-correlation-contract.md.
|
|
108
116
|
*/
|
|
109
117
|
post: operations["createEvent"];
|
|
110
118
|
delete?: never;
|
|
@@ -213,8 +221,45 @@ export interface components {
|
|
|
213
221
|
action?: string;
|
|
214
222
|
/** @description Description of the event. */
|
|
215
223
|
description?: string;
|
|
224
|
+
/** @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. */
|
|
225
|
+
severity?: string;
|
|
216
226
|
/** @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. */
|
|
217
227
|
idempotencyKey?: string;
|
|
228
|
+
/** @description Optional key naming the ongoing condition this event reports, so repeated occurrences count on one open event instead of recording one each (see createEvent). Name the condition, not the occurrence, and qualify it by the emitting source and component plus the subject, for example `meshery-server/k8s-connection/<connectionId>/unreachable`. Never use an error code alone: codes are scoped to the component that owns them. Unlike `idempotencyKey`, which makes one create safe to retry, this key spans many creates. */
|
|
229
|
+
correlationKey?: string;
|
|
230
|
+
/** @description Number of occurrences this create reports, for a producer that counted repeats locally before sending. A create without a `correlationKey`, and a call that identifies no user, stores this value exactly as sent, including when it is omitted. For a call that identifies a user and carries a `correlationKey`, omitted means 1. An opening create stores that count, counting an open condition adds it, and an already-resolved insert stores it. A resolving create on that open event does not add it. */
|
|
231
|
+
occurrenceCount?: number;
|
|
232
|
+
/**
|
|
233
|
+
* Format: date-time
|
|
234
|
+
* @description When the producer first saw the occurrences this create reports. A call that identifies no user stores this value exactly as sent. For a call that identifies a user, omitted while opening a condition means `lastSeenAt`, or the time of receipt, and omitted on a resolving create that inserts an already resolved event means `resolvedAt`. Stored when that create opens a condition or inserts one already resolved; a close of an open condition keeps the stored time.
|
|
235
|
+
*/
|
|
236
|
+
firstSeenAt?: string;
|
|
237
|
+
/**
|
|
238
|
+
* Format: date-time
|
|
239
|
+
* @description When the producer last saw the occurrences this create reports. A call that identifies no user stores this value exactly as sent. For a call that identifies a user, omitted while opening a condition means `firstSeenAt`; omitted while counting an open condition, or while closing one, means the time of receipt; and omitted on a resolving create that inserts an already resolved event means `resolvedAt`.
|
|
240
|
+
*/
|
|
241
|
+
lastSeenAt?: string;
|
|
242
|
+
/**
|
|
243
|
+
* Format: date-time
|
|
244
|
+
* @description When the condition named by `correlationKey` cleared. A call that identifies no user stores this value exactly as sent and does not match an open event. For a call that identifies a user, a create that carries it is a resolution: it closes that caller's open event with that key, copying this payload's `severity` and `description` onto the event when this payload carries them (an omitted field keeps the stored value) and setting `lastSeenAt` to the later of the stored time and this payload's `lastSeenAt` (the time of receipt when omitted), so the closed condition reads as cleared and the next occurrence opens a new condition (see createEvent). Give the resolution a severity and description that say what cleared, for example severity `success` and `Connection to cluster prod-1 restored`, under the condition's category.
|
|
245
|
+
*/
|
|
246
|
+
resolvedAt?: string;
|
|
247
|
+
/**
|
|
248
|
+
* Format: uri-reference
|
|
249
|
+
* @description Which surface emitted the event, as a CloudEvents-compatible `source` (a URI reference): `meshery-server`, `meshery-ui`, `mesheryctl`, `meshery-adapter-<name>` (for example `meshery-adapter-istio`), `layer5-cloud`, or another client's name. `systemId` says which instance; `source` says which kind of client, so a failure a person caused in the UI is told apart from the same failure from the CLI. An open set: a new surface needs no schema change.
|
|
250
|
+
*/
|
|
251
|
+
source?: string;
|
|
252
|
+
/** @description CloudEvents-compatible `type`: a reverse-DNS name of the kind of occurrence, for example `io.meshery.user.signup`. It does not replace `category` and `action`, which stay two free strings; `type` is for CloudEvents-aware consumers. */
|
|
253
|
+
type?: string;
|
|
254
|
+
/**
|
|
255
|
+
* @description The CloudEvents specification version the event's `source`, `type` and `id` are compatible with, when the producer sets them as CloudEvents attributes. A Meshery event is CloudEvents compatible; it is not a CloudEvent.
|
|
256
|
+
* @enum {string}
|
|
257
|
+
*/
|
|
258
|
+
specversion?: "1.0";
|
|
259
|
+
/** @description W3C Trace Context `trace-id` (32 lowercase hex digits, not all zeros) of the user-level operation the event belongs to, so the event joins the OpenTelemetry trace that operation recorded. The client that starts the operation mints it, and every event of the operation and its sub-operations carries it; the server never mints one at persist time. */
|
|
260
|
+
traceId?: string;
|
|
261
|
+
/** @description W3C Trace Context `parent-id` (16 lowercase hex digits, not all zeros): the span of the sub-operation that emitted the event, so the events of one operation form its tree. Minted by the client with `traceId`, never by the server. */
|
|
262
|
+
parentId?: string;
|
|
218
263
|
} & {
|
|
219
264
|
[key: string]: unknown;
|
|
220
265
|
};
|
|
@@ -310,6 +355,74 @@ export interface components {
|
|
|
310
355
|
* @description Timestamp when the event was recorded.
|
|
311
356
|
*/
|
|
312
357
|
createdAt?: string;
|
|
358
|
+
/** @description Key of the ongoing condition the event records (see Event.correlationKey); omitted for an event that reports no condition. */
|
|
359
|
+
correlationKey?: string;
|
|
360
|
+
/** @description How many occurrences of the condition the event counts (see Event.occurrenceCount). A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, it is the payload's `occurrenceCount` (1 when omitted) when the event was recorded, opening a condition or inserted already resolved, growing only as later creates that do not resolve are counted. A resolving create on the open event does not add to it. */
|
|
361
|
+
occurrenceCount?: number;
|
|
362
|
+
/**
|
|
363
|
+
* Format: date-time
|
|
364
|
+
* @description When the condition's first counted occurrence was seen (see Event.firstSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.
|
|
365
|
+
*/
|
|
366
|
+
firstSeenAt?: string;
|
|
367
|
+
/**
|
|
368
|
+
* Format: date-time
|
|
369
|
+
* @description When the condition was last seen (see Event.lastSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.
|
|
370
|
+
*/
|
|
371
|
+
lastSeenAt?: string;
|
|
372
|
+
/**
|
|
373
|
+
* Format: date-time
|
|
374
|
+
* @description When the condition cleared (see Event.resolvedAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user it is omitted while the condition is open.
|
|
375
|
+
*/
|
|
376
|
+
resolvedAt?: string;
|
|
377
|
+
/**
|
|
378
|
+
* Format: uri-reference
|
|
379
|
+
* @description Which surface emitted the event, for example `meshery-server` or `mesheryctl` (see Event.source).
|
|
380
|
+
*/
|
|
381
|
+
source?: string;
|
|
382
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup` (see Event.type). */
|
|
383
|
+
type?: string;
|
|
384
|
+
/**
|
|
385
|
+
* @description The CloudEvents specification version the event is compatible with (see Event.specversion).
|
|
386
|
+
* @enum {string}
|
|
387
|
+
*/
|
|
388
|
+
specversion?: "1.0";
|
|
389
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to (see Event.traceId). */
|
|
390
|
+
traceId?: string;
|
|
391
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event (see Event.parentId). */
|
|
392
|
+
parentId?: string;
|
|
393
|
+
/**
|
|
394
|
+
* Format: uuid
|
|
395
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
396
|
+
*/
|
|
397
|
+
id?: string;
|
|
398
|
+
/**
|
|
399
|
+
* Format: uuid
|
|
400
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
401
|
+
*/
|
|
402
|
+
actedUpon?: string;
|
|
403
|
+
/**
|
|
404
|
+
* Format: uuid
|
|
405
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
406
|
+
*/
|
|
407
|
+
operationId?: string;
|
|
408
|
+
/** @description Event level (see Event.severity). MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire, so consumers must tolerate other values. */
|
|
409
|
+
severity?: string;
|
|
410
|
+
/** @description Read state of the event (see Event.status). MeshKit records new events as `unread`, and acknowledged ones become `read`; consumers must tolerate other values. */
|
|
411
|
+
status?: string;
|
|
412
|
+
/** @description Event-specific details, the same nullable free-form map as Event.metadata. `null` when the producer attached none. On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. */
|
|
413
|
+
metadata?: {
|
|
414
|
+
[key: string]: unknown;
|
|
415
|
+
} | null;
|
|
416
|
+
/**
|
|
417
|
+
* Format: date-time
|
|
418
|
+
* @description Timestamp when the event was last updated (see Event.updatedAt).
|
|
419
|
+
*/
|
|
420
|
+
updatedAt?: string;
|
|
421
|
+
/**
|
|
422
|
+
* Format: date-time
|
|
423
|
+
* @description Timestamp when the event was soft-deleted; omitted when it was not (see Event.deletedAt).
|
|
424
|
+
*/
|
|
425
|
+
deletedAt?: string | null;
|
|
313
426
|
};
|
|
314
427
|
/** @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. */
|
|
315
428
|
Event: {
|
|
@@ -329,7 +442,7 @@ export interface components {
|
|
|
329
442
|
category: string;
|
|
330
443
|
/** @description Human-readable summary of what happened. */
|
|
331
444
|
description: string;
|
|
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
|
|
445
|
+
/** @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: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`; docs/error-definition-contract.md), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. 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. */
|
|
333
446
|
metadata: {
|
|
334
447
|
[key: string]: unknown;
|
|
335
448
|
} | null;
|
|
@@ -378,6 +491,41 @@ export interface components {
|
|
|
378
491
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
379
492
|
*/
|
|
380
493
|
deletedAt?: string | null;
|
|
494
|
+
/** @description Key of the ongoing condition the event records (see EventPayload.correlationKey and createEvent); omitted for an event that reports no condition. */
|
|
495
|
+
correlationKey?: string;
|
|
496
|
+
/** @description How many occurrences of the condition this event counts. A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, an opening create or a resolving create inserted already resolved stores the payload's `occurrenceCount` (1 when omitted). Later creates that do not resolve add their count. A resolving create on the open event does not add to it. */
|
|
497
|
+
occurrenceCount?: number;
|
|
498
|
+
/**
|
|
499
|
+
* Format: date-time
|
|
500
|
+
* @description When the condition's first counted occurrence was seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.
|
|
501
|
+
*/
|
|
502
|
+
firstSeenAt?: string;
|
|
503
|
+
/**
|
|
504
|
+
* Format: date-time
|
|
505
|
+
* @description When the condition was last seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.
|
|
506
|
+
*/
|
|
507
|
+
lastSeenAt?: string;
|
|
508
|
+
/**
|
|
509
|
+
* Format: date-time
|
|
510
|
+
* @description When the condition cleared. A call that identifies no user stores the payload's value exactly as sent and does not close another event. For a call that identifies a user it is omitted while the condition is open, and set by a resolution (see createEvent), which also replaces `severity` and `description` with the payload's when the payload carries them (an omitted field keeps the stored value) and brings `lastSeenAt` forward, after which a new occurrence opens a new event.
|
|
511
|
+
*/
|
|
512
|
+
resolvedAt?: string;
|
|
513
|
+
/**
|
|
514
|
+
* Format: uri-reference
|
|
515
|
+
* @description Which surface emitted the event (CloudEvents-compatible `source`), for example `meshery-server`, `meshery-ui`, `mesheryctl` or `meshery-adapter-istio`; see EventPayload.source. Omitted when the producer did not say.
|
|
516
|
+
*/
|
|
517
|
+
source?: string;
|
|
518
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup`; see EventPayload.type. `category` and `action` stay the event's classification. */
|
|
519
|
+
type?: string;
|
|
520
|
+
/**
|
|
521
|
+
* @description The CloudEvents specification version the event is compatible with; see EventPayload.specversion.
|
|
522
|
+
* @enum {string}
|
|
523
|
+
*/
|
|
524
|
+
specversion?: "1.0";
|
|
525
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to, as its client minted it; see EventPayload.traceId. */
|
|
526
|
+
traceId?: string;
|
|
527
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event; see EventPayload.parentId. */
|
|
528
|
+
parentId?: string;
|
|
381
529
|
};
|
|
382
530
|
/** @description Paginated list of events. */
|
|
383
531
|
EventsPage: {
|
|
@@ -434,8 +582,81 @@ export interface components {
|
|
|
434
582
|
* @description Timestamp when the event was recorded.
|
|
435
583
|
*/
|
|
436
584
|
createdAt?: string;
|
|
585
|
+
/** @description Key of the ongoing condition the event records (see Event.correlationKey); omitted for an event that reports no condition. */
|
|
586
|
+
correlationKey?: string;
|
|
587
|
+
/** @description How many occurrences of the condition the event counts (see Event.occurrenceCount). A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, it is the payload's `occurrenceCount` (1 when omitted) when the event was recorded, opening a condition or inserted already resolved, growing only as later creates that do not resolve are counted. A resolving create on the open event does not add to it. */
|
|
588
|
+
occurrenceCount?: number;
|
|
589
|
+
/**
|
|
590
|
+
* Format: date-time
|
|
591
|
+
* @description When the condition's first counted occurrence was seen (see Event.firstSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.
|
|
592
|
+
*/
|
|
593
|
+
firstSeenAt?: string;
|
|
594
|
+
/**
|
|
595
|
+
* Format: date-time
|
|
596
|
+
* @description When the condition was last seen (see Event.lastSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.
|
|
597
|
+
*/
|
|
598
|
+
lastSeenAt?: string;
|
|
599
|
+
/**
|
|
600
|
+
* Format: date-time
|
|
601
|
+
* @description When the condition cleared (see Event.resolvedAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user it is omitted while the condition is open.
|
|
602
|
+
*/
|
|
603
|
+
resolvedAt?: string;
|
|
604
|
+
/**
|
|
605
|
+
* Format: uri-reference
|
|
606
|
+
* @description Which surface emitted the event, for example `meshery-server` or `mesheryctl` (see Event.source).
|
|
607
|
+
*/
|
|
608
|
+
source?: string;
|
|
609
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup` (see Event.type). */
|
|
610
|
+
type?: string;
|
|
611
|
+
/**
|
|
612
|
+
* @description The CloudEvents specification version the event is compatible with (see Event.specversion).
|
|
613
|
+
* @enum {string}
|
|
614
|
+
*/
|
|
615
|
+
specversion?: "1.0";
|
|
616
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to (see Event.traceId). */
|
|
617
|
+
traceId?: string;
|
|
618
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event (see Event.parentId). */
|
|
619
|
+
parentId?: string;
|
|
620
|
+
/**
|
|
621
|
+
* Format: uuid
|
|
622
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
623
|
+
*/
|
|
624
|
+
id?: string;
|
|
625
|
+
/**
|
|
626
|
+
* Format: uuid
|
|
627
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
628
|
+
*/
|
|
629
|
+
actedUpon?: string;
|
|
630
|
+
/**
|
|
631
|
+
* Format: uuid
|
|
632
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
633
|
+
*/
|
|
634
|
+
operationId?: string;
|
|
635
|
+
/** @description Event level (see Event.severity). MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire, so consumers must tolerate other values. */
|
|
636
|
+
severity?: string;
|
|
637
|
+
/** @description Read state of the event (see Event.status). MeshKit records new events as `unread`, and acknowledged ones become `read`; consumers must tolerate other values. */
|
|
638
|
+
status?: string;
|
|
639
|
+
/** @description Event-specific details, the same nullable free-form map as Event.metadata. `null` when the producer attached none. On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. */
|
|
640
|
+
metadata?: {
|
|
641
|
+
[key: string]: unknown;
|
|
642
|
+
} | null;
|
|
643
|
+
/**
|
|
644
|
+
* Format: date-time
|
|
645
|
+
* @description Timestamp when the event was last updated (see Event.updatedAt).
|
|
646
|
+
*/
|
|
647
|
+
updatedAt?: string;
|
|
648
|
+
/**
|
|
649
|
+
* Format: date-time
|
|
650
|
+
* @description Timestamp when the event was soft-deleted; omitted when it was not (see Event.deletedAt).
|
|
651
|
+
*/
|
|
652
|
+
deletedAt?: string | null;
|
|
437
653
|
}[];
|
|
438
654
|
};
|
|
655
|
+
/**
|
|
656
|
+
* @description A CloudEvents specification version a Meshery event is compatible with. Only `1.0` is defined.
|
|
657
|
+
* @enum {string}
|
|
658
|
+
*/
|
|
659
|
+
EventSpecVersion: "1.0";
|
|
439
660
|
/**
|
|
440
661
|
* @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
662
|
* @default private
|
|
@@ -448,7 +669,8 @@ export interface components {
|
|
|
448
669
|
* `platform`, `role`, `line` and `networks` are projected from
|
|
449
670
|
* ScheduleCompletedEventMetadata; events without valid required
|
|
450
671
|
* metadata are skipped. Public profile fields are resolved by Cloud at
|
|
451
|
-
* read time
|
|
672
|
+
* read time for every served owner (live, active, and
|
|
673
|
+
* shareActivityPublicly on).
|
|
452
674
|
*/
|
|
453
675
|
EventFeedItem: {
|
|
454
676
|
/**
|
|
@@ -487,14 +709,14 @@ export interface components {
|
|
|
487
709
|
line: string;
|
|
488
710
|
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
489
711
|
networks?: string[];
|
|
490
|
-
/** @description
|
|
712
|
+
/** @description The same value PublicUser.username carries for the owner. Never email. Resolved for every served owner; omitted when empty. */
|
|
491
713
|
displayName?: string;
|
|
492
714
|
/**
|
|
493
715
|
* Format: uri
|
|
494
|
-
* @description Public avatar URL;
|
|
716
|
+
* @description Public avatar URL; resolved for every served owner, omitted when empty.
|
|
495
717
|
*/
|
|
496
718
|
avatarUrl?: string;
|
|
497
|
-
/** @description Public organization name;
|
|
719
|
+
/** @description Public organization name; omitted when organization memberships are not public to an anonymous caller. */
|
|
498
720
|
organizationName?: string;
|
|
499
721
|
/**
|
|
500
722
|
* Format: uri
|
|
@@ -548,14 +770,14 @@ export interface components {
|
|
|
548
770
|
line: string;
|
|
549
771
|
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
550
772
|
networks?: string[];
|
|
551
|
-
/** @description
|
|
773
|
+
/** @description The same value PublicUser.username carries for the owner. Never email. Resolved for every served owner; omitted when empty. */
|
|
552
774
|
displayName?: string;
|
|
553
775
|
/**
|
|
554
776
|
* Format: uri
|
|
555
|
-
* @description Public avatar URL;
|
|
777
|
+
* @description Public avatar URL; resolved for every served owner, omitted when empty.
|
|
556
778
|
*/
|
|
557
779
|
avatarUrl?: string;
|
|
558
|
-
/** @description Public organization name;
|
|
780
|
+
/** @description Public organization name; omitted when organization memberships are not public to an anonymous caller. */
|
|
559
781
|
organizationName?: string;
|
|
560
782
|
/**
|
|
561
783
|
* Format: uri
|
|
@@ -717,6 +939,75 @@ export interface components {
|
|
|
717
939
|
/** @description One short, human-readable line saying what went wrong; omitted when the producer has none. Never design contents. */
|
|
718
940
|
message?: string;
|
|
719
941
|
};
|
|
942
|
+
/** @description The `metadata.error` of an event that reports an error: one occurrence of an ErrorDefinition (the error construct). It carries the code, the descriptions as rendered for this occurrence, the causes and remediations that apply, which of those causes are likely this time (`matchedCauses`), and the values the descriptions were rendered from (`details`). It holds only the error, never the design, the request or the response that failed. A producer that has only MeshKit's flat lists sends `probableCause` and `suggestedRemediation` alone; such an error is unpaired, and nothing may pair the lists by position. A producer with the nested form sends `probableCauses` and should also send the flat lists derived from it, for readers that predate the nesting. Like every metadata shape it is a sub-shape of Event.metadata, which stays a free-form map, so it has no `*Payload` twin (docs/error-definition-contract.md). */
|
|
943
|
+
EventError: {
|
|
944
|
+
/** @description The full error code, for example `meshery-server-1033`, as the definition names it. Consumers must tolerate codes they do not know. */
|
|
945
|
+
code: string;
|
|
946
|
+
/** @description The component that owns the code, when the producer names it; the code's prefix is the component's name. */
|
|
947
|
+
component?: {
|
|
948
|
+
/** @description The kind of component, for example `component` (Meshery Server), `adapter`, `library` (MeshKit) or `client` (mesheryctl). An open set: a new kind of component needs no schema change. */
|
|
949
|
+
type: string;
|
|
950
|
+
/** @description The component's name, for example `meshery-server`, `meshkit` or `mesheryctl`. It is the prefix of every code the component owns. */
|
|
951
|
+
name: string;
|
|
952
|
+
};
|
|
953
|
+
/**
|
|
954
|
+
* @description The definition's severity. The event's own `severity` is the level this occurrence was recorded at.
|
|
955
|
+
* @enum {string}
|
|
956
|
+
*/
|
|
957
|
+
severity?: "emergency" | "alert" | "critical" | "fatal" | "error" | "warning" | "informational" | "debug";
|
|
958
|
+
/** @description The definition's short description, rendered for this occurrence. */
|
|
959
|
+
shortDescription?: string;
|
|
960
|
+
/** @description The definition's long description, rendered for this occurrence. */
|
|
961
|
+
longDescription?: string;
|
|
962
|
+
/** @description The definition's causes that apply to this occurrence, each with the remediations that answer it, in the definition's order. A producer may narrow the definition's causes to those that can apply; omitted when the producer has only flat lists. */
|
|
963
|
+
probableCauses?: {
|
|
964
|
+
/** @description Stable id of the cause, unique within the error's definition, for example `service-not-running`. An event names the causes that apply to one occurrence by this id (`EventError.matchedCauses`), and the docs page links to it, so it never changes once published. Lowercase words joined by hyphens. */
|
|
965
|
+
id: string;
|
|
966
|
+
/** @description What may have caused the error, for example `The service is not running.` */
|
|
967
|
+
description: string;
|
|
968
|
+
/** @description What answers this cause, the most likely fix first. A remediation that also answers another cause is repeated under that cause with the same `id` and identical fields. */
|
|
969
|
+
remediations: {
|
|
970
|
+
/** @description Stable id of the remediation, unique within the error's definition, for example `start-service`. The same id under two causes is one remediation answering both, so its fields must be identical in each place, and the flattened `suggestedRemediation` list carries it once. Lowercase words joined by hyphens. */
|
|
971
|
+
id: string;
|
|
972
|
+
/** @description What to do, written for a person, for example `Start the service.` */
|
|
973
|
+
description: string;
|
|
974
|
+
/** @description Identifier of an action a client can run to apply this remediation, as dot-separated lowercase words, for example `service.start` or `connection.reconnect`. The client that runs it owns its meaning; the definition only names it. Omitted when only a person can apply the remediation. */
|
|
975
|
+
action?: string;
|
|
976
|
+
/**
|
|
977
|
+
* @description Whether a client may run `action` on its own. `automatic` and `requiresApproval` need an `action`. Omitted means `manual`.
|
|
978
|
+
* @enum {string}
|
|
979
|
+
*/
|
|
980
|
+
actionPolicy?: "automatic" | "requiresApproval" | "manual";
|
|
981
|
+
}[];
|
|
982
|
+
}[];
|
|
983
|
+
/** @description The causes most likely for this occurrence, most likely first, so a reader leads with their remediations. Each names a cause `id` of the definition and, when `probableCauses` is present, one of its causes. Omitted when the producer cannot tell which cause applies. */
|
|
984
|
+
matchedCauses?: {
|
|
985
|
+
/** @description The `id` of the matched cause in the error's definition (ProbableCause.id). */
|
|
986
|
+
causeId: string;
|
|
987
|
+
/** @description How sure the producer is that this cause applies, from 0 (a guess) to 1 (certain); omitted when the producer does not estimate it. */
|
|
988
|
+
confidence?: number;
|
|
989
|
+
}[];
|
|
990
|
+
/** @description The flat list of cause descriptions (MeshKit's `ProbableCause`). With `probableCauses`, it equals each cause's `description` in order; without, it is unpaired. */
|
|
991
|
+
probableCause?: string[];
|
|
992
|
+
/** @description The flat list of remediation descriptions (MeshKit's `SuggestedRemediation`). With `probableCauses`, it equals every remediation's `description` in order, each remediation `id` once; without, it is unpaired. */
|
|
993
|
+
suggestedRemediation?: string[];
|
|
994
|
+
/**
|
|
995
|
+
* Format: uri
|
|
996
|
+
* @description The code's page on docs.meshery.io (ErrorDefinition.referenceUrl), when the producer knows it.
|
|
997
|
+
*/
|
|
998
|
+
referenceUrl?: string;
|
|
999
|
+
/** @description The instance values this occurrence's descriptions were rendered from, for example the connection name or the path that failed. Keys are camelCase. Never secrets, credentials, design contents or request bodies; Meshery Server's 16 KB metadata guard applies. */
|
|
1000
|
+
details?: {
|
|
1001
|
+
[key: string]: unknown;
|
|
1002
|
+
};
|
|
1003
|
+
};
|
|
1004
|
+
/** @description One cause an error event names as likely for this occurrence (EventError.matchedCauses). */
|
|
1005
|
+
EventMatchedCause: {
|
|
1006
|
+
/** @description The `id` of the matched cause in the error's definition (ProbableCause.id). */
|
|
1007
|
+
causeId: string;
|
|
1008
|
+
/** @description How sure the producer is that this cause applies, from 0 (a guess) to 1 (certain); omitted when the producer does not estimate it. */
|
|
1009
|
+
confidence?: number;
|
|
1010
|
+
};
|
|
720
1011
|
/** @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. */
|
|
721
1012
|
DesignSavedEventMetadata: {
|
|
722
1013
|
/** @description One-line title of the save for the design's history, for example `Version v0.0.3 - 12 components and 9 relationships`. */
|
|
@@ -879,7 +1170,10 @@ export interface components {
|
|
|
879
1170
|
eventsScope: "user" | "organization";
|
|
880
1171
|
};
|
|
881
1172
|
requestBodies: never;
|
|
882
|
-
headers:
|
|
1173
|
+
headers: {
|
|
1174
|
+
/** @description What `createEvent` did with the payload: `created` (a new event was recorded), `replayed` (the `idempotencyKey` was already used; nothing changed), `incremented` (an occurrence of the open condition with this `correlationKey` was counted) or `resolved` (that condition was closed). `incremented` and `resolved` apply only to a call that identifies a user; a call that identifies no user is `created`, with the correlation fields stored exactly as sent. A server MAY answer a legacy create, one carrying neither `correlationKey` nor `idempotencyKey`, with 200 and `created`, for compatibility with released Meshery Servers that treat any non-200 answer as failure. Clients accept any 2xx and read this header rather than the status code to tell created from replayed. A server that implements condition correlation sends it on every 200 and 201. A server that predates correlation omits it; there 201 means created and 200 means replayed. A browser client calling a server on another origin reads it only when that server lists it in `Access-Control-Expose-Headers`. */
|
|
1175
|
+
EventDisposition: "created" | "replayed" | "incremented" | "resolved";
|
|
1176
|
+
};
|
|
883
1177
|
pathItems: never;
|
|
884
1178
|
}
|
|
885
1179
|
export type $defs = Record<string, never>;
|
|
@@ -1325,6 +1619,74 @@ export interface operations {
|
|
|
1325
1619
|
* @description Timestamp when the event was recorded.
|
|
1326
1620
|
*/
|
|
1327
1621
|
createdAt?: string;
|
|
1622
|
+
/** @description Key of the ongoing condition the event records (see Event.correlationKey); omitted for an event that reports no condition. */
|
|
1623
|
+
correlationKey?: string;
|
|
1624
|
+
/** @description How many occurrences of the condition the event counts (see Event.occurrenceCount). A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, it is the payload's `occurrenceCount` (1 when omitted) when the event was recorded, opening a condition or inserted already resolved, growing only as later creates that do not resolve are counted. A resolving create on the open event does not add to it. */
|
|
1625
|
+
occurrenceCount?: number;
|
|
1626
|
+
/**
|
|
1627
|
+
* Format: date-time
|
|
1628
|
+
* @description When the condition's first counted occurrence was seen (see Event.firstSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.
|
|
1629
|
+
*/
|
|
1630
|
+
firstSeenAt?: string;
|
|
1631
|
+
/**
|
|
1632
|
+
* Format: date-time
|
|
1633
|
+
* @description When the condition was last seen (see Event.lastSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.
|
|
1634
|
+
*/
|
|
1635
|
+
lastSeenAt?: string;
|
|
1636
|
+
/**
|
|
1637
|
+
* Format: date-time
|
|
1638
|
+
* @description When the condition cleared (see Event.resolvedAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user it is omitted while the condition is open.
|
|
1639
|
+
*/
|
|
1640
|
+
resolvedAt?: string;
|
|
1641
|
+
/**
|
|
1642
|
+
* Format: uri-reference
|
|
1643
|
+
* @description Which surface emitted the event, for example `meshery-server` or `mesheryctl` (see Event.source).
|
|
1644
|
+
*/
|
|
1645
|
+
source?: string;
|
|
1646
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup` (see Event.type). */
|
|
1647
|
+
type?: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* @description The CloudEvents specification version the event is compatible with (see Event.specversion).
|
|
1650
|
+
* @enum {string}
|
|
1651
|
+
*/
|
|
1652
|
+
specversion?: "1.0";
|
|
1653
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to (see Event.traceId). */
|
|
1654
|
+
traceId?: string;
|
|
1655
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event (see Event.parentId). */
|
|
1656
|
+
parentId?: string;
|
|
1657
|
+
/**
|
|
1658
|
+
* Format: uuid
|
|
1659
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1660
|
+
*/
|
|
1661
|
+
id?: string;
|
|
1662
|
+
/**
|
|
1663
|
+
* Format: uuid
|
|
1664
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1665
|
+
*/
|
|
1666
|
+
actedUpon?: string;
|
|
1667
|
+
/**
|
|
1668
|
+
* Format: uuid
|
|
1669
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1670
|
+
*/
|
|
1671
|
+
operationId?: string;
|
|
1672
|
+
/** @description Event level (see Event.severity). MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire, so consumers must tolerate other values. */
|
|
1673
|
+
severity?: string;
|
|
1674
|
+
/** @description Read state of the event (see Event.status). MeshKit records new events as `unread`, and acknowledged ones become `read`; consumers must tolerate other values. */
|
|
1675
|
+
status?: string;
|
|
1676
|
+
/** @description Event-specific details, the same nullable free-form map as Event.metadata. `null` when the producer attached none. On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. */
|
|
1677
|
+
metadata?: {
|
|
1678
|
+
[key: string]: unknown;
|
|
1679
|
+
} | null;
|
|
1680
|
+
/**
|
|
1681
|
+
* Format: date-time
|
|
1682
|
+
* @description Timestamp when the event was last updated (see Event.updatedAt).
|
|
1683
|
+
*/
|
|
1684
|
+
updatedAt?: string;
|
|
1685
|
+
/**
|
|
1686
|
+
* Format: date-time
|
|
1687
|
+
* @description Timestamp when the event was soft-deleted; omitted when it was not (see Event.deletedAt).
|
|
1688
|
+
*/
|
|
1689
|
+
deletedAt?: string | null;
|
|
1328
1690
|
}[];
|
|
1329
1691
|
};
|
|
1330
1692
|
};
|
|
@@ -1515,17 +1877,56 @@ export interface operations {
|
|
|
1515
1877
|
action?: string;
|
|
1516
1878
|
/** @description Description of the event. */
|
|
1517
1879
|
description?: string;
|
|
1880
|
+
/** @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. */
|
|
1881
|
+
severity?: string;
|
|
1518
1882
|
/** @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. */
|
|
1519
1883
|
idempotencyKey?: string;
|
|
1884
|
+
/** @description Optional key naming the ongoing condition this event reports, so repeated occurrences count on one open event instead of recording one each (see createEvent). Name the condition, not the occurrence, and qualify it by the emitting source and component plus the subject, for example `meshery-server/k8s-connection/<connectionId>/unreachable`. Never use an error code alone: codes are scoped to the component that owns them. Unlike `idempotencyKey`, which makes one create safe to retry, this key spans many creates. */
|
|
1885
|
+
correlationKey?: string;
|
|
1886
|
+
/** @description Number of occurrences this create reports, for a producer that counted repeats locally before sending. A create without a `correlationKey`, and a call that identifies no user, stores this value exactly as sent, including when it is omitted. For a call that identifies a user and carries a `correlationKey`, omitted means 1. An opening create stores that count, counting an open condition adds it, and an already-resolved insert stores it. A resolving create on that open event does not add it. */
|
|
1887
|
+
occurrenceCount?: number;
|
|
1888
|
+
/**
|
|
1889
|
+
* Format: date-time
|
|
1890
|
+
* @description When the producer first saw the occurrences this create reports. A call that identifies no user stores this value exactly as sent. For a call that identifies a user, omitted while opening a condition means `lastSeenAt`, or the time of receipt, and omitted on a resolving create that inserts an already resolved event means `resolvedAt`. Stored when that create opens a condition or inserts one already resolved; a close of an open condition keeps the stored time.
|
|
1891
|
+
*/
|
|
1892
|
+
firstSeenAt?: string;
|
|
1893
|
+
/**
|
|
1894
|
+
* Format: date-time
|
|
1895
|
+
* @description When the producer last saw the occurrences this create reports. A call that identifies no user stores this value exactly as sent. For a call that identifies a user, omitted while opening a condition means `firstSeenAt`; omitted while counting an open condition, or while closing one, means the time of receipt; and omitted on a resolving create that inserts an already resolved event means `resolvedAt`.
|
|
1896
|
+
*/
|
|
1897
|
+
lastSeenAt?: string;
|
|
1898
|
+
/**
|
|
1899
|
+
* Format: date-time
|
|
1900
|
+
* @description When the condition named by `correlationKey` cleared. A call that identifies no user stores this value exactly as sent and does not match an open event. For a call that identifies a user, a create that carries it is a resolution: it closes that caller's open event with that key, copying this payload's `severity` and `description` onto the event when this payload carries them (an omitted field keeps the stored value) and setting `lastSeenAt` to the later of the stored time and this payload's `lastSeenAt` (the time of receipt when omitted), so the closed condition reads as cleared and the next occurrence opens a new condition (see createEvent). Give the resolution a severity and description that say what cleared, for example severity `success` and `Connection to cluster prod-1 restored`, under the condition's category.
|
|
1901
|
+
*/
|
|
1902
|
+
resolvedAt?: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* Format: uri-reference
|
|
1905
|
+
* @description Which surface emitted the event, as a CloudEvents-compatible `source` (a URI reference): `meshery-server`, `meshery-ui`, `mesheryctl`, `meshery-adapter-<name>` (for example `meshery-adapter-istio`), `layer5-cloud`, or another client's name. `systemId` says which instance; `source` says which kind of client, so a failure a person caused in the UI is told apart from the same failure from the CLI. An open set: a new surface needs no schema change.
|
|
1906
|
+
*/
|
|
1907
|
+
source?: string;
|
|
1908
|
+
/** @description CloudEvents-compatible `type`: a reverse-DNS name of the kind of occurrence, for example `io.meshery.user.signup`. It does not replace `category` and `action`, which stay two free strings; `type` is for CloudEvents-aware consumers. */
|
|
1909
|
+
type?: string;
|
|
1910
|
+
/**
|
|
1911
|
+
* @description The CloudEvents specification version the event's `source`, `type` and `id` are compatible with, when the producer sets them as CloudEvents attributes. A Meshery event is CloudEvents compatible; it is not a CloudEvent.
|
|
1912
|
+
* @enum {string}
|
|
1913
|
+
*/
|
|
1914
|
+
specversion?: "1.0";
|
|
1915
|
+
/** @description W3C Trace Context `trace-id` (32 lowercase hex digits, not all zeros) of the user-level operation the event belongs to, so the event joins the OpenTelemetry trace that operation recorded. The client that starts the operation mints it, and every event of the operation and its sub-operations carries it; the server never mints one at persist time. */
|
|
1916
|
+
traceId?: string;
|
|
1917
|
+
/** @description W3C Trace Context `parent-id` (16 lowercase hex digits, not all zeros): the span of the sub-operation that emitted the event, so the events of one operation form its tree. Minted by the client with `traceId`, never by the server. */
|
|
1918
|
+
parentId?: string;
|
|
1520
1919
|
} & {
|
|
1521
1920
|
[key: string]: unknown;
|
|
1522
1921
|
};
|
|
1523
1922
|
};
|
|
1524
1923
|
};
|
|
1525
1924
|
responses: {
|
|
1526
|
-
/** @description
|
|
1925
|
+
/** @description The event the create resolved to. When no new event was recorded, that is the one already recorded under this caller's `idempotencyKey` (`replayed`, unchanged) or, for a call that identifies a user, the open event of this `correlationKey` with the occurrence counted (`incremented`), or that event closed by the payload's `resolvedAt`, with its `severity` and `description` replaced by the payload's when the payload carries them (an omitted field keeps the stored value) and its `lastSeenAt` brought forward (`resolved`). A call that identifies no user records a new event instead, with the correlation fields stored exactly as sent. A server MAY also answer a legacy create, one carrying neither `correlationKey` nor `idempotencyKey`, with 200 and `Event-Disposition: created`, returning the event it just recorded, for compatibility with released Meshery Servers that treat any non-200 answer as failure. Clients accept any 2xx and read `Event-Disposition` rather than the status code to tell created from replayed. */
|
|
1527
1926
|
200: {
|
|
1528
1927
|
headers: {
|
|
1928
|
+
/** @description What `createEvent` did with the payload: `created` (a new event was recorded), `replayed` (the `idempotencyKey` was already used; nothing changed), `incremented` (an occurrence of the open condition with this `correlationKey` was counted) or `resolved` (that condition was closed). `incremented` and `resolved` apply only to a call that identifies a user; a call that identifies no user is `created`, with the correlation fields stored exactly as sent. A server MAY answer a legacy create, one carrying neither `correlationKey` nor `idempotencyKey`, with 200 and `created`, for compatibility with released Meshery Servers that treat any non-200 answer as failure. Clients accept any 2xx and read this header rather than the status code to tell created from replayed. A server that implements condition correlation sends it on every 200 and 201. A server that predates correlation omits it; there 201 means created and 200 means replayed. A browser client calling a server on another origin reads it only when that server lists it in `Access-Control-Expose-Headers`. */
|
|
1929
|
+
"Event-Disposition"?: "created" | "replayed" | "incremented" | "resolved";
|
|
1529
1930
|
[name: string]: unknown;
|
|
1530
1931
|
};
|
|
1531
1932
|
content: {
|
|
@@ -1546,7 +1947,7 @@ export interface operations {
|
|
|
1546
1947
|
category: string;
|
|
1547
1948
|
/** @description Human-readable summary of what happened. */
|
|
1548
1949
|
description: string;
|
|
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
|
|
1950
|
+
/** @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: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`; docs/error-definition-contract.md), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. 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. */
|
|
1550
1951
|
metadata: {
|
|
1551
1952
|
[key: string]: unknown;
|
|
1552
1953
|
} | null;
|
|
@@ -1595,12 +1996,49 @@ export interface operations {
|
|
|
1595
1996
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
1596
1997
|
*/
|
|
1597
1998
|
deletedAt?: string | null;
|
|
1999
|
+
/** @description Key of the ongoing condition the event records (see EventPayload.correlationKey and createEvent); omitted for an event that reports no condition. */
|
|
2000
|
+
correlationKey?: string;
|
|
2001
|
+
/** @description How many occurrences of the condition this event counts. A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, an opening create or a resolving create inserted already resolved stores the payload's `occurrenceCount` (1 when omitted). Later creates that do not resolve add their count. A resolving create on the open event does not add to it. */
|
|
2002
|
+
occurrenceCount?: number;
|
|
2003
|
+
/**
|
|
2004
|
+
* Format: date-time
|
|
2005
|
+
* @description When the condition's first counted occurrence was seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.
|
|
2006
|
+
*/
|
|
2007
|
+
firstSeenAt?: string;
|
|
2008
|
+
/**
|
|
2009
|
+
* Format: date-time
|
|
2010
|
+
* @description When the condition was last seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.
|
|
2011
|
+
*/
|
|
2012
|
+
lastSeenAt?: string;
|
|
2013
|
+
/**
|
|
2014
|
+
* Format: date-time
|
|
2015
|
+
* @description When the condition cleared. A call that identifies no user stores the payload's value exactly as sent and does not close another event. For a call that identifies a user it is omitted while the condition is open, and set by a resolution (see createEvent), which also replaces `severity` and `description` with the payload's when the payload carries them (an omitted field keeps the stored value) and brings `lastSeenAt` forward, after which a new occurrence opens a new event.
|
|
2016
|
+
*/
|
|
2017
|
+
resolvedAt?: string;
|
|
2018
|
+
/**
|
|
2019
|
+
* Format: uri-reference
|
|
2020
|
+
* @description Which surface emitted the event (CloudEvents-compatible `source`), for example `meshery-server`, `meshery-ui`, `mesheryctl` or `meshery-adapter-istio`; see EventPayload.source. Omitted when the producer did not say.
|
|
2021
|
+
*/
|
|
2022
|
+
source?: string;
|
|
2023
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup`; see EventPayload.type. `category` and `action` stay the event's classification. */
|
|
2024
|
+
type?: string;
|
|
2025
|
+
/**
|
|
2026
|
+
* @description The CloudEvents specification version the event is compatible with; see EventPayload.specversion.
|
|
2027
|
+
* @enum {string}
|
|
2028
|
+
*/
|
|
2029
|
+
specversion?: "1.0";
|
|
2030
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to, as its client minted it; see EventPayload.traceId. */
|
|
2031
|
+
traceId?: string;
|
|
2032
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event; see EventPayload.parentId. */
|
|
2033
|
+
parentId?: string;
|
|
1598
2034
|
};
|
|
1599
2035
|
};
|
|
1600
2036
|
};
|
|
1601
|
-
/** @description Event created */
|
|
2037
|
+
/** @description A new event was recorded (`Event-Disposition: created`). A call that identifies no user stores the correlation fields exactly as sent. For a call that identifies a user and carries a `correlationKey`, the event opens a condition, or records one already resolved when the payload carries `resolvedAt`. An already resolved insert uses `occurrenceCount` 1 when omitted, and `firstSeenAt` and `lastSeenAt` from the payload, else `resolvedAt`. */
|
|
1602
2038
|
201: {
|
|
1603
2039
|
headers: {
|
|
2040
|
+
/** @description What `createEvent` did with the payload: `created` (a new event was recorded), `replayed` (the `idempotencyKey` was already used; nothing changed), `incremented` (an occurrence of the open condition with this `correlationKey` was counted) or `resolved` (that condition was closed). `incremented` and `resolved` apply only to a call that identifies a user; a call that identifies no user is `created`, with the correlation fields stored exactly as sent. A server MAY answer a legacy create, one carrying neither `correlationKey` nor `idempotencyKey`, with 200 and `created`, for compatibility with released Meshery Servers that treat any non-200 answer as failure. Clients accept any 2xx and read this header rather than the status code to tell created from replayed. A server that implements condition correlation sends it on every 200 and 201. A server that predates correlation omits it; there 201 means created and 200 means replayed. A browser client calling a server on another origin reads it only when that server lists it in `Access-Control-Expose-Headers`. */
|
|
2041
|
+
"Event-Disposition"?: "created" | "replayed" | "incremented" | "resolved";
|
|
1604
2042
|
[name: string]: unknown;
|
|
1605
2043
|
};
|
|
1606
2044
|
content: {
|
|
@@ -1621,7 +2059,7 @@ export interface operations {
|
|
|
1621
2059
|
category: string;
|
|
1622
2060
|
/** @description Human-readable summary of what happened. */
|
|
1623
2061
|
description: string;
|
|
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
|
|
2062
|
+
/** @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: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`; docs/error-definition-contract.md), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. 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. */
|
|
1625
2063
|
metadata: {
|
|
1626
2064
|
[key: string]: unknown;
|
|
1627
2065
|
} | null;
|
|
@@ -1670,6 +2108,41 @@ export interface operations {
|
|
|
1670
2108
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
1671
2109
|
*/
|
|
1672
2110
|
deletedAt?: string | null;
|
|
2111
|
+
/** @description Key of the ongoing condition the event records (see EventPayload.correlationKey and createEvent); omitted for an event that reports no condition. */
|
|
2112
|
+
correlationKey?: string;
|
|
2113
|
+
/** @description How many occurrences of the condition this event counts. A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, an opening create or a resolving create inserted already resolved stores the payload's `occurrenceCount` (1 when omitted). Later creates that do not resolve add their count. A resolving create on the open event does not add to it. */
|
|
2114
|
+
occurrenceCount?: number;
|
|
2115
|
+
/**
|
|
2116
|
+
* Format: date-time
|
|
2117
|
+
* @description When the condition's first counted occurrence was seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.
|
|
2118
|
+
*/
|
|
2119
|
+
firstSeenAt?: string;
|
|
2120
|
+
/**
|
|
2121
|
+
* Format: date-time
|
|
2122
|
+
* @description When the condition was last seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.
|
|
2123
|
+
*/
|
|
2124
|
+
lastSeenAt?: string;
|
|
2125
|
+
/**
|
|
2126
|
+
* Format: date-time
|
|
2127
|
+
* @description When the condition cleared. A call that identifies no user stores the payload's value exactly as sent and does not close another event. For a call that identifies a user it is omitted while the condition is open, and set by a resolution (see createEvent), which also replaces `severity` and `description` with the payload's when the payload carries them (an omitted field keeps the stored value) and brings `lastSeenAt` forward, after which a new occurrence opens a new event.
|
|
2128
|
+
*/
|
|
2129
|
+
resolvedAt?: string;
|
|
2130
|
+
/**
|
|
2131
|
+
* Format: uri-reference
|
|
2132
|
+
* @description Which surface emitted the event (CloudEvents-compatible `source`), for example `meshery-server`, `meshery-ui`, `mesheryctl` or `meshery-adapter-istio`; see EventPayload.source. Omitted when the producer did not say.
|
|
2133
|
+
*/
|
|
2134
|
+
source?: string;
|
|
2135
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup`; see EventPayload.type. `category` and `action` stay the event's classification. */
|
|
2136
|
+
type?: string;
|
|
2137
|
+
/**
|
|
2138
|
+
* @description The CloudEvents specification version the event is compatible with; see EventPayload.specversion.
|
|
2139
|
+
* @enum {string}
|
|
2140
|
+
*/
|
|
2141
|
+
specversion?: "1.0";
|
|
2142
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to, as its client minted it; see EventPayload.traceId. */
|
|
2143
|
+
traceId?: string;
|
|
2144
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event; see EventPayload.parentId. */
|
|
2145
|
+
parentId?: string;
|
|
1673
2146
|
};
|
|
1674
2147
|
};
|
|
1675
2148
|
};
|
|
@@ -1809,6 +2282,74 @@ export interface operations {
|
|
|
1809
2282
|
* @description Timestamp when the event was recorded.
|
|
1810
2283
|
*/
|
|
1811
2284
|
createdAt?: string;
|
|
2285
|
+
/** @description Key of the ongoing condition the event records (see Event.correlationKey); omitted for an event that reports no condition. */
|
|
2286
|
+
correlationKey?: string;
|
|
2287
|
+
/** @description How many occurrences of the condition the event counts (see Event.occurrenceCount). A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, it is the payload's `occurrenceCount` (1 when omitted) when the event was recorded, opening a condition or inserted already resolved, growing only as later creates that do not resolve are counted. A resolving create on the open event does not add to it. */
|
|
2288
|
+
occurrenceCount?: number;
|
|
2289
|
+
/**
|
|
2290
|
+
* Format: date-time
|
|
2291
|
+
* @description When the condition's first counted occurrence was seen (see Event.firstSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.
|
|
2292
|
+
*/
|
|
2293
|
+
firstSeenAt?: string;
|
|
2294
|
+
/**
|
|
2295
|
+
* Format: date-time
|
|
2296
|
+
* @description When the condition was last seen (see Event.lastSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.
|
|
2297
|
+
*/
|
|
2298
|
+
lastSeenAt?: string;
|
|
2299
|
+
/**
|
|
2300
|
+
* Format: date-time
|
|
2301
|
+
* @description When the condition cleared (see Event.resolvedAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user it is omitted while the condition is open.
|
|
2302
|
+
*/
|
|
2303
|
+
resolvedAt?: string;
|
|
2304
|
+
/**
|
|
2305
|
+
* Format: uri-reference
|
|
2306
|
+
* @description Which surface emitted the event, for example `meshery-server` or `mesheryctl` (see Event.source).
|
|
2307
|
+
*/
|
|
2308
|
+
source?: string;
|
|
2309
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup` (see Event.type). */
|
|
2310
|
+
type?: string;
|
|
2311
|
+
/**
|
|
2312
|
+
* @description The CloudEvents specification version the event is compatible with (see Event.specversion).
|
|
2313
|
+
* @enum {string}
|
|
2314
|
+
*/
|
|
2315
|
+
specversion?: "1.0";
|
|
2316
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to (see Event.traceId). */
|
|
2317
|
+
traceId?: string;
|
|
2318
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event (see Event.parentId). */
|
|
2319
|
+
parentId?: string;
|
|
2320
|
+
/**
|
|
2321
|
+
* Format: uuid
|
|
2322
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2323
|
+
*/
|
|
2324
|
+
id?: string;
|
|
2325
|
+
/**
|
|
2326
|
+
* Format: uuid
|
|
2327
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2328
|
+
*/
|
|
2329
|
+
actedUpon?: string;
|
|
2330
|
+
/**
|
|
2331
|
+
* Format: uuid
|
|
2332
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2333
|
+
*/
|
|
2334
|
+
operationId?: string;
|
|
2335
|
+
/** @description Event level (see Event.severity). MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire, so consumers must tolerate other values. */
|
|
2336
|
+
severity?: string;
|
|
2337
|
+
/** @description Read state of the event (see Event.status). MeshKit records new events as `unread`, and acknowledged ones become `read`; consumers must tolerate other values. */
|
|
2338
|
+
status?: string;
|
|
2339
|
+
/** @description Event-specific details, the same nullable free-form map as Event.metadata. `null` when the producer attached none. On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. */
|
|
2340
|
+
metadata?: {
|
|
2341
|
+
[key: string]: unknown;
|
|
2342
|
+
} | null;
|
|
2343
|
+
/**
|
|
2344
|
+
* Format: date-time
|
|
2345
|
+
* @description Timestamp when the event was last updated (see Event.updatedAt).
|
|
2346
|
+
*/
|
|
2347
|
+
updatedAt?: string;
|
|
2348
|
+
/**
|
|
2349
|
+
* Format: date-time
|
|
2350
|
+
* @description Timestamp when the event was soft-deleted; omitted when it was not (see Event.deletedAt).
|
|
2351
|
+
*/
|
|
2352
|
+
deletedAt?: string | null;
|
|
1812
2353
|
}[];
|
|
1813
2354
|
};
|
|
1814
2355
|
};
|
|
@@ -1955,14 +2496,14 @@ export interface operations {
|
|
|
1955
2496
|
line: string;
|
|
1956
2497
|
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
1957
2498
|
networks?: string[];
|
|
1958
|
-
/** @description
|
|
2499
|
+
/** @description The same value PublicUser.username carries for the owner. Never email. Resolved for every served owner; omitted when empty. */
|
|
1959
2500
|
displayName?: string;
|
|
1960
2501
|
/**
|
|
1961
2502
|
* Format: uri
|
|
1962
|
-
* @description Public avatar URL;
|
|
2503
|
+
* @description Public avatar URL; resolved for every served owner, omitted when empty.
|
|
1963
2504
|
*/
|
|
1964
2505
|
avatarUrl?: string;
|
|
1965
|
-
/** @description Public organization name;
|
|
2506
|
+
/** @description Public organization name; omitted when organization memberships are not public to an anonymous caller. */
|
|
1966
2507
|
organizationName?: string;
|
|
1967
2508
|
/**
|
|
1968
2509
|
* Format: uri
|