@meshery/schemas 1.3.96 → 1.3.97

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.
Files changed (30) hide show
  1. package/dist/cloudApi.d.mts +1566 -1800
  2. package/dist/cloudApi.d.ts +1566 -1800
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta2/organization/Organization.d.ts +1 -1
  6. package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
  7. package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
  8. package/dist/constructs/v1beta3/claim/Claim.d.ts +492 -80
  9. package/dist/constructs/v1beta3/claim/ClaimSchema.js +25 -84
  10. package/dist/constructs/v1beta3/claim/ClaimSchema.mjs +25 -84
  11. package/dist/constructs/v1beta3/connection/Connection.d.ts +171 -0
  12. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +2 -2
  13. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +2 -2
  14. package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +30 -0
  15. package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +12 -6
  16. package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +12 -6
  17. package/dist/constructs/v1beta3/design/Design.d.ts +2 -2
  18. package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
  19. package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
  20. package/dist/constructs/v1beta3/event/Event.d.ts +7 -7
  21. package/dist/constructs/v1beta3/event/EventSchema.js +5 -2
  22. package/dist/constructs/v1beta3/event/EventSchema.mjs +5 -2
  23. package/dist/constructs/v1beta3/schedule/Schedule.d.ts +1342 -1586
  24. package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +10 -34
  25. package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +10 -34
  26. package/dist/index.d.mts +1 -1
  27. package/dist/index.d.ts +1 -1
  28. package/dist/mesheryApi.d.mts +4 -2
  29. package/dist/mesheryApi.d.ts +4 -2
  30. package/package.json +1 -1
@@ -13,17 +13,24 @@ export interface paths {
13
13
  };
14
14
  /**
15
15
  * List claims
16
- * @description Returns a paginated list of claims in the organization of the authenticated session, optionally filtered by resource, claimant or status.
16
+ * @description Returns a paginated list of the claims in the organization of the authenticated session, active and historical, optionally filtered by resource, holding connection, user, status, outcome and the time the claim was taken. Ordered by `claimedAt`, newest first, unless `order` is `claimedAt asc`. Every member holding View Claims sees every claim in the organization.
17
17
  */
18
18
  get: operations["listClaims"];
19
19
  put?: never;
20
20
  /**
21
21
  * Claim a resource
22
- * @description Takes a claim on the named resource for `claimant`. Succeeds when the
23
- * resource has no live claim or its live claim already belongs to the
24
- * same claimant; a live claim held by another claimant answers 409. A
25
- * stale claim (past `expiresAt`) is superseded. Decided in a single
26
- * server-side statement, so of two racing claimants exactly one wins.
22
+ * @description Takes a claim on the named resource for the connection
23
+ * `connectionId`, which must be the caller's own live connection in the
24
+ * session organization. Succeeds with `201` when the resource has no
25
+ * active claim. When the same connection already holds the active claim
26
+ * the call is a replay and returns it unchanged with `200`. An active
27
+ * claim held by another connection answers `409`. A claim past
28
+ * `expiresAt`, or one whose holding connection was deleted, is marked
29
+ * `expired` and superseded. The resource must exist in the session
30
+ * organization; a server verifies the resource types it serves (for
31
+ * example `content_item` and `schedule`) and refuses any other type with
32
+ * `400`. Decided in a single server-side statement, so of two racing
33
+ * claimants exactly one wins.
27
34
  */
28
35
  post: operations["createClaim"];
29
36
  delete?: never;
@@ -60,7 +67,7 @@ export interface paths {
60
67
  put?: never;
61
68
  /**
62
69
  * Renew a claim
63
- * @description Moves `expiresAt` forward for the holder only. A claim that is not active, or that belongs to another claimant, answers 409 and is never taken back.
70
+ * @description Moves `expiresAt` forward and sets `renewedAt`, for the holding connection only: `connectionId` must be the caller's own live connection and the one that holds the claim. A claim that is not active (released, or past `expiresAt`), or that another connection holds, answers `409` and is never taken back.
64
71
  */
65
72
  post: operations["renewClaim"];
66
73
  delete?: never;
@@ -80,7 +87,7 @@ export interface paths {
80
87
  put?: never;
81
88
  /**
82
89
  * Release a claim
83
- * @description Ends the claim for the holder, setting `status` to `released` and `releasedAt`. Releasing a claim that is already released is a no-op; a release by another claimant answers 409.
90
+ * @description Ends an active claim and records what happened: sets `status` to `released`, `releasedAt`, `releasedBy` and the reported `outcome`, `outcomeError` and `outcomeEventId`. The holder may release its own claim from any of its connections (the claim's `claimantUserId` is the caller); a member holding Release claims of other members may release anyone's. Anyone else is answered `409`. Releasing a claim that is already released is a no-op that returns the stored claim unchanged, whatever outcome is sent. A claim that expired cannot be released (`409`): the resource may already have been handed off. `outcomeError` is accepted only with `outcome: failed`; `outcomeEventId` must name a live event the claim's holder owns, else `404`.
84
91
  */
85
92
  post: operations["releaseClaim"];
86
93
  delete?: never;
@@ -95,16 +102,19 @@ export interface components {
95
102
  schemas: {
96
103
  /**
97
104
  * Claim Schema
98
- * @description Server-returned claim: a time-bound hold that one claimant takes on one
105
+ * @description Server-returned claim: a time-bound hold that one connection takes on one
99
106
  * resource so that competing workers never act on it twice. A claim is
100
107
  * generic: it names the resource it holds by type and ID, and any construct
101
- * can be claimed (a schedule is the first). A claim is live while its
102
- * status is `active` and `expiresAt` is in the future; a live claim held by
103
- * another claimant refuses a new claim on the same resource. A claim whose
104
- * `expiresAt` has passed is stale and the resource may be claimed again,
105
- * so a claimant that disappears never strands the resource. Only the
106
- * holder renews or releases a claim. The race between claimants is decided
107
- * server-side in a single statement.
108
+ * can be claimed. A claim is held by a connection (`claimantConnectionId`,
109
+ * for example the connection a desktop client registered for its machine)
110
+ * on behalf of the user whose session took it (`claimantUserId`). At most
111
+ * one claim per resource is `active` in an organization. A claim whose
112
+ * `expiresAt` has passed reads as `expired` and the resource may be claimed
113
+ * again, so a holder that disappears never strands the resource. Released
114
+ * and expired claims are kept as history: a handoff is an `expired` claim
115
+ * followed by an `active` claim on the same resource. The holder reports
116
+ * what happened (`outcome`) when it releases the claim. The race between
117
+ * claimants is decided server-side in a single statement.
108
118
  */
109
119
  Claim: {
110
120
  /**
@@ -117,17 +127,25 @@ export interface components {
117
127
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
118
128
  */
119
129
  organizationId: string;
120
- /** @description Type of the claimed resource, for example `schedule`. */
130
+ /** @description Type of the claimed resource, the construct name in snake_case, for example `content_item` or `schedule`. */
121
131
  resourceType: string;
122
132
  /**
123
133
  * Format: uuid
124
134
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
125
135
  */
126
136
  resourceId: string;
127
- /** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
128
- claimant: string;
129
137
  /**
130
- * @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
138
+ * Format: uuid
139
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
140
+ */
141
+ claimantConnectionId?: string;
142
+ /**
143
+ * Format: uuid
144
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
145
+ */
146
+ claimantUserId?: string;
147
+ /**
148
+ * @description Lifecycle of the claim. `active` while held, `released` once the holder (or a member allowed to release it) lets it go, `expired` once `expiresAt` passed without a renewal or the holding connection was deleted. Expiry is evaluated when the claim is read, so a claim never reads `active` past its `expiresAt`.
131
149
  * @enum {string}
132
150
  */
133
151
  status: "active" | "released" | "expired";
@@ -143,9 +161,31 @@ export interface components {
143
161
  expiresAt: string;
144
162
  /**
145
163
  * Format: date-time
146
- * @description Time the holder released the claim. Null while the claim is active or after it expired.
164
+ * @description Time of the last renewal. Null until the claim is first renewed.
165
+ */
166
+ renewedAt?: string | null;
167
+ /**
168
+ * Format: date-time
169
+ * @description Time the claim was released. Null while the claim is active or after it expired.
147
170
  */
148
171
  releasedAt?: string | null;
172
+ /**
173
+ * @description What the releaser reported when the claim was released: `completed` when the work behind it finished, `failed` when it was attempted and did not succeed, `cancelled` when it was let go without the work being done (including a release by another member). Omitted while the claim is active and on an expired claim.
174
+ * @enum {string}
175
+ */
176
+ outcome?: "completed" | "failed" | "cancelled";
177
+ /** @description Error reported with a `failed` outcome. Omitted otherwise. */
178
+ outcomeError?: string;
179
+ /**
180
+ * Format: uuid
181
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
182
+ */
183
+ outcomeEventId?: string;
184
+ /**
185
+ * Format: uuid
186
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
187
+ */
188
+ releasedBy?: string;
149
189
  /**
150
190
  * Format: date-time
151
191
  * @description Timestamp of claim creation.
@@ -159,33 +199,49 @@ export interface components {
159
199
  };
160
200
  /**
161
201
  * @description Payload for taking a claim. Contains only client-settable fields;
162
- * the owning `organizationId`, `status`, `claimedAt`, `expiresAt` and
163
- * the timestamps are server-managed.
202
+ * the owning `organizationId`, `claimantUserId`, `status`,
203
+ * `claimedAt`, `expiresAt` and the timestamps are server-managed.
164
204
  */
165
205
  ClaimPayload: {
166
- /** @description Type of the resource to claim, for example `schedule`. */
206
+ /** @description Type of the resource to claim, for example `content_item`. */
167
207
  resourceType: string;
168
208
  /**
169
209
  * Format: uuid
170
210
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
171
211
  */
172
212
  resourceId: string;
173
- /** @description Identity of the worker taking the claim. */
174
- claimant: string;
175
- /** @description Requested claim duration in minutes; the server applies its default when omitted and may cap it. */
213
+ /**
214
+ * Format: uuid
215
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
216
+ */
217
+ connectionId: string;
218
+ /** @description Requested claim duration in minutes; the server applies its default (30) when omitted and may cap it. */
176
219
  durationMinutes?: number;
177
220
  };
178
- /** @description Payload for renewing a claim. Only the holder named by `claimant` may renew. */
221
+ /** @description Payload for renewing a claim. Only the holding connection may renew. */
179
222
  ClaimRenewPayload: {
180
- /** @description Identity of the holder renewing the claim. */
181
- claimant: string;
182
- /** @description Requested extension in minutes from now; the server applies its default when omitted and may cap it. */
223
+ /**
224
+ * Format: uuid
225
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
226
+ */
227
+ connectionId: string;
228
+ /** @description Requested extension in minutes from now; the server applies its default (30) when omitted and may cap it. */
183
229
  durationMinutes?: number;
184
230
  };
185
- /** @description Payload for releasing a claim. Only the holder named by `claimant` may release. */
231
+ /** @description Payload for releasing a claim with the outcome of the work it held. The releaser is the session user; no connection is needed, so a holder can release a stuck hold from another of its computers, and an authorized member can release someone else's. */
186
232
  ClaimReleasePayload: {
187
- /** @description Identity of the holder releasing the claim. */
188
- claimant: string;
233
+ /**
234
+ * @description What happened to the work the claim held.
235
+ * @enum {string}
236
+ */
237
+ outcome: "completed" | "failed" | "cancelled";
238
+ /** @description Error behind a `failed` outcome. Refused with any other outcome. */
239
+ outcomeError?: string;
240
+ /**
241
+ * Format: uuid
242
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
243
+ */
244
+ outcomeEventId?: string;
189
245
  };
190
246
  /** @description Paginated collection of claims. */
191
247
  ClaimPage: {
@@ -207,17 +263,25 @@ export interface components {
207
263
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
208
264
  */
209
265
  organizationId: string;
210
- /** @description Type of the claimed resource, for example `schedule`. */
266
+ /** @description Type of the claimed resource, the construct name in snake_case, for example `content_item` or `schedule`. */
211
267
  resourceType: string;
212
268
  /**
213
269
  * Format: uuid
214
270
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
215
271
  */
216
272
  resourceId: string;
217
- /** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
218
- claimant: string;
219
273
  /**
220
- * @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
274
+ * Format: uuid
275
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
276
+ */
277
+ claimantConnectionId?: string;
278
+ /**
279
+ * Format: uuid
280
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
281
+ */
282
+ claimantUserId?: string;
283
+ /**
284
+ * @description Lifecycle of the claim. `active` while held, `released` once the holder (or a member allowed to release it) lets it go, `expired` once `expiresAt` passed without a renewal or the holding connection was deleted. Expiry is evaluated when the claim is read, so a claim never reads `active` past its `expiresAt`.
221
285
  * @enum {string}
222
286
  */
223
287
  status: "active" | "released" | "expired";
@@ -233,9 +297,31 @@ export interface components {
233
297
  expiresAt: string;
234
298
  /**
235
299
  * Format: date-time
236
- * @description Time the holder released the claim. Null while the claim is active or after it expired.
300
+ * @description Time of the last renewal. Null until the claim is first renewed.
301
+ */
302
+ renewedAt?: string | null;
303
+ /**
304
+ * Format: date-time
305
+ * @description Time the claim was released. Null while the claim is active or after it expired.
237
306
  */
238
307
  releasedAt?: string | null;
308
+ /**
309
+ * @description What the releaser reported when the claim was released: `completed` when the work behind it finished, `failed` when it was attempted and did not succeed, `cancelled` when it was let go without the work being done (including a release by another member). Omitted while the claim is active and on an expired claim.
310
+ * @enum {string}
311
+ */
312
+ outcome?: "completed" | "failed" | "cancelled";
313
+ /** @description Error reported with a `failed` outcome. Omitted otherwise. */
314
+ outcomeError?: string;
315
+ /**
316
+ * Format: uuid
317
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
318
+ */
319
+ outcomeEventId?: string;
320
+ /**
321
+ * Format: uuid
322
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
323
+ */
324
+ releasedBy?: string;
239
325
  /**
240
326
  * Format: date-time
241
327
  * @description Timestamp of claim creation.
@@ -268,6 +354,15 @@ export interface components {
268
354
  "text/plain": string;
269
355
  };
270
356
  };
357
+ /** @description Forbidden */
358
+ 403: {
359
+ headers: {
360
+ [name: string]: unknown;
361
+ };
362
+ content: {
363
+ "text/plain": string;
364
+ };
365
+ };
271
366
  /** @description Result not found */
272
367
  404: {
273
368
  headers: {
@@ -277,7 +372,7 @@ export interface components {
277
372
  "text/plain": string;
278
373
  };
279
374
  };
280
- /** @description Conflict - the resource is held by another claimant's live claim, or the caller is not the holder of the claim it tried to renew or release */
375
+ /** @description Conflict - another connection holds the resource's active claim, the claim is not active, or the caller may not renew or release it */
281
376
  409: {
282
377
  headers: {
283
378
  [name: string]: unknown;
@@ -325,10 +420,18 @@ export interface operations {
325
420
  resourceType?: string;
326
421
  /** @description Filter by claimed resource ID. */
327
422
  resourceId?: string;
328
- /** @description Filter by holder identity. */
329
- claimant?: string;
330
- /** @description Filter by claim status. */
423
+ /** @description Filter by the connection that holds or held the claim. */
424
+ claimantConnectionId?: string;
425
+ /** @description Filter by the user whose session took the claim. */
426
+ claimantUserId?: string;
427
+ /** @description Filter by claim status, as read (a claim past `expiresAt` is `expired`). */
331
428
  status?: "active" | "released" | "expired";
429
+ /** @description Filter by the outcome reported on release. */
430
+ outcome?: "completed" | "failed" | "cancelled";
431
+ /** @description Only claims taken at or after this time. */
432
+ claimedSince?: string;
433
+ /** @description Only claims taken before this time. */
434
+ claimedUntil?: string;
332
435
  };
333
436
  header?: never;
334
437
  path?: never;
@@ -361,17 +464,25 @@ export interface operations {
361
464
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
362
465
  */
363
466
  organizationId: string;
364
- /** @description Type of the claimed resource, for example `schedule`. */
467
+ /** @description Type of the claimed resource, the construct name in snake_case, for example `content_item` or `schedule`. */
365
468
  resourceType: string;
366
469
  /**
367
470
  * Format: uuid
368
471
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
369
472
  */
370
473
  resourceId: string;
371
- /** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
372
- claimant: string;
373
474
  /**
374
- * @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
475
+ * Format: uuid
476
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
477
+ */
478
+ claimantConnectionId?: string;
479
+ /**
480
+ * Format: uuid
481
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
482
+ */
483
+ claimantUserId?: string;
484
+ /**
485
+ * @description Lifecycle of the claim. `active` while held, `released` once the holder (or a member allowed to release it) lets it go, `expired` once `expiresAt` passed without a renewal or the holding connection was deleted. Expiry is evaluated when the claim is read, so a claim never reads `active` past its `expiresAt`.
375
486
  * @enum {string}
376
487
  */
377
488
  status: "active" | "released" | "expired";
@@ -387,9 +498,31 @@ export interface operations {
387
498
  expiresAt: string;
388
499
  /**
389
500
  * Format: date-time
390
- * @description Time the holder released the claim. Null while the claim is active or after it expired.
501
+ * @description Time of the last renewal. Null until the claim is first renewed.
502
+ */
503
+ renewedAt?: string | null;
504
+ /**
505
+ * Format: date-time
506
+ * @description Time the claim was released. Null while the claim is active or after it expired.
391
507
  */
392
508
  releasedAt?: string | null;
509
+ /**
510
+ * @description What the releaser reported when the claim was released: `completed` when the work behind it finished, `failed` when it was attempted and did not succeed, `cancelled` when it was let go without the work being done (including a release by another member). Omitted while the claim is active and on an expired claim.
511
+ * @enum {string}
512
+ */
513
+ outcome?: "completed" | "failed" | "cancelled";
514
+ /** @description Error reported with a `failed` outcome. Omitted otherwise. */
515
+ outcomeError?: string;
516
+ /**
517
+ * Format: uuid
518
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
519
+ */
520
+ outcomeEventId?: string;
521
+ /**
522
+ * Format: uuid
523
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
524
+ */
525
+ releasedBy?: string;
393
526
  /**
394
527
  * Format: date-time
395
528
  * @description Timestamp of claim creation.
@@ -404,6 +537,15 @@ export interface operations {
404
537
  };
405
538
  };
406
539
  };
540
+ /** @description Invalid request body or request param */
541
+ 400: {
542
+ headers: {
543
+ [name: string]: unknown;
544
+ };
545
+ content: {
546
+ "text/plain": string;
547
+ };
548
+ };
407
549
  /** @description Expired JWT token used or insufficient privilege */
408
550
  401: {
409
551
  headers: {
@@ -413,6 +555,15 @@ export interface operations {
413
555
  "text/plain": string;
414
556
  };
415
557
  };
558
+ /** @description Forbidden */
559
+ 403: {
560
+ headers: {
561
+ [name: string]: unknown;
562
+ };
563
+ content: {
564
+ "text/plain": string;
565
+ };
566
+ };
416
567
  /** @description Result not found */
417
568
  404: {
418
569
  headers: {
@@ -443,21 +594,113 @@ export interface operations {
443
594
  requestBody: {
444
595
  content: {
445
596
  "application/json": {
446
- /** @description Type of the resource to claim, for example `schedule`. */
597
+ /** @description Type of the resource to claim, for example `content_item`. */
447
598
  resourceType: string;
448
599
  /**
449
600
  * Format: uuid
450
601
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
451
602
  */
452
603
  resourceId: string;
453
- /** @description Identity of the worker taking the claim. */
454
- claimant: string;
455
- /** @description Requested claim duration in minutes; the server applies its default when omitted and may cap it. */
604
+ /**
605
+ * Format: uuid
606
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
607
+ */
608
+ connectionId: string;
609
+ /** @description Requested claim duration in minutes; the server applies its default (30) when omitted and may cap it. */
456
610
  durationMinutes?: number;
457
611
  };
458
612
  };
459
613
  };
460
614
  responses: {
615
+ /** @description Replay - the same connection already holds the active claim */
616
+ 200: {
617
+ headers: {
618
+ [name: string]: unknown;
619
+ };
620
+ content: {
621
+ "application/json": {
622
+ /**
623
+ * Format: uuid
624
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
625
+ */
626
+ id: string;
627
+ /**
628
+ * Format: uuid
629
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
630
+ */
631
+ organizationId: string;
632
+ /** @description Type of the claimed resource, the construct name in snake_case, for example `content_item` or `schedule`. */
633
+ resourceType: string;
634
+ /**
635
+ * Format: uuid
636
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
637
+ */
638
+ resourceId: string;
639
+ /**
640
+ * Format: uuid
641
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
642
+ */
643
+ claimantConnectionId?: string;
644
+ /**
645
+ * Format: uuid
646
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
647
+ */
648
+ claimantUserId?: string;
649
+ /**
650
+ * @description Lifecycle of the claim. `active` while held, `released` once the holder (or a member allowed to release it) lets it go, `expired` once `expiresAt` passed without a renewal or the holding connection was deleted. Expiry is evaluated when the claim is read, so a claim never reads `active` past its `expiresAt`.
651
+ * @enum {string}
652
+ */
653
+ status: "active" | "released" | "expired";
654
+ /**
655
+ * Format: date-time
656
+ * @description Time the claim was taken.
657
+ */
658
+ claimedAt: string;
659
+ /**
660
+ * Format: date-time
661
+ * @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
662
+ */
663
+ expiresAt: string;
664
+ /**
665
+ * Format: date-time
666
+ * @description Time of the last renewal. Null until the claim is first renewed.
667
+ */
668
+ renewedAt?: string | null;
669
+ /**
670
+ * Format: date-time
671
+ * @description Time the claim was released. Null while the claim is active or after it expired.
672
+ */
673
+ releasedAt?: string | null;
674
+ /**
675
+ * @description What the releaser reported when the claim was released: `completed` when the work behind it finished, `failed` when it was attempted and did not succeed, `cancelled` when it was let go without the work being done (including a release by another member). Omitted while the claim is active and on an expired claim.
676
+ * @enum {string}
677
+ */
678
+ outcome?: "completed" | "failed" | "cancelled";
679
+ /** @description Error reported with a `failed` outcome. Omitted otherwise. */
680
+ outcomeError?: string;
681
+ /**
682
+ * Format: uuid
683
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
684
+ */
685
+ outcomeEventId?: string;
686
+ /**
687
+ * Format: uuid
688
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
689
+ */
690
+ releasedBy?: string;
691
+ /**
692
+ * Format: date-time
693
+ * @description Timestamp of claim creation.
694
+ */
695
+ createdAt: string;
696
+ /**
697
+ * Format: date-time
698
+ * @description Timestamp of last claim modification.
699
+ */
700
+ updatedAt: string;
701
+ };
702
+ };
703
+ };
461
704
  /** @description Claim taken */
462
705
  201: {
463
706
  headers: {
@@ -475,17 +718,25 @@ export interface operations {
475
718
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
476
719
  */
477
720
  organizationId: string;
478
- /** @description Type of the claimed resource, for example `schedule`. */
721
+ /** @description Type of the claimed resource, the construct name in snake_case, for example `content_item` or `schedule`. */
479
722
  resourceType: string;
480
723
  /**
481
724
  * Format: uuid
482
725
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
483
726
  */
484
727
  resourceId: string;
485
- /** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
486
- claimant: string;
487
728
  /**
488
- * @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
729
+ * Format: uuid
730
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
731
+ */
732
+ claimantConnectionId?: string;
733
+ /**
734
+ * Format: uuid
735
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
736
+ */
737
+ claimantUserId?: string;
738
+ /**
739
+ * @description Lifecycle of the claim. `active` while held, `released` once the holder (or a member allowed to release it) lets it go, `expired` once `expiresAt` passed without a renewal or the holding connection was deleted. Expiry is evaluated when the claim is read, so a claim never reads `active` past its `expiresAt`.
489
740
  * @enum {string}
490
741
  */
491
742
  status: "active" | "released" | "expired";
@@ -501,9 +752,31 @@ export interface operations {
501
752
  expiresAt: string;
502
753
  /**
503
754
  * Format: date-time
504
- * @description Time the holder released the claim. Null while the claim is active or after it expired.
755
+ * @description Time of the last renewal. Null until the claim is first renewed.
756
+ */
757
+ renewedAt?: string | null;
758
+ /**
759
+ * Format: date-time
760
+ * @description Time the claim was released. Null while the claim is active or after it expired.
505
761
  */
506
762
  releasedAt?: string | null;
763
+ /**
764
+ * @description What the releaser reported when the claim was released: `completed` when the work behind it finished, `failed` when it was attempted and did not succeed, `cancelled` when it was let go without the work being done (including a release by another member). Omitted while the claim is active and on an expired claim.
765
+ * @enum {string}
766
+ */
767
+ outcome?: "completed" | "failed" | "cancelled";
768
+ /** @description Error reported with a `failed` outcome. Omitted otherwise. */
769
+ outcomeError?: string;
770
+ /**
771
+ * Format: uuid
772
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
773
+ */
774
+ outcomeEventId?: string;
775
+ /**
776
+ * Format: uuid
777
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
778
+ */
779
+ releasedBy?: string;
507
780
  /**
508
781
  * Format: date-time
509
782
  * @description Timestamp of claim creation.
@@ -535,6 +808,15 @@ export interface operations {
535
808
  "text/plain": string;
536
809
  };
537
810
  };
811
+ /** @description Forbidden */
812
+ 403: {
813
+ headers: {
814
+ [name: string]: unknown;
815
+ };
816
+ content: {
817
+ "text/plain": string;
818
+ };
819
+ };
538
820
  /** @description Result not found */
539
821
  404: {
540
822
  headers: {
@@ -544,7 +826,7 @@ export interface operations {
544
826
  "text/plain": string;
545
827
  };
546
828
  };
547
- /** @description Conflict - the resource is held by another claimant's live claim, or the caller is not the holder of the claim it tried to renew or release */
829
+ /** @description Conflict - another connection holds the resource's active claim, the claim is not active, or the caller may not renew or release it */
548
830
  409: {
549
831
  headers: {
550
832
  [name: string]: unknown;
@@ -593,17 +875,25 @@ export interface operations {
593
875
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
594
876
  */
595
877
  organizationId: string;
596
- /** @description Type of the claimed resource, for example `schedule`. */
878
+ /** @description Type of the claimed resource, the construct name in snake_case, for example `content_item` or `schedule`. */
597
879
  resourceType: string;
598
880
  /**
599
881
  * Format: uuid
600
882
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
601
883
  */
602
884
  resourceId: string;
603
- /** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
604
- claimant: string;
605
885
  /**
606
- * @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
886
+ * Format: uuid
887
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
888
+ */
889
+ claimantConnectionId?: string;
890
+ /**
891
+ * Format: uuid
892
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
893
+ */
894
+ claimantUserId?: string;
895
+ /**
896
+ * @description Lifecycle of the claim. `active` while held, `released` once the holder (or a member allowed to release it) lets it go, `expired` once `expiresAt` passed without a renewal or the holding connection was deleted. Expiry is evaluated when the claim is read, so a claim never reads `active` past its `expiresAt`.
607
897
  * @enum {string}
608
898
  */
609
899
  status: "active" | "released" | "expired";
@@ -619,9 +909,31 @@ export interface operations {
619
909
  expiresAt: string;
620
910
  /**
621
911
  * Format: date-time
622
- * @description Time the holder released the claim. Null while the claim is active or after it expired.
912
+ * @description Time of the last renewal. Null until the claim is first renewed.
913
+ */
914
+ renewedAt?: string | null;
915
+ /**
916
+ * Format: date-time
917
+ * @description Time the claim was released. Null while the claim is active or after it expired.
623
918
  */
624
919
  releasedAt?: string | null;
920
+ /**
921
+ * @description What the releaser reported when the claim was released: `completed` when the work behind it finished, `failed` when it was attempted and did not succeed, `cancelled` when it was let go without the work being done (including a release by another member). Omitted while the claim is active and on an expired claim.
922
+ * @enum {string}
923
+ */
924
+ outcome?: "completed" | "failed" | "cancelled";
925
+ /** @description Error reported with a `failed` outcome. Omitted otherwise. */
926
+ outcomeError?: string;
927
+ /**
928
+ * Format: uuid
929
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
930
+ */
931
+ outcomeEventId?: string;
932
+ /**
933
+ * Format: uuid
934
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
935
+ */
936
+ releasedBy?: string;
625
937
  /**
626
938
  * Format: date-time
627
939
  * @description Timestamp of claim creation.
@@ -644,6 +956,15 @@ export interface operations {
644
956
  "text/plain": string;
645
957
  };
646
958
  };
959
+ /** @description Forbidden */
960
+ 403: {
961
+ headers: {
962
+ [name: string]: unknown;
963
+ };
964
+ content: {
965
+ "text/plain": string;
966
+ };
967
+ };
647
968
  /** @description Result not found */
648
969
  404: {
649
970
  headers: {
@@ -677,9 +998,12 @@ export interface operations {
677
998
  requestBody: {
678
999
  content: {
679
1000
  "application/json": {
680
- /** @description Identity of the holder renewing the claim. */
681
- claimant: string;
682
- /** @description Requested extension in minutes from now; the server applies its default when omitted and may cap it. */
1001
+ /**
1002
+ * Format: uuid
1003
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1004
+ */
1005
+ connectionId: string;
1006
+ /** @description Requested extension in minutes from now; the server applies its default (30) when omitted and may cap it. */
683
1007
  durationMinutes?: number;
684
1008
  };
685
1009
  };
@@ -702,17 +1026,25 @@ export interface operations {
702
1026
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
703
1027
  */
704
1028
  organizationId: string;
705
- /** @description Type of the claimed resource, for example `schedule`. */
1029
+ /** @description Type of the claimed resource, the construct name in snake_case, for example `content_item` or `schedule`. */
706
1030
  resourceType: string;
707
1031
  /**
708
1032
  * Format: uuid
709
1033
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
710
1034
  */
711
1035
  resourceId: string;
712
- /** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
713
- claimant: string;
714
1036
  /**
715
- * @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
1037
+ * Format: uuid
1038
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1039
+ */
1040
+ claimantConnectionId?: string;
1041
+ /**
1042
+ * Format: uuid
1043
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1044
+ */
1045
+ claimantUserId?: string;
1046
+ /**
1047
+ * @description Lifecycle of the claim. `active` while held, `released` once the holder (or a member allowed to release it) lets it go, `expired` once `expiresAt` passed without a renewal or the holding connection was deleted. Expiry is evaluated when the claim is read, so a claim never reads `active` past its `expiresAt`.
716
1048
  * @enum {string}
717
1049
  */
718
1050
  status: "active" | "released" | "expired";
@@ -728,9 +1060,31 @@ export interface operations {
728
1060
  expiresAt: string;
729
1061
  /**
730
1062
  * Format: date-time
731
- * @description Time the holder released the claim. Null while the claim is active or after it expired.
1063
+ * @description Time of the last renewal. Null until the claim is first renewed.
1064
+ */
1065
+ renewedAt?: string | null;
1066
+ /**
1067
+ * Format: date-time
1068
+ * @description Time the claim was released. Null while the claim is active or after it expired.
732
1069
  */
733
1070
  releasedAt?: string | null;
1071
+ /**
1072
+ * @description What the releaser reported when the claim was released: `completed` when the work behind it finished, `failed` when it was attempted and did not succeed, `cancelled` when it was let go without the work being done (including a release by another member). Omitted while the claim is active and on an expired claim.
1073
+ * @enum {string}
1074
+ */
1075
+ outcome?: "completed" | "failed" | "cancelled";
1076
+ /** @description Error reported with a `failed` outcome. Omitted otherwise. */
1077
+ outcomeError?: string;
1078
+ /**
1079
+ * Format: uuid
1080
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1081
+ */
1082
+ outcomeEventId?: string;
1083
+ /**
1084
+ * Format: uuid
1085
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1086
+ */
1087
+ releasedBy?: string;
734
1088
  /**
735
1089
  * Format: date-time
736
1090
  * @description Timestamp of claim creation.
@@ -762,6 +1116,15 @@ export interface operations {
762
1116
  "text/plain": string;
763
1117
  };
764
1118
  };
1119
+ /** @description Forbidden */
1120
+ 403: {
1121
+ headers: {
1122
+ [name: string]: unknown;
1123
+ };
1124
+ content: {
1125
+ "text/plain": string;
1126
+ };
1127
+ };
765
1128
  /** @description Result not found */
766
1129
  404: {
767
1130
  headers: {
@@ -771,7 +1134,7 @@ export interface operations {
771
1134
  "text/plain": string;
772
1135
  };
773
1136
  };
774
- /** @description Conflict - the resource is held by another claimant's live claim, or the caller is not the holder of the claim it tried to renew or release */
1137
+ /** @description Conflict - another connection holds the resource's active claim, the claim is not active, or the caller may not renew or release it */
775
1138
  409: {
776
1139
  headers: {
777
1140
  [name: string]: unknown;
@@ -804,8 +1167,18 @@ export interface operations {
804
1167
  requestBody: {
805
1168
  content: {
806
1169
  "application/json": {
807
- /** @description Identity of the holder releasing the claim. */
808
- claimant: string;
1170
+ /**
1171
+ * @description What happened to the work the claim held.
1172
+ * @enum {string}
1173
+ */
1174
+ outcome: "completed" | "failed" | "cancelled";
1175
+ /** @description Error behind a `failed` outcome. Refused with any other outcome. */
1176
+ outcomeError?: string;
1177
+ /**
1178
+ * Format: uuid
1179
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1180
+ */
1181
+ outcomeEventId?: string;
809
1182
  };
810
1183
  };
811
1184
  };
@@ -827,17 +1200,25 @@ export interface operations {
827
1200
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
828
1201
  */
829
1202
  organizationId: string;
830
- /** @description Type of the claimed resource, for example `schedule`. */
1203
+ /** @description Type of the claimed resource, the construct name in snake_case, for example `content_item` or `schedule`. */
831
1204
  resourceType: string;
832
1205
  /**
833
1206
  * Format: uuid
834
1207
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
835
1208
  */
836
1209
  resourceId: string;
837
- /** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
838
- claimant: string;
839
1210
  /**
840
- * @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
1211
+ * Format: uuid
1212
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1213
+ */
1214
+ claimantConnectionId?: string;
1215
+ /**
1216
+ * Format: uuid
1217
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1218
+ */
1219
+ claimantUserId?: string;
1220
+ /**
1221
+ * @description Lifecycle of the claim. `active` while held, `released` once the holder (or a member allowed to release it) lets it go, `expired` once `expiresAt` passed without a renewal or the holding connection was deleted. Expiry is evaluated when the claim is read, so a claim never reads `active` past its `expiresAt`.
841
1222
  * @enum {string}
842
1223
  */
843
1224
  status: "active" | "released" | "expired";
@@ -853,9 +1234,31 @@ export interface operations {
853
1234
  expiresAt: string;
854
1235
  /**
855
1236
  * Format: date-time
856
- * @description Time the holder released the claim. Null while the claim is active or after it expired.
1237
+ * @description Time of the last renewal. Null until the claim is first renewed.
1238
+ */
1239
+ renewedAt?: string | null;
1240
+ /**
1241
+ * Format: date-time
1242
+ * @description Time the claim was released. Null while the claim is active or after it expired.
857
1243
  */
858
1244
  releasedAt?: string | null;
1245
+ /**
1246
+ * @description What the releaser reported when the claim was released: `completed` when the work behind it finished, `failed` when it was attempted and did not succeed, `cancelled` when it was let go without the work being done (including a release by another member). Omitted while the claim is active and on an expired claim.
1247
+ * @enum {string}
1248
+ */
1249
+ outcome?: "completed" | "failed" | "cancelled";
1250
+ /** @description Error reported with a `failed` outcome. Omitted otherwise. */
1251
+ outcomeError?: string;
1252
+ /**
1253
+ * Format: uuid
1254
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1255
+ */
1256
+ outcomeEventId?: string;
1257
+ /**
1258
+ * Format: uuid
1259
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1260
+ */
1261
+ releasedBy?: string;
859
1262
  /**
860
1263
  * Format: date-time
861
1264
  * @description Timestamp of claim creation.
@@ -887,6 +1290,15 @@ export interface operations {
887
1290
  "text/plain": string;
888
1291
  };
889
1292
  };
1293
+ /** @description Forbidden */
1294
+ 403: {
1295
+ headers: {
1296
+ [name: string]: unknown;
1297
+ };
1298
+ content: {
1299
+ "text/plain": string;
1300
+ };
1301
+ };
890
1302
  /** @description Result not found */
891
1303
  404: {
892
1304
  headers: {
@@ -896,7 +1308,7 @@ export interface operations {
896
1308
  "text/plain": string;
897
1309
  };
898
1310
  };
899
- /** @description Conflict - the resource is held by another claimant's live claim, or the caller is not the holder of the claim it tried to renew or release */
1311
+ /** @description Conflict - another connection holds the resource's active claim, the claim is not active, or the caller may not renew or release it */
900
1312
  409: {
901
1313
  headers: {
902
1314
  [name: string]: unknown;