@meshery/schemas 1.3.114 → 1.3.116
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 +1080 -8
- package/dist/cloudApi.d.ts +1080 -8
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +8 -0
- package/dist/constructs/v1beta2/core/CoreSchema.js +2 -2
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +2 -2
- package/dist/constructs/v1beta2/credential/Credential.d.ts +144 -0
- package/dist/constructs/v1beta2/credential/CredentialSchema.js +4 -1
- package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +4 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +84 -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 +930 -8
- package/dist/constructs/v1beta3/event/EventSchema.js +27 -11
- package/dist/constructs/v1beta3/event/EventSchema.mjs +27 -11
- package/dist/constructs/v1beta3/user/User.d.ts +8 -0
- package/dist/constructs/v1beta3/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta3/user/UserSchema.mjs +1 -1
- package/dist/index.d.mts +805 -79
- package/dist/index.d.ts +805 -79
- package/dist/index.js +10 -10
- package/dist/index.mjs +10 -10
- package/dist/mesheryApi.d.mts +338 -6
- package/dist/mesheryApi.d.ts +338 -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;
|
|
@@ -130,6 +138,32 @@ export interface paths {
|
|
|
130
138
|
patch?: never;
|
|
131
139
|
trace?: never;
|
|
132
140
|
};
|
|
141
|
+
"/api/events/feed": {
|
|
142
|
+
parameters: {
|
|
143
|
+
query?: never;
|
|
144
|
+
header?: never;
|
|
145
|
+
path?: never;
|
|
146
|
+
cookie?: never;
|
|
147
|
+
};
|
|
148
|
+
/**
|
|
149
|
+
* Get event feed
|
|
150
|
+
* @description Generic, unauthenticated feed of events whose visibility is `public`
|
|
151
|
+
* and whose owner's `shareActivityPublicly` preference is on at read
|
|
152
|
+
* time. Results are ordered newest first by `createdAt` and can be
|
|
153
|
+
* filtered by category and action. Rate limited per client IP; an
|
|
154
|
+
* over-limit client receives 429 with `Retry-After`. Responses carry
|
|
155
|
+
* `Cache-Control: public, max-age=N` where N is at most 30 seconds.
|
|
156
|
+
* See docs/event-feed-contract.md.
|
|
157
|
+
*/
|
|
158
|
+
get: operations["getEventFeed"];
|
|
159
|
+
put?: never;
|
|
160
|
+
post?: never;
|
|
161
|
+
delete?: never;
|
|
162
|
+
options?: never;
|
|
163
|
+
head?: never;
|
|
164
|
+
patch?: never;
|
|
165
|
+
trace?: never;
|
|
166
|
+
};
|
|
133
167
|
"/api/events/summary": {
|
|
134
168
|
parameters: {
|
|
135
169
|
query?: never;
|
|
@@ -168,7 +202,7 @@ export interface paths {
|
|
|
168
202
|
export type webhooks = Record<string, never>;
|
|
169
203
|
export interface components {
|
|
170
204
|
schemas: {
|
|
171
|
-
/** @description Payload for creating a new event. */
|
|
205
|
+
/** @description Payload for creating a new event. If visibility is absent, the event is private. */
|
|
172
206
|
EventPayload: {
|
|
173
207
|
/**
|
|
174
208
|
* Format: uuid
|
|
@@ -177,12 +211,55 @@ export interface components {
|
|
|
177
211
|
owner?: string;
|
|
178
212
|
/** @description The category of the event. */
|
|
179
213
|
category?: string;
|
|
214
|
+
/**
|
|
215
|
+
* @description Who can see the event. `private` is the default; clients may set `public` for events eligible for the unauthenticated feed.
|
|
216
|
+
* @default private
|
|
217
|
+
* @enum {string}
|
|
218
|
+
*/
|
|
219
|
+
visibility: "private" | "public";
|
|
180
220
|
/** @description The action of the event. */
|
|
181
221
|
action?: string;
|
|
182
222
|
/** @description Description of the event. */
|
|
183
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;
|
|
184
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. */
|
|
185
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;
|
|
186
263
|
} & {
|
|
187
264
|
[key: string]: unknown;
|
|
188
265
|
};
|
|
@@ -233,6 +310,12 @@ export interface components {
|
|
|
233
310
|
};
|
|
234
311
|
/** @description EventResult entity schema. */
|
|
235
312
|
EventResult: {
|
|
313
|
+
/**
|
|
314
|
+
* @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.
|
|
315
|
+
* @default private
|
|
316
|
+
* @enum {string}
|
|
317
|
+
*/
|
|
318
|
+
visibility: "private" | "public";
|
|
236
319
|
/**
|
|
237
320
|
* Format: uuid
|
|
238
321
|
* @description UUID of the user associated with the event.
|
|
@@ -255,6 +338,11 @@ export interface components {
|
|
|
255
338
|
firstName?: string;
|
|
256
339
|
/** @description The last name of the user associated with the event. */
|
|
257
340
|
lastName?: string;
|
|
341
|
+
/**
|
|
342
|
+
* Format: uri
|
|
343
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
344
|
+
*/
|
|
345
|
+
avatarUrl?: string;
|
|
258
346
|
/**
|
|
259
347
|
* Format: email
|
|
260
348
|
* @description Email address of the user associated with the event.
|
|
@@ -267,6 +355,74 @@ export interface components {
|
|
|
267
355
|
* @description Timestamp when the event was recorded.
|
|
268
356
|
*/
|
|
269
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;
|
|
270
426
|
};
|
|
271
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. */
|
|
272
428
|
Event: {
|
|
@@ -286,7 +442,7 @@ export interface components {
|
|
|
286
442
|
category: string;
|
|
287
443
|
/** @description Human-readable summary of what happened. */
|
|
288
444
|
description: string;
|
|
289
|
-
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed
|
|
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. */
|
|
290
446
|
metadata: {
|
|
291
447
|
[key: string]: unknown;
|
|
292
448
|
} | null;
|
|
@@ -324,11 +480,52 @@ export interface components {
|
|
|
324
480
|
* @description Timestamp when the event was last updated.
|
|
325
481
|
*/
|
|
326
482
|
updatedAt: string;
|
|
483
|
+
/**
|
|
484
|
+
* @description Who can see the event. Defaults to `private`.
|
|
485
|
+
* @default private
|
|
486
|
+
* @enum {string}
|
|
487
|
+
*/
|
|
488
|
+
visibility: "private" | "public";
|
|
327
489
|
/**
|
|
328
490
|
* Format: date-time
|
|
329
491
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
330
492
|
*/
|
|
331
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;
|
|
332
529
|
};
|
|
333
530
|
/** @description Paginated list of events. */
|
|
334
531
|
EventsPage: {
|
|
@@ -340,6 +537,12 @@ export interface components {
|
|
|
340
537
|
totalCount?: number;
|
|
341
538
|
/** @description The events returned on the current page. */
|
|
342
539
|
data?: {
|
|
540
|
+
/**
|
|
541
|
+
* @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.
|
|
542
|
+
* @default private
|
|
543
|
+
* @enum {string}
|
|
544
|
+
*/
|
|
545
|
+
visibility: "private" | "public";
|
|
343
546
|
/**
|
|
344
547
|
* Format: uuid
|
|
345
548
|
* @description UUID of the user associated with the event.
|
|
@@ -362,6 +565,11 @@ export interface components {
|
|
|
362
565
|
firstName?: string;
|
|
363
566
|
/** @description The last name of the user associated with the event. */
|
|
364
567
|
lastName?: string;
|
|
568
|
+
/**
|
|
569
|
+
* Format: uri
|
|
570
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
571
|
+
*/
|
|
572
|
+
avatarUrl?: string;
|
|
365
573
|
/**
|
|
366
574
|
* Format: email
|
|
367
575
|
* @description Email address of the user associated with the event.
|
|
@@ -374,6 +582,207 @@ export interface components {
|
|
|
374
582
|
* @description Timestamp when the event was recorded.
|
|
375
583
|
*/
|
|
376
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;
|
|
653
|
+
}[];
|
|
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";
|
|
660
|
+
/**
|
|
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.
|
|
662
|
+
* @default private
|
|
663
|
+
* @enum {string}
|
|
664
|
+
*/
|
|
665
|
+
EventVisibility: "private" | "public";
|
|
666
|
+
/**
|
|
667
|
+
* @description An event projected into the public feed. It never includes email,
|
|
668
|
+
* firstName, lastName, description, provider or raw metadata.
|
|
669
|
+
* `platform`, `role`, `line` and `networks` are projected from
|
|
670
|
+
* ScheduleCompletedEventMetadata; events without valid required
|
|
671
|
+
* metadata are skipped. Public profile fields are resolved by Cloud at
|
|
672
|
+
* read time and are included only when the user's profile is public.
|
|
673
|
+
*/
|
|
674
|
+
EventFeedItem: {
|
|
675
|
+
/**
|
|
676
|
+
* Format: uuid
|
|
677
|
+
* @description Event ID.
|
|
678
|
+
*/
|
|
679
|
+
id: string;
|
|
680
|
+
/**
|
|
681
|
+
* Format: uuid
|
|
682
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
683
|
+
*/
|
|
684
|
+
userId: string;
|
|
685
|
+
/** @description Event category. */
|
|
686
|
+
category: string;
|
|
687
|
+
/** @description Event action. */
|
|
688
|
+
action: string;
|
|
689
|
+
/**
|
|
690
|
+
* Format: date-time
|
|
691
|
+
* @description Event creation time; the feed is ordered newest first.
|
|
692
|
+
*/
|
|
693
|
+
createdAt: string;
|
|
694
|
+
/**
|
|
695
|
+
* @description Always `public` in the feed.
|
|
696
|
+
* @default private
|
|
697
|
+
* @enum {string}
|
|
698
|
+
*/
|
|
699
|
+
visibility: "private" | "public";
|
|
700
|
+
/**
|
|
701
|
+
* @description Platform from ScheduleCompletedEventMetadata.
|
|
702
|
+
* @enum {string}
|
|
703
|
+
*/
|
|
704
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
705
|
+
/** @description Role from ScheduleCompletedEventMetadata. */
|
|
706
|
+
role: string;
|
|
707
|
+
/** @description One-line result from ScheduleCompletedEventMetadata. */
|
|
708
|
+
line: string;
|
|
709
|
+
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
710
|
+
networks?: string[];
|
|
711
|
+
/** @description Public username, never a real name; present only for a public profile. */
|
|
712
|
+
displayName?: string;
|
|
713
|
+
/**
|
|
714
|
+
* Format: uri
|
|
715
|
+
* @description Public avatar URL; present only for a public profile.
|
|
716
|
+
*/
|
|
717
|
+
avatarUrl?: string;
|
|
718
|
+
/** @description Public organization name; present only for a public profile. */
|
|
719
|
+
organizationName?: string;
|
|
720
|
+
/**
|
|
721
|
+
* Format: uri
|
|
722
|
+
* @description HTTPS URL of the user's public profile.
|
|
723
|
+
*/
|
|
724
|
+
publicProfileUrl?: string;
|
|
725
|
+
};
|
|
726
|
+
/** @description One page of event feed items, newest first. */
|
|
727
|
+
EventFeedPage: {
|
|
728
|
+
/** @description Current page number of the result set. */
|
|
729
|
+
page: number;
|
|
730
|
+
/** @description Number of items per page. */
|
|
731
|
+
pageSize: number;
|
|
732
|
+
/** @description Total number of matching feed events. */
|
|
733
|
+
totalCount: number;
|
|
734
|
+
/** @description Events for the requested page, newest first. */
|
|
735
|
+
data: {
|
|
736
|
+
/**
|
|
737
|
+
* Format: uuid
|
|
738
|
+
* @description Event ID.
|
|
739
|
+
*/
|
|
740
|
+
id: string;
|
|
741
|
+
/**
|
|
742
|
+
* Format: uuid
|
|
743
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
744
|
+
*/
|
|
745
|
+
userId: string;
|
|
746
|
+
/** @description Event category. */
|
|
747
|
+
category: string;
|
|
748
|
+
/** @description Event action. */
|
|
749
|
+
action: string;
|
|
750
|
+
/**
|
|
751
|
+
* Format: date-time
|
|
752
|
+
* @description Event creation time; the feed is ordered newest first.
|
|
753
|
+
*/
|
|
754
|
+
createdAt: string;
|
|
755
|
+
/**
|
|
756
|
+
* @description Always `public` in the feed.
|
|
757
|
+
* @default private
|
|
758
|
+
* @enum {string}
|
|
759
|
+
*/
|
|
760
|
+
visibility: "private" | "public";
|
|
761
|
+
/**
|
|
762
|
+
* @description Platform from ScheduleCompletedEventMetadata.
|
|
763
|
+
* @enum {string}
|
|
764
|
+
*/
|
|
765
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
766
|
+
/** @description Role from ScheduleCompletedEventMetadata. */
|
|
767
|
+
role: string;
|
|
768
|
+
/** @description One-line result from ScheduleCompletedEventMetadata. */
|
|
769
|
+
line: string;
|
|
770
|
+
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
771
|
+
networks?: string[];
|
|
772
|
+
/** @description Public username, never a real name; present only for a public profile. */
|
|
773
|
+
displayName?: string;
|
|
774
|
+
/**
|
|
775
|
+
* Format: uri
|
|
776
|
+
* @description Public avatar URL; present only for a public profile.
|
|
777
|
+
*/
|
|
778
|
+
avatarUrl?: string;
|
|
779
|
+
/** @description Public organization name; present only for a public profile. */
|
|
780
|
+
organizationName?: string;
|
|
781
|
+
/**
|
|
782
|
+
* Format: uri
|
|
783
|
+
* @description HTTPS URL of the user's public profile.
|
|
784
|
+
*/
|
|
785
|
+
publicProfileUrl?: string;
|
|
377
786
|
}[];
|
|
378
787
|
};
|
|
379
788
|
/** @description Aggregated event counts across categories. */
|
|
@@ -529,6 +938,75 @@ export interface components {
|
|
|
529
938
|
/** @description One short, human-readable line saying what went wrong; omitted when the producer has none. Never design contents. */
|
|
530
939
|
message?: string;
|
|
531
940
|
};
|
|
941
|
+
/** @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). */
|
|
942
|
+
EventError: {
|
|
943
|
+
/** @description The full error code, for example `meshery-server-1033`, as the definition names it. Consumers must tolerate codes they do not know. */
|
|
944
|
+
code: string;
|
|
945
|
+
/** @description The component that owns the code, when the producer names it; the code's prefix is the component's name. */
|
|
946
|
+
component?: {
|
|
947
|
+
/** @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. */
|
|
948
|
+
type: string;
|
|
949
|
+
/** @description The component's name, for example `meshery-server`, `meshkit` or `mesheryctl`. It is the prefix of every code the component owns. */
|
|
950
|
+
name: string;
|
|
951
|
+
};
|
|
952
|
+
/**
|
|
953
|
+
* @description The definition's severity. The event's own `severity` is the level this occurrence was recorded at.
|
|
954
|
+
* @enum {string}
|
|
955
|
+
*/
|
|
956
|
+
severity?: "emergency" | "alert" | "critical" | "fatal" | "error" | "warning" | "informational" | "debug";
|
|
957
|
+
/** @description The definition's short description, rendered for this occurrence. */
|
|
958
|
+
shortDescription?: string;
|
|
959
|
+
/** @description The definition's long description, rendered for this occurrence. */
|
|
960
|
+
longDescription?: string;
|
|
961
|
+
/** @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. */
|
|
962
|
+
probableCauses?: {
|
|
963
|
+
/** @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. */
|
|
964
|
+
id: string;
|
|
965
|
+
/** @description What may have caused the error, for example `The service is not running.` */
|
|
966
|
+
description: string;
|
|
967
|
+
/** @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. */
|
|
968
|
+
remediations: {
|
|
969
|
+
/** @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. */
|
|
970
|
+
id: string;
|
|
971
|
+
/** @description What to do, written for a person, for example `Start the service.` */
|
|
972
|
+
description: string;
|
|
973
|
+
/** @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. */
|
|
974
|
+
action?: string;
|
|
975
|
+
/**
|
|
976
|
+
* @description Whether a client may run `action` on its own. `automatic` and `requiresApproval` need an `action`. Omitted means `manual`.
|
|
977
|
+
* @enum {string}
|
|
978
|
+
*/
|
|
979
|
+
actionPolicy?: "automatic" | "requiresApproval" | "manual";
|
|
980
|
+
}[];
|
|
981
|
+
}[];
|
|
982
|
+
/** @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. */
|
|
983
|
+
matchedCauses?: {
|
|
984
|
+
/** @description The `id` of the matched cause in the error's definition (ProbableCause.id). */
|
|
985
|
+
causeId: string;
|
|
986
|
+
/** @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. */
|
|
987
|
+
confidence?: number;
|
|
988
|
+
}[];
|
|
989
|
+
/** @description The flat list of cause descriptions (MeshKit's `ProbableCause`). With `probableCauses`, it equals each cause's `description` in order; without, it is unpaired. */
|
|
990
|
+
probableCause?: string[];
|
|
991
|
+
/** @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. */
|
|
992
|
+
suggestedRemediation?: string[];
|
|
993
|
+
/**
|
|
994
|
+
* Format: uri
|
|
995
|
+
* @description The code's page on docs.meshery.io (ErrorDefinition.referenceUrl), when the producer knows it.
|
|
996
|
+
*/
|
|
997
|
+
referenceUrl?: string;
|
|
998
|
+
/** @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. */
|
|
999
|
+
details?: {
|
|
1000
|
+
[key: string]: unknown;
|
|
1001
|
+
};
|
|
1002
|
+
};
|
|
1003
|
+
/** @description One cause an error event names as likely for this occurrence (EventError.matchedCauses). */
|
|
1004
|
+
EventMatchedCause: {
|
|
1005
|
+
/** @description The `id` of the matched cause in the error's definition (ProbableCause.id). */
|
|
1006
|
+
causeId: string;
|
|
1007
|
+
/** @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. */
|
|
1008
|
+
confidence?: number;
|
|
1009
|
+
};
|
|
532
1010
|
/** @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. */
|
|
533
1011
|
DesignSavedEventMetadata: {
|
|
534
1012
|
/** @description One-line title of the save for the design's history, for example `Version v0.0.3 - 12 components and 9 relationships`. */
|
|
@@ -554,6 +1032,20 @@ export interface components {
|
|
|
554
1032
|
/** @description Name of the saved design. */
|
|
555
1033
|
name?: string;
|
|
556
1034
|
};
|
|
1035
|
+
/** @description Metadata for a completed scheduled run (category `schedule`, action `completed`). This typed shape keeps client-specific display data out of the core Event fields and is projected into EventFeedItem. */
|
|
1036
|
+
ScheduleCompletedEventMetadata: {
|
|
1037
|
+
/**
|
|
1038
|
+
* @description Platform the completed run acted on.
|
|
1039
|
+
* @enum {string}
|
|
1040
|
+
*/
|
|
1041
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
1042
|
+
/** @description Role the completed run acted in. */
|
|
1043
|
+
role: string;
|
|
1044
|
+
/** @description One-line result of the run. */
|
|
1045
|
+
line: string;
|
|
1046
|
+
/** @description Networks or communities where the run acted. */
|
|
1047
|
+
networks?: string[];
|
|
1048
|
+
};
|
|
557
1049
|
};
|
|
558
1050
|
responses: {
|
|
559
1051
|
/** @description Invalid request body or request param */
|
|
@@ -657,6 +1149,12 @@ export interface components {
|
|
|
657
1149
|
* @description Get responses by pagesize. Deprecated alias of pageSize.
|
|
658
1150
|
*/
|
|
659
1151
|
pagesizeLegacy: number;
|
|
1152
|
+
/** @description Number of feed items per page. */
|
|
1153
|
+
feedPagesize: number;
|
|
1154
|
+
/** @description Optional event category filter. */
|
|
1155
|
+
feedCategory: string;
|
|
1156
|
+
/** @description Optional event action filter. */
|
|
1157
|
+
feedAction: string;
|
|
660
1158
|
/** @description Get responses that match search param value */
|
|
661
1159
|
search: string;
|
|
662
1160
|
/** @description Get ordered responses */
|
|
@@ -671,7 +1169,10 @@ export interface components {
|
|
|
671
1169
|
eventsScope: "user" | "organization";
|
|
672
1170
|
};
|
|
673
1171
|
requestBodies: never;
|
|
674
|
-
headers:
|
|
1172
|
+
headers: {
|
|
1173
|
+
/** @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`. */
|
|
1174
|
+
EventDisposition: "created" | "replayed" | "incremented" | "resolved";
|
|
1175
|
+
};
|
|
675
1176
|
pathItems: never;
|
|
676
1177
|
}
|
|
677
1178
|
export type $defs = Record<string, never>;
|
|
@@ -1072,6 +1573,12 @@ export interface operations {
|
|
|
1072
1573
|
totalCount?: number;
|
|
1073
1574
|
/** @description The events returned on the current page. */
|
|
1074
1575
|
data?: {
|
|
1576
|
+
/**
|
|
1577
|
+
* @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.
|
|
1578
|
+
* @default private
|
|
1579
|
+
* @enum {string}
|
|
1580
|
+
*/
|
|
1581
|
+
visibility: "private" | "public";
|
|
1075
1582
|
/**
|
|
1076
1583
|
* Format: uuid
|
|
1077
1584
|
* @description UUID of the user associated with the event.
|
|
@@ -1094,6 +1601,11 @@ export interface operations {
|
|
|
1094
1601
|
firstName?: string;
|
|
1095
1602
|
/** @description The last name of the user associated with the event. */
|
|
1096
1603
|
lastName?: string;
|
|
1604
|
+
/**
|
|
1605
|
+
* Format: uri
|
|
1606
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
1607
|
+
*/
|
|
1608
|
+
avatarUrl?: string;
|
|
1097
1609
|
/**
|
|
1098
1610
|
* Format: email
|
|
1099
1611
|
* @description Email address of the user associated with the event.
|
|
@@ -1106,6 +1618,74 @@ export interface operations {
|
|
|
1106
1618
|
* @description Timestamp when the event was recorded.
|
|
1107
1619
|
*/
|
|
1108
1620
|
createdAt?: string;
|
|
1621
|
+
/** @description Key of the ongoing condition the event records (see Event.correlationKey); omitted for an event that reports no condition. */
|
|
1622
|
+
correlationKey?: string;
|
|
1623
|
+
/** @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. */
|
|
1624
|
+
occurrenceCount?: number;
|
|
1625
|
+
/**
|
|
1626
|
+
* Format: date-time
|
|
1627
|
+
* @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.
|
|
1628
|
+
*/
|
|
1629
|
+
firstSeenAt?: string;
|
|
1630
|
+
/**
|
|
1631
|
+
* Format: date-time
|
|
1632
|
+
* @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.
|
|
1633
|
+
*/
|
|
1634
|
+
lastSeenAt?: string;
|
|
1635
|
+
/**
|
|
1636
|
+
* Format: date-time
|
|
1637
|
+
* @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.
|
|
1638
|
+
*/
|
|
1639
|
+
resolvedAt?: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* Format: uri-reference
|
|
1642
|
+
* @description Which surface emitted the event, for example `meshery-server` or `mesheryctl` (see Event.source).
|
|
1643
|
+
*/
|
|
1644
|
+
source?: string;
|
|
1645
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup` (see Event.type). */
|
|
1646
|
+
type?: string;
|
|
1647
|
+
/**
|
|
1648
|
+
* @description The CloudEvents specification version the event is compatible with (see Event.specversion).
|
|
1649
|
+
* @enum {string}
|
|
1650
|
+
*/
|
|
1651
|
+
specversion?: "1.0";
|
|
1652
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to (see Event.traceId). */
|
|
1653
|
+
traceId?: string;
|
|
1654
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event (see Event.parentId). */
|
|
1655
|
+
parentId?: string;
|
|
1656
|
+
/**
|
|
1657
|
+
* Format: uuid
|
|
1658
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1659
|
+
*/
|
|
1660
|
+
id?: string;
|
|
1661
|
+
/**
|
|
1662
|
+
* Format: uuid
|
|
1663
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1664
|
+
*/
|
|
1665
|
+
actedUpon?: string;
|
|
1666
|
+
/**
|
|
1667
|
+
* Format: uuid
|
|
1668
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1669
|
+
*/
|
|
1670
|
+
operationId?: string;
|
|
1671
|
+
/** @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. */
|
|
1672
|
+
severity?: string;
|
|
1673
|
+
/** @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. */
|
|
1674
|
+
status?: string;
|
|
1675
|
+
/** @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. */
|
|
1676
|
+
metadata?: {
|
|
1677
|
+
[key: string]: unknown;
|
|
1678
|
+
} | null;
|
|
1679
|
+
/**
|
|
1680
|
+
* Format: date-time
|
|
1681
|
+
* @description Timestamp when the event was last updated (see Event.updatedAt).
|
|
1682
|
+
*/
|
|
1683
|
+
updatedAt?: string;
|
|
1684
|
+
/**
|
|
1685
|
+
* Format: date-time
|
|
1686
|
+
* @description Timestamp when the event was soft-deleted; omitted when it was not (see Event.deletedAt).
|
|
1687
|
+
*/
|
|
1688
|
+
deletedAt?: string | null;
|
|
1109
1689
|
}[];
|
|
1110
1690
|
};
|
|
1111
1691
|
};
|
|
@@ -1286,21 +1866,66 @@ export interface operations {
|
|
|
1286
1866
|
owner?: string;
|
|
1287
1867
|
/** @description The category of the event. */
|
|
1288
1868
|
category?: string;
|
|
1869
|
+
/**
|
|
1870
|
+
* @description Who can see the event. `private` is the default; clients may set `public` for events eligible for the unauthenticated feed.
|
|
1871
|
+
* @default private
|
|
1872
|
+
* @enum {string}
|
|
1873
|
+
*/
|
|
1874
|
+
visibility?: "private" | "public";
|
|
1289
1875
|
/** @description The action of the event. */
|
|
1290
1876
|
action?: string;
|
|
1291
1877
|
/** @description Description of the event. */
|
|
1292
1878
|
description?: string;
|
|
1879
|
+
/** @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. */
|
|
1880
|
+
severity?: string;
|
|
1293
1881
|
/** @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. */
|
|
1294
1882
|
idempotencyKey?: string;
|
|
1883
|
+
/** @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. */
|
|
1884
|
+
correlationKey?: string;
|
|
1885
|
+
/** @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. */
|
|
1886
|
+
occurrenceCount?: number;
|
|
1887
|
+
/**
|
|
1888
|
+
* Format: date-time
|
|
1889
|
+
* @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.
|
|
1890
|
+
*/
|
|
1891
|
+
firstSeenAt?: string;
|
|
1892
|
+
/**
|
|
1893
|
+
* Format: date-time
|
|
1894
|
+
* @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`.
|
|
1895
|
+
*/
|
|
1896
|
+
lastSeenAt?: string;
|
|
1897
|
+
/**
|
|
1898
|
+
* Format: date-time
|
|
1899
|
+
* @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.
|
|
1900
|
+
*/
|
|
1901
|
+
resolvedAt?: string;
|
|
1902
|
+
/**
|
|
1903
|
+
* Format: uri-reference
|
|
1904
|
+
* @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.
|
|
1905
|
+
*/
|
|
1906
|
+
source?: string;
|
|
1907
|
+
/** @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. */
|
|
1908
|
+
type?: string;
|
|
1909
|
+
/**
|
|
1910
|
+
* @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.
|
|
1911
|
+
* @enum {string}
|
|
1912
|
+
*/
|
|
1913
|
+
specversion?: "1.0";
|
|
1914
|
+
/** @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. */
|
|
1915
|
+
traceId?: string;
|
|
1916
|
+
/** @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. */
|
|
1917
|
+
parentId?: string;
|
|
1295
1918
|
} & {
|
|
1296
1919
|
[key: string]: unknown;
|
|
1297
1920
|
};
|
|
1298
1921
|
};
|
|
1299
1922
|
};
|
|
1300
1923
|
responses: {
|
|
1301
|
-
/** @description
|
|
1924
|
+
/** @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. */
|
|
1302
1925
|
200: {
|
|
1303
1926
|
headers: {
|
|
1927
|
+
/** @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`. */
|
|
1928
|
+
"Event-Disposition"?: "created" | "replayed" | "incremented" | "resolved";
|
|
1304
1929
|
[name: string]: unknown;
|
|
1305
1930
|
};
|
|
1306
1931
|
content: {
|
|
@@ -1321,7 +1946,7 @@ export interface operations {
|
|
|
1321
1946
|
category: string;
|
|
1322
1947
|
/** @description Human-readable summary of what happened. */
|
|
1323
1948
|
description: string;
|
|
1324
|
-
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed
|
|
1949
|
+
/** @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. */
|
|
1325
1950
|
metadata: {
|
|
1326
1951
|
[key: string]: unknown;
|
|
1327
1952
|
} | null;
|
|
@@ -1359,17 +1984,60 @@ export interface operations {
|
|
|
1359
1984
|
* @description Timestamp when the event was last updated.
|
|
1360
1985
|
*/
|
|
1361
1986
|
updatedAt: string;
|
|
1987
|
+
/**
|
|
1988
|
+
* @description Who can see the event. Defaults to `private`.
|
|
1989
|
+
* @default private
|
|
1990
|
+
* @enum {string}
|
|
1991
|
+
*/
|
|
1992
|
+
visibility: "private" | "public";
|
|
1362
1993
|
/**
|
|
1363
1994
|
* Format: date-time
|
|
1364
1995
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
1365
1996
|
*/
|
|
1366
1997
|
deletedAt?: string | null;
|
|
1998
|
+
/** @description Key of the ongoing condition the event records (see EventPayload.correlationKey and createEvent); omitted for an event that reports no condition. */
|
|
1999
|
+
correlationKey?: string;
|
|
2000
|
+
/** @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. */
|
|
2001
|
+
occurrenceCount?: number;
|
|
2002
|
+
/**
|
|
2003
|
+
* Format: date-time
|
|
2004
|
+
* @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.
|
|
2005
|
+
*/
|
|
2006
|
+
firstSeenAt?: string;
|
|
2007
|
+
/**
|
|
2008
|
+
* Format: date-time
|
|
2009
|
+
* @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.
|
|
2010
|
+
*/
|
|
2011
|
+
lastSeenAt?: string;
|
|
2012
|
+
/**
|
|
2013
|
+
* Format: date-time
|
|
2014
|
+
* @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.
|
|
2015
|
+
*/
|
|
2016
|
+
resolvedAt?: string;
|
|
2017
|
+
/**
|
|
2018
|
+
* Format: uri-reference
|
|
2019
|
+
* @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.
|
|
2020
|
+
*/
|
|
2021
|
+
source?: string;
|
|
2022
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup`; see EventPayload.type. `category` and `action` stay the event's classification. */
|
|
2023
|
+
type?: string;
|
|
2024
|
+
/**
|
|
2025
|
+
* @description The CloudEvents specification version the event is compatible with; see EventPayload.specversion.
|
|
2026
|
+
* @enum {string}
|
|
2027
|
+
*/
|
|
2028
|
+
specversion?: "1.0";
|
|
2029
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to, as its client minted it; see EventPayload.traceId. */
|
|
2030
|
+
traceId?: string;
|
|
2031
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event; see EventPayload.parentId. */
|
|
2032
|
+
parentId?: string;
|
|
1367
2033
|
};
|
|
1368
2034
|
};
|
|
1369
2035
|
};
|
|
1370
|
-
/** @description Event created */
|
|
2036
|
+
/** @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`. */
|
|
1371
2037
|
201: {
|
|
1372
2038
|
headers: {
|
|
2039
|
+
/** @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`. */
|
|
2040
|
+
"Event-Disposition"?: "created" | "replayed" | "incremented" | "resolved";
|
|
1373
2041
|
[name: string]: unknown;
|
|
1374
2042
|
};
|
|
1375
2043
|
content: {
|
|
@@ -1390,7 +2058,7 @@ export interface operations {
|
|
|
1390
2058
|
category: string;
|
|
1391
2059
|
/** @description Human-readable summary of what happened. */
|
|
1392
2060
|
description: string;
|
|
1393
|
-
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed
|
|
2061
|
+
/** @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. */
|
|
1394
2062
|
metadata: {
|
|
1395
2063
|
[key: string]: unknown;
|
|
1396
2064
|
} | null;
|
|
@@ -1428,11 +2096,52 @@ export interface operations {
|
|
|
1428
2096
|
* @description Timestamp when the event was last updated.
|
|
1429
2097
|
*/
|
|
1430
2098
|
updatedAt: string;
|
|
2099
|
+
/**
|
|
2100
|
+
* @description Who can see the event. Defaults to `private`.
|
|
2101
|
+
* @default private
|
|
2102
|
+
* @enum {string}
|
|
2103
|
+
*/
|
|
2104
|
+
visibility: "private" | "public";
|
|
1431
2105
|
/**
|
|
1432
2106
|
* Format: date-time
|
|
1433
2107
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
1434
2108
|
*/
|
|
1435
2109
|
deletedAt?: string | null;
|
|
2110
|
+
/** @description Key of the ongoing condition the event records (see EventPayload.correlationKey and createEvent); omitted for an event that reports no condition. */
|
|
2111
|
+
correlationKey?: string;
|
|
2112
|
+
/** @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. */
|
|
2113
|
+
occurrenceCount?: number;
|
|
2114
|
+
/**
|
|
2115
|
+
* Format: date-time
|
|
2116
|
+
* @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.
|
|
2117
|
+
*/
|
|
2118
|
+
firstSeenAt?: string;
|
|
2119
|
+
/**
|
|
2120
|
+
* Format: date-time
|
|
2121
|
+
* @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.
|
|
2122
|
+
*/
|
|
2123
|
+
lastSeenAt?: string;
|
|
2124
|
+
/**
|
|
2125
|
+
* Format: date-time
|
|
2126
|
+
* @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.
|
|
2127
|
+
*/
|
|
2128
|
+
resolvedAt?: string;
|
|
2129
|
+
/**
|
|
2130
|
+
* Format: uri-reference
|
|
2131
|
+
* @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.
|
|
2132
|
+
*/
|
|
2133
|
+
source?: string;
|
|
2134
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup`; see EventPayload.type. `category` and `action` stay the event's classification. */
|
|
2135
|
+
type?: string;
|
|
2136
|
+
/**
|
|
2137
|
+
* @description The CloudEvents specification version the event is compatible with; see EventPayload.specversion.
|
|
2138
|
+
* @enum {string}
|
|
2139
|
+
*/
|
|
2140
|
+
specversion?: "1.0";
|
|
2141
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to, as its client minted it; see EventPayload.traceId. */
|
|
2142
|
+
traceId?: string;
|
|
2143
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event; see EventPayload.parentId. */
|
|
2144
|
+
parentId?: string;
|
|
1436
2145
|
};
|
|
1437
2146
|
};
|
|
1438
2147
|
};
|
|
@@ -1527,6 +2236,12 @@ export interface operations {
|
|
|
1527
2236
|
totalCount?: number;
|
|
1528
2237
|
/** @description The events returned on the current page. */
|
|
1529
2238
|
data?: {
|
|
2239
|
+
/**
|
|
2240
|
+
* @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.
|
|
2241
|
+
* @default private
|
|
2242
|
+
* @enum {string}
|
|
2243
|
+
*/
|
|
2244
|
+
visibility: "private" | "public";
|
|
1530
2245
|
/**
|
|
1531
2246
|
* Format: uuid
|
|
1532
2247
|
* @description UUID of the user associated with the event.
|
|
@@ -1549,6 +2264,11 @@ export interface operations {
|
|
|
1549
2264
|
firstName?: string;
|
|
1550
2265
|
/** @description The last name of the user associated with the event. */
|
|
1551
2266
|
lastName?: string;
|
|
2267
|
+
/**
|
|
2268
|
+
* Format: uri
|
|
2269
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
2270
|
+
*/
|
|
2271
|
+
avatarUrl?: string;
|
|
1552
2272
|
/**
|
|
1553
2273
|
* Format: email
|
|
1554
2274
|
* @description Email address of the user associated with the event.
|
|
@@ -1561,6 +2281,74 @@ export interface operations {
|
|
|
1561
2281
|
* @description Timestamp when the event was recorded.
|
|
1562
2282
|
*/
|
|
1563
2283
|
createdAt?: string;
|
|
2284
|
+
/** @description Key of the ongoing condition the event records (see Event.correlationKey); omitted for an event that reports no condition. */
|
|
2285
|
+
correlationKey?: string;
|
|
2286
|
+
/** @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. */
|
|
2287
|
+
occurrenceCount?: number;
|
|
2288
|
+
/**
|
|
2289
|
+
* Format: date-time
|
|
2290
|
+
* @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.
|
|
2291
|
+
*/
|
|
2292
|
+
firstSeenAt?: string;
|
|
2293
|
+
/**
|
|
2294
|
+
* Format: date-time
|
|
2295
|
+
* @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.
|
|
2296
|
+
*/
|
|
2297
|
+
lastSeenAt?: string;
|
|
2298
|
+
/**
|
|
2299
|
+
* Format: date-time
|
|
2300
|
+
* @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.
|
|
2301
|
+
*/
|
|
2302
|
+
resolvedAt?: string;
|
|
2303
|
+
/**
|
|
2304
|
+
* Format: uri-reference
|
|
2305
|
+
* @description Which surface emitted the event, for example `meshery-server` or `mesheryctl` (see Event.source).
|
|
2306
|
+
*/
|
|
2307
|
+
source?: string;
|
|
2308
|
+
/** @description CloudEvents-compatible `type`, for example `io.meshery.user.signup` (see Event.type). */
|
|
2309
|
+
type?: string;
|
|
2310
|
+
/**
|
|
2311
|
+
* @description The CloudEvents specification version the event is compatible with (see Event.specversion).
|
|
2312
|
+
* @enum {string}
|
|
2313
|
+
*/
|
|
2314
|
+
specversion?: "1.0";
|
|
2315
|
+
/** @description W3C Trace Context `trace-id` of the operation the event belongs to (see Event.traceId). */
|
|
2316
|
+
traceId?: string;
|
|
2317
|
+
/** @description W3C Trace Context `parent-id` of the sub-operation that emitted the event (see Event.parentId). */
|
|
2318
|
+
parentId?: string;
|
|
2319
|
+
/**
|
|
2320
|
+
* Format: uuid
|
|
2321
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2322
|
+
*/
|
|
2323
|
+
id?: string;
|
|
2324
|
+
/**
|
|
2325
|
+
* Format: uuid
|
|
2326
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2327
|
+
*/
|
|
2328
|
+
actedUpon?: string;
|
|
2329
|
+
/**
|
|
2330
|
+
* Format: uuid
|
|
2331
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2332
|
+
*/
|
|
2333
|
+
operationId?: string;
|
|
2334
|
+
/** @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. */
|
|
2335
|
+
severity?: string;
|
|
2336
|
+
/** @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. */
|
|
2337
|
+
status?: string;
|
|
2338
|
+
/** @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. */
|
|
2339
|
+
metadata?: {
|
|
2340
|
+
[key: string]: unknown;
|
|
2341
|
+
} | null;
|
|
2342
|
+
/**
|
|
2343
|
+
* Format: date-time
|
|
2344
|
+
* @description Timestamp when the event was last updated (see Event.updatedAt).
|
|
2345
|
+
*/
|
|
2346
|
+
updatedAt?: string;
|
|
2347
|
+
/**
|
|
2348
|
+
* Format: date-time
|
|
2349
|
+
* @description Timestamp when the event was soft-deleted; omitted when it was not (see Event.deletedAt).
|
|
2350
|
+
*/
|
|
2351
|
+
deletedAt?: string | null;
|
|
1564
2352
|
}[];
|
|
1565
2353
|
};
|
|
1566
2354
|
};
|
|
@@ -1636,6 +2424,140 @@ export interface operations {
|
|
|
1636
2424
|
};
|
|
1637
2425
|
};
|
|
1638
2426
|
};
|
|
2427
|
+
getEventFeed: {
|
|
2428
|
+
parameters: {
|
|
2429
|
+
query?: {
|
|
2430
|
+
/** @description Get responses by page */
|
|
2431
|
+
page?: number;
|
|
2432
|
+
/** @description Number of feed items per page. */
|
|
2433
|
+
pagesize?: number;
|
|
2434
|
+
/** @description Optional event category filter. */
|
|
2435
|
+
category?: string;
|
|
2436
|
+
/** @description Optional event action filter. */
|
|
2437
|
+
action?: string;
|
|
2438
|
+
};
|
|
2439
|
+
header?: never;
|
|
2440
|
+
path?: never;
|
|
2441
|
+
cookie?: never;
|
|
2442
|
+
};
|
|
2443
|
+
requestBody?: never;
|
|
2444
|
+
responses: {
|
|
2445
|
+
/** @description Event feed page */
|
|
2446
|
+
200: {
|
|
2447
|
+
headers: {
|
|
2448
|
+
/** @description `public, max-age=N` with N from 0 to 30; max-age never exceeds 30 seconds. */
|
|
2449
|
+
"Cache-Control": string;
|
|
2450
|
+
[name: string]: unknown;
|
|
2451
|
+
};
|
|
2452
|
+
content: {
|
|
2453
|
+
"application/json": {
|
|
2454
|
+
/** @description Current page number of the result set. */
|
|
2455
|
+
page: number;
|
|
2456
|
+
/** @description Number of items per page. */
|
|
2457
|
+
pageSize: number;
|
|
2458
|
+
/** @description Total number of matching feed events. */
|
|
2459
|
+
totalCount: number;
|
|
2460
|
+
/** @description Events for the requested page, newest first. */
|
|
2461
|
+
data: {
|
|
2462
|
+
/**
|
|
2463
|
+
* Format: uuid
|
|
2464
|
+
* @description Event ID.
|
|
2465
|
+
*/
|
|
2466
|
+
id: string;
|
|
2467
|
+
/**
|
|
2468
|
+
* Format: uuid
|
|
2469
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2470
|
+
*/
|
|
2471
|
+
userId: string;
|
|
2472
|
+
/** @description Event category. */
|
|
2473
|
+
category: string;
|
|
2474
|
+
/** @description Event action. */
|
|
2475
|
+
action: string;
|
|
2476
|
+
/**
|
|
2477
|
+
* Format: date-time
|
|
2478
|
+
* @description Event creation time; the feed is ordered newest first.
|
|
2479
|
+
*/
|
|
2480
|
+
createdAt: string;
|
|
2481
|
+
/**
|
|
2482
|
+
* @description Always `public` in the feed.
|
|
2483
|
+
* @default private
|
|
2484
|
+
* @enum {string}
|
|
2485
|
+
*/
|
|
2486
|
+
visibility: "private" | "public";
|
|
2487
|
+
/**
|
|
2488
|
+
* @description Platform from ScheduleCompletedEventMetadata.
|
|
2489
|
+
* @enum {string}
|
|
2490
|
+
*/
|
|
2491
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
2492
|
+
/** @description Role from ScheduleCompletedEventMetadata. */
|
|
2493
|
+
role: string;
|
|
2494
|
+
/** @description One-line result from ScheduleCompletedEventMetadata. */
|
|
2495
|
+
line: string;
|
|
2496
|
+
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
2497
|
+
networks?: string[];
|
|
2498
|
+
/** @description Public username, never a real name; present only for a public profile. */
|
|
2499
|
+
displayName?: string;
|
|
2500
|
+
/**
|
|
2501
|
+
* Format: uri
|
|
2502
|
+
* @description Public avatar URL; present only for a public profile.
|
|
2503
|
+
*/
|
|
2504
|
+
avatarUrl?: string;
|
|
2505
|
+
/** @description Public organization name; present only for a public profile. */
|
|
2506
|
+
organizationName?: string;
|
|
2507
|
+
/**
|
|
2508
|
+
* Format: uri
|
|
2509
|
+
* @description HTTPS URL of the user's public profile.
|
|
2510
|
+
*/
|
|
2511
|
+
publicProfileUrl?: string;
|
|
2512
|
+
}[];
|
|
2513
|
+
};
|
|
2514
|
+
};
|
|
2515
|
+
};
|
|
2516
|
+
/** @description Invalid request body or request param */
|
|
2517
|
+
400: {
|
|
2518
|
+
headers: {
|
|
2519
|
+
[name: string]: unknown;
|
|
2520
|
+
};
|
|
2521
|
+
content: {
|
|
2522
|
+
"text/plain": string;
|
|
2523
|
+
};
|
|
2524
|
+
};
|
|
2525
|
+
/** @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. */
|
|
2526
|
+
429: {
|
|
2527
|
+
headers: {
|
|
2528
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
2529
|
+
"Retry-After": number;
|
|
2530
|
+
[name: string]: unknown;
|
|
2531
|
+
};
|
|
2532
|
+
content: {
|
|
2533
|
+
"application/json": {
|
|
2534
|
+
/** @description The sentence the caller is shown. */
|
|
2535
|
+
error: string;
|
|
2536
|
+
/** @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. */
|
|
2537
|
+
code?: string;
|
|
2538
|
+
/**
|
|
2539
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
2540
|
+
* @enum {string}
|
|
2541
|
+
*/
|
|
2542
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
2543
|
+
/** @description MeshKit's probable causes of the error. */
|
|
2544
|
+
probableCause?: string[];
|
|
2545
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
2546
|
+
suggestedRemediation?: string[];
|
|
2547
|
+
};
|
|
2548
|
+
};
|
|
2549
|
+
};
|
|
2550
|
+
/** @description Internal server error */
|
|
2551
|
+
500: {
|
|
2552
|
+
headers: {
|
|
2553
|
+
[name: string]: unknown;
|
|
2554
|
+
};
|
|
2555
|
+
content: {
|
|
2556
|
+
"text/plain": string;
|
|
2557
|
+
};
|
|
2558
|
+
};
|
|
2559
|
+
};
|
|
2560
|
+
};
|
|
1639
2561
|
getEventSummaryByUser: {
|
|
1640
2562
|
parameters: {
|
|
1641
2563
|
query?: {
|