@meshery/schemas 1.3.77 → 1.3.79
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 +244 -1286
- package/dist/cloudApi.d.ts +244 -1286
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +3 -3
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.js +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.mjs +1 -1
- package/dist/constructs/v1beta1/registry/Registry.d.ts +9 -9
- package/dist/constructs/v1beta1/registry/RegistrySchema.js +3 -3
- package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +3 -3
- package/dist/constructs/v1beta2/organization/Organization.d.ts +334 -2
- package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
- package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +21 -21
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/environment/Environment.d.ts +62 -19
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/event/Event.d.ts +130 -2
- package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +334 -1038
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +12 -36
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +12 -36
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +3 -3
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +1 -1
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +1 -1
- package/dist/index.d.mts +224 -0
- package/dist/index.d.ts +224 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/mesheryApi.d.mts +224 -49
- package/dist/mesheryApi.d.ts +224 -49
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
@@ -22,8 +22,10 @@ export interface paths {
|
|
|
22
22
|
/**
|
|
23
23
|
* Create a schedule
|
|
24
24
|
* @description Creates a schedule in the organization of the authenticated session. The
|
|
25
|
-
*
|
|
26
|
-
* and the
|
|
25
|
+
* server-managed fields (the claim, `pausedAt`, `pausedBy`, `retryCount`,
|
|
26
|
+
* `lastRunAt`, `lastError`, `organizationId` and the timestamps) are ignored
|
|
27
|
+
* on input. `status` accepts only `pending`, `scheduled` and `cancelled`.
|
|
28
|
+
* Send `paused: true` to create the schedule already paused.
|
|
27
29
|
*/
|
|
28
30
|
post: operations["createSchedule"];
|
|
29
31
|
delete?: never;
|
|
@@ -56,38 +58,6 @@ export interface paths {
|
|
|
56
58
|
patch?: never;
|
|
57
59
|
trace?: never;
|
|
58
60
|
};
|
|
59
|
-
"/api/schedules/pause": {
|
|
60
|
-
parameters: {
|
|
61
|
-
query?: never;
|
|
62
|
-
header?: never;
|
|
63
|
-
path?: never;
|
|
64
|
-
cookie?: never;
|
|
65
|
-
};
|
|
66
|
-
/**
|
|
67
|
-
* Get the organization-wide schedule pause
|
|
68
|
-
* @description Returns the organization-wide pause, or 204 when every schedule in the
|
|
69
|
-
* organization may be claimed.
|
|
70
|
-
*/
|
|
71
|
-
get: operations["getSchedulePause"];
|
|
72
|
-
/**
|
|
73
|
-
* Pause every schedule in the organization
|
|
74
|
-
* @description Sets the organization-wide pause. While it exists no schedule in the
|
|
75
|
-
* organization is claimed unless the claim request carries `ignorePause`.
|
|
76
|
-
* Setting it again updates the reason and keeps the original time.
|
|
77
|
-
*/
|
|
78
|
-
put: operations["setSchedulePause"];
|
|
79
|
-
post?: never;
|
|
80
|
-
/**
|
|
81
|
-
* Lift the organization-wide schedule pause
|
|
82
|
-
* @description Lifts the organization-wide pause. Lifting a pause that does not exist
|
|
83
|
-
* is a no-op.
|
|
84
|
-
*/
|
|
85
|
-
delete: operations["clearSchedulePause"];
|
|
86
|
-
options?: never;
|
|
87
|
-
head?: never;
|
|
88
|
-
patch?: never;
|
|
89
|
-
trace?: never;
|
|
90
|
-
};
|
|
91
61
|
"/api/schedules/{scheduleId}": {
|
|
92
62
|
parameters: {
|
|
93
63
|
query?: never;
|
|
@@ -102,8 +72,14 @@ export interface paths {
|
|
|
102
72
|
get: operations["getScheduleById"];
|
|
103
73
|
/**
|
|
104
74
|
* Update a schedule
|
|
105
|
-
* @description Updates the client-settable fields of a schedule. The
|
|
106
|
-
*
|
|
75
|
+
* @description Updates the client-settable fields of a schedule. The server-managed
|
|
76
|
+
* fields (the claim, `pausedAt`, `pausedBy`, `retryCount`, `lastRunAt`,
|
|
77
|
+
* `lastError`, `organizationId` and the timestamps) are ignored on input.
|
|
78
|
+
* `status` accepts only `pending`, `scheduled` and `cancelled`. Pause or resume the
|
|
79
|
+
* schedule by setting `paused` (with an optional `pauseReason`); the
|
|
80
|
+
* server then records `pausedAt` and `pausedBy`. Pausing a paused
|
|
81
|
+
* schedule keeps its original `pausedAt`; omitting `paused` leaves the
|
|
82
|
+
* pause unchanged.
|
|
107
83
|
*/
|
|
108
84
|
put: operations["updateSchedule"];
|
|
109
85
|
post?: never;
|
|
@@ -184,47 +160,6 @@ export interface paths {
|
|
|
184
160
|
patch?: never;
|
|
185
161
|
trace?: never;
|
|
186
162
|
};
|
|
187
|
-
"/api/schedules/{scheduleId}/pause": {
|
|
188
|
-
parameters: {
|
|
189
|
-
query?: never;
|
|
190
|
-
header?: never;
|
|
191
|
-
path?: never;
|
|
192
|
-
cookie?: never;
|
|
193
|
-
};
|
|
194
|
-
get?: never;
|
|
195
|
-
put?: never;
|
|
196
|
-
/**
|
|
197
|
-
* Pause a schedule
|
|
198
|
-
* @description Pauses this schedule so it is never claimed until resumed. Pausing a
|
|
199
|
-
* paused schedule keeps its original pause time.
|
|
200
|
-
*/
|
|
201
|
-
post: operations["pauseSchedule"];
|
|
202
|
-
delete?: never;
|
|
203
|
-
options?: never;
|
|
204
|
-
head?: never;
|
|
205
|
-
patch?: never;
|
|
206
|
-
trace?: never;
|
|
207
|
-
};
|
|
208
|
-
"/api/schedules/{scheduleId}/resume": {
|
|
209
|
-
parameters: {
|
|
210
|
-
query?: never;
|
|
211
|
-
header?: never;
|
|
212
|
-
path?: never;
|
|
213
|
-
cookie?: never;
|
|
214
|
-
};
|
|
215
|
-
get?: never;
|
|
216
|
-
put?: never;
|
|
217
|
-
/**
|
|
218
|
-
* Resume a schedule
|
|
219
|
-
* @description Clears this schedule's pause. Resuming a schedule that is not paused is a no-op.
|
|
220
|
-
*/
|
|
221
|
-
post: operations["resumeSchedule"];
|
|
222
|
-
delete?: never;
|
|
223
|
-
options?: never;
|
|
224
|
-
head?: never;
|
|
225
|
-
patch?: never;
|
|
226
|
-
trace?: never;
|
|
227
|
-
};
|
|
228
163
|
"/api/workspaces/{workspaceId}/schedules": {
|
|
229
164
|
parameters: {
|
|
230
165
|
query?: never;
|
|
@@ -281,10 +216,11 @@ export interface components {
|
|
|
281
216
|
* linked to a workspace. A worker takes a schedule through a claim (the
|
|
282
217
|
* generic `claim` construct, nested under the schedule); while the claim is
|
|
283
218
|
* live no other worker can take it, and a claim past its `expiresAt` is
|
|
284
|
-
* stale and the schedule is claimable again. The `claim
|
|
285
|
-
* values `assigned`, `claimed` and `running
|
|
286
|
-
*
|
|
287
|
-
*
|
|
219
|
+
* stale and the schedule is claimable again. The `claim` and the status
|
|
220
|
+
* values `assigned`, `claimed` and `running` are server-managed and change
|
|
221
|
+
* only through the claim and release operations. Pausing is data, not an
|
|
222
|
+
* operation: a client sets `paused` (and optionally `pauseReason`) on create
|
|
223
|
+
* or update, and the server records `pausedAt` and `pausedBy`.
|
|
288
224
|
*/
|
|
289
225
|
Schedule: {
|
|
290
226
|
/**
|
|
@@ -408,7 +344,7 @@ export interface components {
|
|
|
408
344
|
pausedAt?: string | null;
|
|
409
345
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
410
346
|
pausedBy?: string;
|
|
411
|
-
/** @description Reason given for pausing the schedule.
|
|
347
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
412
348
|
pauseReason?: string;
|
|
413
349
|
/**
|
|
414
350
|
* Format: date-time
|
|
@@ -426,50 +362,13 @@ export interface components {
|
|
|
426
362
|
*/
|
|
427
363
|
deletedAt?: string | null;
|
|
428
364
|
};
|
|
429
|
-
/**
|
|
430
|
-
* Schedule Pause Schema
|
|
431
|
-
* @description Server-returned organization-wide schedule pause. While a pause exists for
|
|
432
|
-
* an organization, none of its schedules is claimed unless the claim
|
|
433
|
-
* request carries the operator override. Absence of a pause means
|
|
434
|
-
* unpaused; there is at most one live pause per organization. A pause on a
|
|
435
|
-
* single schedule is carried on the schedule itself.
|
|
436
|
-
*/
|
|
437
|
-
SchedulePause: {
|
|
438
|
-
/**
|
|
439
|
-
* Format: uuid
|
|
440
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
441
|
-
*/
|
|
442
|
-
id: string;
|
|
443
|
-
/**
|
|
444
|
-
* Format: uuid
|
|
445
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
446
|
-
*/
|
|
447
|
-
organizationId: string;
|
|
448
|
-
/**
|
|
449
|
-
* Format: date-time
|
|
450
|
-
* @description Time the pause was set.
|
|
451
|
-
*/
|
|
452
|
-
pausedAt: string;
|
|
453
|
-
/** @description Identity that set the pause. Server-managed. */
|
|
454
|
-
pausedBy?: string;
|
|
455
|
-
/** @description Reason given for pausing every schedule in the organization. */
|
|
456
|
-
reason?: string;
|
|
457
|
-
/**
|
|
458
|
-
* Format: date-time
|
|
459
|
-
* @description Timestamp of schedule pause creation.
|
|
460
|
-
*/
|
|
461
|
-
createdAt: string;
|
|
462
|
-
/**
|
|
463
|
-
* Format: date-time
|
|
464
|
-
* @description Timestamp of last schedule pause modification.
|
|
465
|
-
*/
|
|
466
|
-
updatedAt: string;
|
|
467
|
-
};
|
|
468
365
|
/**
|
|
469
366
|
* @description Payload for creating or updating a schedule. Contains only
|
|
470
|
-
* client-settable fields; the owning `organizationId`, the claim,
|
|
471
|
-
*
|
|
472
|
-
* timestamps are server-managed.
|
|
367
|
+
* client-settable fields; the owning `organizationId`, the claim,
|
|
368
|
+
* `pausedAt`, `pausedBy`, `retryCount`, `lastRunAt`, `lastError` and the
|
|
369
|
+
* timestamps are server-managed. The server ignores them on input. Pausing
|
|
370
|
+
* is a field, not an operation: `paused` pauses or resumes the schedule.
|
|
371
|
+
* `status` accepts only `pending`,
|
|
473
372
|
* `scheduled` and `cancelled` here; the other values are set by the
|
|
474
373
|
* claim and release operations.
|
|
475
374
|
*/
|
|
@@ -508,6 +407,14 @@ export interface components {
|
|
|
508
407
|
maxRetries?: number;
|
|
509
408
|
/** @description Minutes to wait before a retry becomes due. */
|
|
510
409
|
retryDelayMinutes?: number;
|
|
410
|
+
/**
|
|
411
|
+
* @description `true` pauses the schedule so it is never claimed (unless a claim
|
|
412
|
+
* carries `ignorePause`); `false` resumes it. Omit to leave the pause
|
|
413
|
+
* unchanged. The server records `pausedAt` and `pausedBy`.
|
|
414
|
+
*/
|
|
415
|
+
paused?: boolean;
|
|
416
|
+
/** @description Reason for pausing; stored only while `paused` is true and cleared on resume. */
|
|
417
|
+
pauseReason?: string;
|
|
511
418
|
};
|
|
512
419
|
/** @description Request to claim the next due schedule. */
|
|
513
420
|
ScheduleClaimRequest: {
|
|
@@ -558,13 +465,6 @@ export interface components {
|
|
|
558
465
|
/** @description Retries used so far for the current run. */
|
|
559
466
|
retryCount?: number;
|
|
560
467
|
};
|
|
561
|
-
/** @description Request to pause a schedule or every schedule in the organization. */
|
|
562
|
-
SchedulePausePayload: {
|
|
563
|
-
/** @description Identity setting the pause; defaults to the authenticated user. */
|
|
564
|
-
pausedBy?: string;
|
|
565
|
-
/** @description Reason for the pause. */
|
|
566
|
-
reason?: string;
|
|
567
|
-
};
|
|
568
468
|
/** @description Paginated collection of schedules. */
|
|
569
469
|
SchedulePage: {
|
|
570
470
|
/** @description Current page number of the result set. */
|
|
@@ -696,7 +596,7 @@ export interface components {
|
|
|
696
596
|
pausedAt?: string | null;
|
|
697
597
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
698
598
|
pausedBy?: string;
|
|
699
|
-
/** @description Reason given for pausing the schedule.
|
|
599
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
700
600
|
pauseReason?: string;
|
|
701
601
|
/**
|
|
702
602
|
* Format: date-time
|
|
@@ -945,7 +845,7 @@ export interface operations {
|
|
|
945
845
|
pausedAt?: string | null;
|
|
946
846
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
947
847
|
pausedBy?: string;
|
|
948
|
-
/** @description Reason given for pausing the schedule.
|
|
848
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
949
849
|
pauseReason?: string;
|
|
950
850
|
/**
|
|
951
851
|
* Format: date-time
|
|
@@ -1039,6 +939,14 @@ export interface operations {
|
|
|
1039
939
|
maxRetries?: number;
|
|
1040
940
|
/** @description Minutes to wait before a retry becomes due. */
|
|
1041
941
|
retryDelayMinutes?: number;
|
|
942
|
+
/**
|
|
943
|
+
* @description `true` pauses the schedule so it is never claimed (unless a claim
|
|
944
|
+
* carries `ignorePause`); `false` resumes it. Omit to leave the pause
|
|
945
|
+
* unchanged. The server records `pausedAt` and `pausedBy`.
|
|
946
|
+
*/
|
|
947
|
+
paused?: boolean;
|
|
948
|
+
/** @description Reason for pausing; stored only while `paused` is true and cleared on resume. */
|
|
949
|
+
pauseReason?: string;
|
|
1042
950
|
};
|
|
1043
951
|
};
|
|
1044
952
|
};
|
|
@@ -1171,7 +1079,7 @@ export interface operations {
|
|
|
1171
1079
|
pausedAt?: string | null;
|
|
1172
1080
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
1173
1081
|
pausedBy?: string;
|
|
1174
|
-
/** @description Reason given for pausing the schedule.
|
|
1082
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
1175
1083
|
pauseReason?: string;
|
|
1176
1084
|
/**
|
|
1177
1085
|
* Format: date-time
|
|
@@ -1382,7 +1290,7 @@ export interface operations {
|
|
|
1382
1290
|
pausedAt?: string | null;
|
|
1383
1291
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
1384
1292
|
pausedBy?: string;
|
|
1385
|
-
/** @description Reason given for pausing the schedule.
|
|
1293
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
1386
1294
|
pauseReason?: string;
|
|
1387
1295
|
/**
|
|
1388
1296
|
* Format: date-time
|
|
@@ -1447,16 +1355,19 @@ export interface operations {
|
|
|
1447
1355
|
};
|
|
1448
1356
|
};
|
|
1449
1357
|
};
|
|
1450
|
-
|
|
1358
|
+
getScheduleById: {
|
|
1451
1359
|
parameters: {
|
|
1452
1360
|
query?: never;
|
|
1453
1361
|
header?: never;
|
|
1454
|
-
path
|
|
1362
|
+
path: {
|
|
1363
|
+
/** @description Schedule ID */
|
|
1364
|
+
scheduleId: string;
|
|
1365
|
+
};
|
|
1455
1366
|
cookie?: never;
|
|
1456
1367
|
};
|
|
1457
1368
|
requestBody?: never;
|
|
1458
1369
|
responses: {
|
|
1459
|
-
/** @description
|
|
1370
|
+
/** @description Schedule response */
|
|
1460
1371
|
200: {
|
|
1461
1372
|
headers: {
|
|
1462
1373
|
[name: string]: unknown;
|
|
@@ -1473,35 +1384,137 @@ export interface operations {
|
|
|
1473
1384
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1474
1385
|
*/
|
|
1475
1386
|
organizationId: string;
|
|
1387
|
+
/**
|
|
1388
|
+
* Format: uuid
|
|
1389
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1390
|
+
*/
|
|
1391
|
+
workspaceId?: string;
|
|
1392
|
+
/** @description Human-readable name for the schedule. */
|
|
1393
|
+
name: string;
|
|
1394
|
+
/** @description The action the worker runs when it holds the schedule's claim, for example a command name. */
|
|
1395
|
+
action: string;
|
|
1396
|
+
/** @description Action parameters, stored as a JSON blob. */
|
|
1397
|
+
params?: Record<string, never>;
|
|
1398
|
+
/** @description Whether the schedule is eligible to run. A disabled schedule is never claimed. */
|
|
1399
|
+
enabled: boolean;
|
|
1400
|
+
/**
|
|
1401
|
+
* Format: date-time
|
|
1402
|
+
* @description Time the schedule first becomes due.
|
|
1403
|
+
*/
|
|
1404
|
+
runAt?: string | null;
|
|
1405
|
+
/**
|
|
1406
|
+
* Format: date-time
|
|
1407
|
+
* @description Next time a recurring or retrying schedule becomes due.
|
|
1408
|
+
*/
|
|
1409
|
+
nextRunAt?: string | null;
|
|
1410
|
+
/** @description Recurrence rule for repeating schedules. Empty for a run-once schedule. */
|
|
1411
|
+
recurrence?: string;
|
|
1412
|
+
/**
|
|
1413
|
+
* @description Lifecycle status. `pending`: created, not yet due-scheduled.
|
|
1414
|
+
* `scheduled`: waiting for its due time. `assigned`: designated for a
|
|
1415
|
+
* particular worker but not yet claimed. `claimed`: a worker holds the
|
|
1416
|
+
* claim and has not started. `running`: the claim holder is executing
|
|
1417
|
+
* it. `retrying`: the last attempt failed and another is due.
|
|
1418
|
+
* `completed`, `failed` and `cancelled` are terminal for a run-once
|
|
1419
|
+
* schedule; a recurring schedule returns to `scheduled`.
|
|
1420
|
+
* @enum {string}
|
|
1421
|
+
*/
|
|
1422
|
+
status: "pending" | "scheduled" | "assigned" | "claimed" | "running" | "retrying" | "completed" | "failed" | "cancelled";
|
|
1423
|
+
/** @description Attempts already retried for the current run. */
|
|
1424
|
+
retryCount: number;
|
|
1425
|
+
/** @description Maximum retries before the run is marked failed. */
|
|
1426
|
+
maxRetries: number;
|
|
1427
|
+
/** @description Minutes to wait before a retry becomes due. */
|
|
1428
|
+
retryDelayMinutes?: number;
|
|
1429
|
+
/**
|
|
1430
|
+
* Format: date-time
|
|
1431
|
+
* @description Time of the most recent attempt.
|
|
1432
|
+
*/
|
|
1433
|
+
lastRunAt?: string | null;
|
|
1434
|
+
/** @description Error reported by the most recent attempt. */
|
|
1435
|
+
lastError?: string;
|
|
1436
|
+
/**
|
|
1437
|
+
* Claim Schema
|
|
1438
|
+
* @description The schedule's live claim, when one is held. Server-managed; omitted when the schedule is unclaimed.
|
|
1439
|
+
*/
|
|
1440
|
+
claim?: {
|
|
1441
|
+
/**
|
|
1442
|
+
* Format: uuid
|
|
1443
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1444
|
+
*/
|
|
1445
|
+
id: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* Format: uuid
|
|
1448
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1449
|
+
*/
|
|
1450
|
+
organizationId: string;
|
|
1451
|
+
/** @description Type of the claimed resource, for example `schedule`. */
|
|
1452
|
+
resourceType: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* Format: uuid
|
|
1455
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1456
|
+
*/
|
|
1457
|
+
resourceId: string;
|
|
1458
|
+
/** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
|
|
1459
|
+
claimant: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
1462
|
+
* @enum {string}
|
|
1463
|
+
*/
|
|
1464
|
+
status: "active" | "released" | "expired";
|
|
1465
|
+
/**
|
|
1466
|
+
* Format: date-time
|
|
1467
|
+
* @description Time the claim was taken.
|
|
1468
|
+
*/
|
|
1469
|
+
claimedAt: string;
|
|
1470
|
+
/**
|
|
1471
|
+
* Format: date-time
|
|
1472
|
+
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
1473
|
+
*/
|
|
1474
|
+
expiresAt: string;
|
|
1475
|
+
/**
|
|
1476
|
+
* Format: date-time
|
|
1477
|
+
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
1478
|
+
*/
|
|
1479
|
+
releasedAt?: string | null;
|
|
1480
|
+
/**
|
|
1481
|
+
* Format: date-time
|
|
1482
|
+
* @description Timestamp of claim creation.
|
|
1483
|
+
*/
|
|
1484
|
+
createdAt: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* Format: date-time
|
|
1487
|
+
* @description Timestamp of last claim modification.
|
|
1488
|
+
*/
|
|
1489
|
+
updatedAt: string;
|
|
1490
|
+
};
|
|
1476
1491
|
/**
|
|
1477
1492
|
* Format: date-time
|
|
1478
|
-
* @description Time the
|
|
1493
|
+
* @description Time the schedule was paused. Null when the schedule is not paused. Server-managed.
|
|
1479
1494
|
*/
|
|
1480
|
-
pausedAt
|
|
1481
|
-
/** @description Identity that
|
|
1495
|
+
pausedAt?: string | null;
|
|
1496
|
+
/** @description Identity that paused the schedule. Server-managed. */
|
|
1482
1497
|
pausedBy?: string;
|
|
1483
|
-
/** @description Reason given for pausing
|
|
1484
|
-
|
|
1498
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
1499
|
+
pauseReason?: string;
|
|
1485
1500
|
/**
|
|
1486
1501
|
* Format: date-time
|
|
1487
|
-
* @description Timestamp of schedule
|
|
1502
|
+
* @description Timestamp of schedule creation.
|
|
1488
1503
|
*/
|
|
1489
1504
|
createdAt: string;
|
|
1490
1505
|
/**
|
|
1491
1506
|
* Format: date-time
|
|
1492
|
-
* @description Timestamp of last schedule
|
|
1507
|
+
* @description Timestamp of last schedule modification.
|
|
1493
1508
|
*/
|
|
1494
1509
|
updatedAt: string;
|
|
1510
|
+
/**
|
|
1511
|
+
* Format: date-time
|
|
1512
|
+
* @description Timestamp when the schedule was soft-deleted. Null while live.
|
|
1513
|
+
*/
|
|
1514
|
+
deletedAt?: string | null;
|
|
1495
1515
|
};
|
|
1496
1516
|
};
|
|
1497
1517
|
};
|
|
1498
|
-
/** @description The organization is not paused */
|
|
1499
|
-
204: {
|
|
1500
|
-
headers: {
|
|
1501
|
-
[name: string]: unknown;
|
|
1502
|
-
};
|
|
1503
|
-
content?: never;
|
|
1504
|
-
};
|
|
1505
1518
|
/** @description Expired JWT token used or insufficient privilege */
|
|
1506
1519
|
401: {
|
|
1507
1520
|
headers: {
|
|
@@ -1531,25 +1544,66 @@ export interface operations {
|
|
|
1531
1544
|
};
|
|
1532
1545
|
};
|
|
1533
1546
|
};
|
|
1534
|
-
|
|
1547
|
+
updateSchedule: {
|
|
1535
1548
|
parameters: {
|
|
1536
1549
|
query?: never;
|
|
1537
1550
|
header?: never;
|
|
1538
|
-
path
|
|
1551
|
+
path: {
|
|
1552
|
+
/** @description Schedule ID */
|
|
1553
|
+
scheduleId: string;
|
|
1554
|
+
};
|
|
1539
1555
|
cookie?: never;
|
|
1540
1556
|
};
|
|
1541
1557
|
requestBody: {
|
|
1542
1558
|
content: {
|
|
1543
1559
|
"application/json": {
|
|
1544
|
-
/**
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
|
|
1560
|
+
/**
|
|
1561
|
+
* Format: uuid
|
|
1562
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1563
|
+
*/
|
|
1564
|
+
id?: string;
|
|
1565
|
+
/**
|
|
1566
|
+
* Format: uuid
|
|
1567
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1568
|
+
*/
|
|
1569
|
+
workspaceId?: string;
|
|
1570
|
+
/** @description Human-readable name for the schedule. */
|
|
1571
|
+
name: string;
|
|
1572
|
+
/** @description The action the worker runs, for example a command name. */
|
|
1573
|
+
action: string;
|
|
1574
|
+
/** @description Action parameters, stored as a JSON blob. */
|
|
1575
|
+
params?: Record<string, never>;
|
|
1576
|
+
/** @description Whether the schedule is eligible to run. Defaults to true. */
|
|
1577
|
+
enabled?: boolean;
|
|
1578
|
+
/**
|
|
1579
|
+
* Format: date-time
|
|
1580
|
+
* @description Time the schedule first becomes due.
|
|
1581
|
+
*/
|
|
1582
|
+
runAt?: string | null;
|
|
1583
|
+
/** @description Recurrence rule for repeating schedules. Empty for a run-once schedule. */
|
|
1584
|
+
recurrence?: string;
|
|
1585
|
+
/**
|
|
1586
|
+
* @description Client-settable status. Omit to let the server choose `scheduled` for a due-timed schedule and `pending` otherwise.
|
|
1587
|
+
* @enum {string}
|
|
1588
|
+
*/
|
|
1589
|
+
status?: "pending" | "scheduled" | "cancelled";
|
|
1590
|
+
/** @description Maximum retries before the run is marked failed. */
|
|
1591
|
+
maxRetries?: number;
|
|
1592
|
+
/** @description Minutes to wait before a retry becomes due. */
|
|
1593
|
+
retryDelayMinutes?: number;
|
|
1594
|
+
/**
|
|
1595
|
+
* @description `true` pauses the schedule so it is never claimed (unless a claim
|
|
1596
|
+
* carries `ignorePause`); `false` resumes it. Omit to leave the pause
|
|
1597
|
+
* unchanged. The server records `pausedAt` and `pausedBy`.
|
|
1598
|
+
*/
|
|
1599
|
+
paused?: boolean;
|
|
1600
|
+
/** @description Reason for pausing; stored only while `paused` is true and cleared on resume. */
|
|
1601
|
+
pauseReason?: string;
|
|
1548
1602
|
};
|
|
1549
1603
|
};
|
|
1550
1604
|
};
|
|
1551
1605
|
responses: {
|
|
1552
|
-
/** @description
|
|
1606
|
+
/** @description Schedule updated */
|
|
1553
1607
|
200: {
|
|
1554
1608
|
headers: {
|
|
1555
1609
|
[name: string]: unknown;
|
|
@@ -1567,845 +1621,8 @@ export interface operations {
|
|
|
1567
1621
|
*/
|
|
1568
1622
|
organizationId: string;
|
|
1569
1623
|
/**
|
|
1570
|
-
* Format:
|
|
1571
|
-
* @description
|
|
1572
|
-
*/
|
|
1573
|
-
pausedAt: string;
|
|
1574
|
-
/** @description Identity that set the pause. Server-managed. */
|
|
1575
|
-
pausedBy?: string;
|
|
1576
|
-
/** @description Reason given for pausing every schedule in the organization. */
|
|
1577
|
-
reason?: string;
|
|
1578
|
-
/**
|
|
1579
|
-
* Format: date-time
|
|
1580
|
-
* @description Timestamp of schedule pause creation.
|
|
1581
|
-
*/
|
|
1582
|
-
createdAt: string;
|
|
1583
|
-
/**
|
|
1584
|
-
* Format: date-time
|
|
1585
|
-
* @description Timestamp of last schedule pause modification.
|
|
1586
|
-
*/
|
|
1587
|
-
updatedAt: string;
|
|
1588
|
-
};
|
|
1589
|
-
};
|
|
1590
|
-
};
|
|
1591
|
-
/** @description Invalid request body or request param */
|
|
1592
|
-
400: {
|
|
1593
|
-
headers: {
|
|
1594
|
-
[name: string]: unknown;
|
|
1595
|
-
};
|
|
1596
|
-
content: {
|
|
1597
|
-
"text/plain": string;
|
|
1598
|
-
};
|
|
1599
|
-
};
|
|
1600
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
1601
|
-
401: {
|
|
1602
|
-
headers: {
|
|
1603
|
-
[name: string]: unknown;
|
|
1604
|
-
};
|
|
1605
|
-
content: {
|
|
1606
|
-
"text/plain": string;
|
|
1607
|
-
};
|
|
1608
|
-
};
|
|
1609
|
-
/** @description Result not found */
|
|
1610
|
-
404: {
|
|
1611
|
-
headers: {
|
|
1612
|
-
[name: string]: unknown;
|
|
1613
|
-
};
|
|
1614
|
-
content: {
|
|
1615
|
-
"text/plain": string;
|
|
1616
|
-
};
|
|
1617
|
-
};
|
|
1618
|
-
/** @description Internal server error */
|
|
1619
|
-
500: {
|
|
1620
|
-
headers: {
|
|
1621
|
-
[name: string]: unknown;
|
|
1622
|
-
};
|
|
1623
|
-
content: {
|
|
1624
|
-
"text/plain": string;
|
|
1625
|
-
};
|
|
1626
|
-
};
|
|
1627
|
-
};
|
|
1628
|
-
};
|
|
1629
|
-
clearSchedulePause: {
|
|
1630
|
-
parameters: {
|
|
1631
|
-
query?: never;
|
|
1632
|
-
header?: never;
|
|
1633
|
-
path?: never;
|
|
1634
|
-
cookie?: never;
|
|
1635
|
-
};
|
|
1636
|
-
requestBody?: never;
|
|
1637
|
-
responses: {
|
|
1638
|
-
/** @description The organization is not paused */
|
|
1639
|
-
204: {
|
|
1640
|
-
headers: {
|
|
1641
|
-
[name: string]: unknown;
|
|
1642
|
-
};
|
|
1643
|
-
content?: never;
|
|
1644
|
-
};
|
|
1645
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
1646
|
-
401: {
|
|
1647
|
-
headers: {
|
|
1648
|
-
[name: string]: unknown;
|
|
1649
|
-
};
|
|
1650
|
-
content: {
|
|
1651
|
-
"text/plain": string;
|
|
1652
|
-
};
|
|
1653
|
-
};
|
|
1654
|
-
/** @description Result not found */
|
|
1655
|
-
404: {
|
|
1656
|
-
headers: {
|
|
1657
|
-
[name: string]: unknown;
|
|
1658
|
-
};
|
|
1659
|
-
content: {
|
|
1660
|
-
"text/plain": string;
|
|
1661
|
-
};
|
|
1662
|
-
};
|
|
1663
|
-
/** @description Internal server error */
|
|
1664
|
-
500: {
|
|
1665
|
-
headers: {
|
|
1666
|
-
[name: string]: unknown;
|
|
1667
|
-
};
|
|
1668
|
-
content: {
|
|
1669
|
-
"text/plain": string;
|
|
1670
|
-
};
|
|
1671
|
-
};
|
|
1672
|
-
};
|
|
1673
|
-
};
|
|
1674
|
-
getScheduleById: {
|
|
1675
|
-
parameters: {
|
|
1676
|
-
query?: never;
|
|
1677
|
-
header?: never;
|
|
1678
|
-
path: {
|
|
1679
|
-
/** @description Schedule ID */
|
|
1680
|
-
scheduleId: string;
|
|
1681
|
-
};
|
|
1682
|
-
cookie?: never;
|
|
1683
|
-
};
|
|
1684
|
-
requestBody?: never;
|
|
1685
|
-
responses: {
|
|
1686
|
-
/** @description Schedule response */
|
|
1687
|
-
200: {
|
|
1688
|
-
headers: {
|
|
1689
|
-
[name: string]: unknown;
|
|
1690
|
-
};
|
|
1691
|
-
content: {
|
|
1692
|
-
"application/json": {
|
|
1693
|
-
/**
|
|
1694
|
-
* Format: uuid
|
|
1695
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1696
|
-
*/
|
|
1697
|
-
id: string;
|
|
1698
|
-
/**
|
|
1699
|
-
* Format: uuid
|
|
1700
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1701
|
-
*/
|
|
1702
|
-
organizationId: string;
|
|
1703
|
-
/**
|
|
1704
|
-
* Format: uuid
|
|
1705
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1706
|
-
*/
|
|
1707
|
-
workspaceId?: string;
|
|
1708
|
-
/** @description Human-readable name for the schedule. */
|
|
1709
|
-
name: string;
|
|
1710
|
-
/** @description The action the worker runs when it holds the schedule's claim, for example a command name. */
|
|
1711
|
-
action: string;
|
|
1712
|
-
/** @description Action parameters, stored as a JSON blob. */
|
|
1713
|
-
params?: Record<string, never>;
|
|
1714
|
-
/** @description Whether the schedule is eligible to run. A disabled schedule is never claimed. */
|
|
1715
|
-
enabled: boolean;
|
|
1716
|
-
/**
|
|
1717
|
-
* Format: date-time
|
|
1718
|
-
* @description Time the schedule first becomes due.
|
|
1719
|
-
*/
|
|
1720
|
-
runAt?: string | null;
|
|
1721
|
-
/**
|
|
1722
|
-
* Format: date-time
|
|
1723
|
-
* @description Next time a recurring or retrying schedule becomes due.
|
|
1724
|
-
*/
|
|
1725
|
-
nextRunAt?: string | null;
|
|
1726
|
-
/** @description Recurrence rule for repeating schedules. Empty for a run-once schedule. */
|
|
1727
|
-
recurrence?: string;
|
|
1728
|
-
/**
|
|
1729
|
-
* @description Lifecycle status. `pending`: created, not yet due-scheduled.
|
|
1730
|
-
* `scheduled`: waiting for its due time. `assigned`: designated for a
|
|
1731
|
-
* particular worker but not yet claimed. `claimed`: a worker holds the
|
|
1732
|
-
* claim and has not started. `running`: the claim holder is executing
|
|
1733
|
-
* it. `retrying`: the last attempt failed and another is due.
|
|
1734
|
-
* `completed`, `failed` and `cancelled` are terminal for a run-once
|
|
1735
|
-
* schedule; a recurring schedule returns to `scheduled`.
|
|
1736
|
-
* @enum {string}
|
|
1737
|
-
*/
|
|
1738
|
-
status: "pending" | "scheduled" | "assigned" | "claimed" | "running" | "retrying" | "completed" | "failed" | "cancelled";
|
|
1739
|
-
/** @description Attempts already retried for the current run. */
|
|
1740
|
-
retryCount: number;
|
|
1741
|
-
/** @description Maximum retries before the run is marked failed. */
|
|
1742
|
-
maxRetries: number;
|
|
1743
|
-
/** @description Minutes to wait before a retry becomes due. */
|
|
1744
|
-
retryDelayMinutes?: number;
|
|
1745
|
-
/**
|
|
1746
|
-
* Format: date-time
|
|
1747
|
-
* @description Time of the most recent attempt.
|
|
1748
|
-
*/
|
|
1749
|
-
lastRunAt?: string | null;
|
|
1750
|
-
/** @description Error reported by the most recent attempt. */
|
|
1751
|
-
lastError?: string;
|
|
1752
|
-
/**
|
|
1753
|
-
* Claim Schema
|
|
1754
|
-
* @description The schedule's live claim, when one is held. Server-managed; omitted when the schedule is unclaimed.
|
|
1755
|
-
*/
|
|
1756
|
-
claim?: {
|
|
1757
|
-
/**
|
|
1758
|
-
* Format: uuid
|
|
1759
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1760
|
-
*/
|
|
1761
|
-
id: string;
|
|
1762
|
-
/**
|
|
1763
|
-
* Format: uuid
|
|
1764
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1765
|
-
*/
|
|
1766
|
-
organizationId: string;
|
|
1767
|
-
/** @description Type of the claimed resource, for example `schedule`. */
|
|
1768
|
-
resourceType: string;
|
|
1769
|
-
/**
|
|
1770
|
-
* Format: uuid
|
|
1771
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1772
|
-
*/
|
|
1773
|
-
resourceId: string;
|
|
1774
|
-
/** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
|
|
1775
|
-
claimant: string;
|
|
1776
|
-
/**
|
|
1777
|
-
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
1778
|
-
* @enum {string}
|
|
1779
|
-
*/
|
|
1780
|
-
status: "active" | "released" | "expired";
|
|
1781
|
-
/**
|
|
1782
|
-
* Format: date-time
|
|
1783
|
-
* @description Time the claim was taken.
|
|
1784
|
-
*/
|
|
1785
|
-
claimedAt: string;
|
|
1786
|
-
/**
|
|
1787
|
-
* Format: date-time
|
|
1788
|
-
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
1789
|
-
*/
|
|
1790
|
-
expiresAt: string;
|
|
1791
|
-
/**
|
|
1792
|
-
* Format: date-time
|
|
1793
|
-
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
1794
|
-
*/
|
|
1795
|
-
releasedAt?: string | null;
|
|
1796
|
-
/**
|
|
1797
|
-
* Format: date-time
|
|
1798
|
-
* @description Timestamp of claim creation.
|
|
1799
|
-
*/
|
|
1800
|
-
createdAt: string;
|
|
1801
|
-
/**
|
|
1802
|
-
* Format: date-time
|
|
1803
|
-
* @description Timestamp of last claim modification.
|
|
1804
|
-
*/
|
|
1805
|
-
updatedAt: string;
|
|
1806
|
-
};
|
|
1807
|
-
/**
|
|
1808
|
-
* Format: date-time
|
|
1809
|
-
* @description Time the schedule was paused. Null when the schedule is not paused. Server-managed.
|
|
1810
|
-
*/
|
|
1811
|
-
pausedAt?: string | null;
|
|
1812
|
-
/** @description Identity that paused the schedule. Server-managed. */
|
|
1813
|
-
pausedBy?: string;
|
|
1814
|
-
/** @description Reason given for pausing the schedule. Server-managed. */
|
|
1815
|
-
pauseReason?: string;
|
|
1816
|
-
/**
|
|
1817
|
-
* Format: date-time
|
|
1818
|
-
* @description Timestamp of schedule creation.
|
|
1819
|
-
*/
|
|
1820
|
-
createdAt: string;
|
|
1821
|
-
/**
|
|
1822
|
-
* Format: date-time
|
|
1823
|
-
* @description Timestamp of last schedule modification.
|
|
1824
|
-
*/
|
|
1825
|
-
updatedAt: string;
|
|
1826
|
-
/**
|
|
1827
|
-
* Format: date-time
|
|
1828
|
-
* @description Timestamp when the schedule was soft-deleted. Null while live.
|
|
1829
|
-
*/
|
|
1830
|
-
deletedAt?: string | null;
|
|
1831
|
-
};
|
|
1832
|
-
};
|
|
1833
|
-
};
|
|
1834
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
1835
|
-
401: {
|
|
1836
|
-
headers: {
|
|
1837
|
-
[name: string]: unknown;
|
|
1838
|
-
};
|
|
1839
|
-
content: {
|
|
1840
|
-
"text/plain": string;
|
|
1841
|
-
};
|
|
1842
|
-
};
|
|
1843
|
-
/** @description Result not found */
|
|
1844
|
-
404: {
|
|
1845
|
-
headers: {
|
|
1846
|
-
[name: string]: unknown;
|
|
1847
|
-
};
|
|
1848
|
-
content: {
|
|
1849
|
-
"text/plain": string;
|
|
1850
|
-
};
|
|
1851
|
-
};
|
|
1852
|
-
/** @description Internal server error */
|
|
1853
|
-
500: {
|
|
1854
|
-
headers: {
|
|
1855
|
-
[name: string]: unknown;
|
|
1856
|
-
};
|
|
1857
|
-
content: {
|
|
1858
|
-
"text/plain": string;
|
|
1859
|
-
};
|
|
1860
|
-
};
|
|
1861
|
-
};
|
|
1862
|
-
};
|
|
1863
|
-
updateSchedule: {
|
|
1864
|
-
parameters: {
|
|
1865
|
-
query?: never;
|
|
1866
|
-
header?: never;
|
|
1867
|
-
path: {
|
|
1868
|
-
/** @description Schedule ID */
|
|
1869
|
-
scheduleId: string;
|
|
1870
|
-
};
|
|
1871
|
-
cookie?: never;
|
|
1872
|
-
};
|
|
1873
|
-
requestBody: {
|
|
1874
|
-
content: {
|
|
1875
|
-
"application/json": {
|
|
1876
|
-
/**
|
|
1877
|
-
* Format: uuid
|
|
1878
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1879
|
-
*/
|
|
1880
|
-
id?: string;
|
|
1881
|
-
/**
|
|
1882
|
-
* Format: uuid
|
|
1883
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1884
|
-
*/
|
|
1885
|
-
workspaceId?: string;
|
|
1886
|
-
/** @description Human-readable name for the schedule. */
|
|
1887
|
-
name: string;
|
|
1888
|
-
/** @description The action the worker runs, for example a command name. */
|
|
1889
|
-
action: string;
|
|
1890
|
-
/** @description Action parameters, stored as a JSON blob. */
|
|
1891
|
-
params?: Record<string, never>;
|
|
1892
|
-
/** @description Whether the schedule is eligible to run. Defaults to true. */
|
|
1893
|
-
enabled?: boolean;
|
|
1894
|
-
/**
|
|
1895
|
-
* Format: date-time
|
|
1896
|
-
* @description Time the schedule first becomes due.
|
|
1897
|
-
*/
|
|
1898
|
-
runAt?: string | null;
|
|
1899
|
-
/** @description Recurrence rule for repeating schedules. Empty for a run-once schedule. */
|
|
1900
|
-
recurrence?: string;
|
|
1901
|
-
/**
|
|
1902
|
-
* @description Client-settable status. Omit to let the server choose `scheduled` for a due-timed schedule and `pending` otherwise.
|
|
1903
|
-
* @enum {string}
|
|
1904
|
-
*/
|
|
1905
|
-
status?: "pending" | "scheduled" | "cancelled";
|
|
1906
|
-
/** @description Maximum retries before the run is marked failed. */
|
|
1907
|
-
maxRetries?: number;
|
|
1908
|
-
/** @description Minutes to wait before a retry becomes due. */
|
|
1909
|
-
retryDelayMinutes?: number;
|
|
1910
|
-
};
|
|
1911
|
-
};
|
|
1912
|
-
};
|
|
1913
|
-
responses: {
|
|
1914
|
-
/** @description Schedule updated */
|
|
1915
|
-
200: {
|
|
1916
|
-
headers: {
|
|
1917
|
-
[name: string]: unknown;
|
|
1918
|
-
};
|
|
1919
|
-
content: {
|
|
1920
|
-
"application/json": {
|
|
1921
|
-
/**
|
|
1922
|
-
* Format: uuid
|
|
1923
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1924
|
-
*/
|
|
1925
|
-
id: string;
|
|
1926
|
-
/**
|
|
1927
|
-
* Format: uuid
|
|
1928
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1929
|
-
*/
|
|
1930
|
-
organizationId: string;
|
|
1931
|
-
/**
|
|
1932
|
-
* Format: uuid
|
|
1933
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1934
|
-
*/
|
|
1935
|
-
workspaceId?: string;
|
|
1936
|
-
/** @description Human-readable name for the schedule. */
|
|
1937
|
-
name: string;
|
|
1938
|
-
/** @description The action the worker runs when it holds the schedule's claim, for example a command name. */
|
|
1939
|
-
action: string;
|
|
1940
|
-
/** @description Action parameters, stored as a JSON blob. */
|
|
1941
|
-
params?: Record<string, never>;
|
|
1942
|
-
/** @description Whether the schedule is eligible to run. A disabled schedule is never claimed. */
|
|
1943
|
-
enabled: boolean;
|
|
1944
|
-
/**
|
|
1945
|
-
* Format: date-time
|
|
1946
|
-
* @description Time the schedule first becomes due.
|
|
1947
|
-
*/
|
|
1948
|
-
runAt?: string | null;
|
|
1949
|
-
/**
|
|
1950
|
-
* Format: date-time
|
|
1951
|
-
* @description Next time a recurring or retrying schedule becomes due.
|
|
1952
|
-
*/
|
|
1953
|
-
nextRunAt?: string | null;
|
|
1954
|
-
/** @description Recurrence rule for repeating schedules. Empty for a run-once schedule. */
|
|
1955
|
-
recurrence?: string;
|
|
1956
|
-
/**
|
|
1957
|
-
* @description Lifecycle status. `pending`: created, not yet due-scheduled.
|
|
1958
|
-
* `scheduled`: waiting for its due time. `assigned`: designated for a
|
|
1959
|
-
* particular worker but not yet claimed. `claimed`: a worker holds the
|
|
1960
|
-
* claim and has not started. `running`: the claim holder is executing
|
|
1961
|
-
* it. `retrying`: the last attempt failed and another is due.
|
|
1962
|
-
* `completed`, `failed` and `cancelled` are terminal for a run-once
|
|
1963
|
-
* schedule; a recurring schedule returns to `scheduled`.
|
|
1964
|
-
* @enum {string}
|
|
1965
|
-
*/
|
|
1966
|
-
status: "pending" | "scheduled" | "assigned" | "claimed" | "running" | "retrying" | "completed" | "failed" | "cancelled";
|
|
1967
|
-
/** @description Attempts already retried for the current run. */
|
|
1968
|
-
retryCount: number;
|
|
1969
|
-
/** @description Maximum retries before the run is marked failed. */
|
|
1970
|
-
maxRetries: number;
|
|
1971
|
-
/** @description Minutes to wait before a retry becomes due. */
|
|
1972
|
-
retryDelayMinutes?: number;
|
|
1973
|
-
/**
|
|
1974
|
-
* Format: date-time
|
|
1975
|
-
* @description Time of the most recent attempt.
|
|
1976
|
-
*/
|
|
1977
|
-
lastRunAt?: string | null;
|
|
1978
|
-
/** @description Error reported by the most recent attempt. */
|
|
1979
|
-
lastError?: string;
|
|
1980
|
-
/**
|
|
1981
|
-
* Claim Schema
|
|
1982
|
-
* @description The schedule's live claim, when one is held. Server-managed; omitted when the schedule is unclaimed.
|
|
1983
|
-
*/
|
|
1984
|
-
claim?: {
|
|
1985
|
-
/**
|
|
1986
|
-
* Format: uuid
|
|
1987
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1988
|
-
*/
|
|
1989
|
-
id: string;
|
|
1990
|
-
/**
|
|
1991
|
-
* Format: uuid
|
|
1992
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1993
|
-
*/
|
|
1994
|
-
organizationId: string;
|
|
1995
|
-
/** @description Type of the claimed resource, for example `schedule`. */
|
|
1996
|
-
resourceType: string;
|
|
1997
|
-
/**
|
|
1998
|
-
* Format: uuid
|
|
1999
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2000
|
-
*/
|
|
2001
|
-
resourceId: string;
|
|
2002
|
-
/** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
|
|
2003
|
-
claimant: string;
|
|
2004
|
-
/**
|
|
2005
|
-
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
2006
|
-
* @enum {string}
|
|
2007
|
-
*/
|
|
2008
|
-
status: "active" | "released" | "expired";
|
|
2009
|
-
/**
|
|
2010
|
-
* Format: date-time
|
|
2011
|
-
* @description Time the claim was taken.
|
|
2012
|
-
*/
|
|
2013
|
-
claimedAt: string;
|
|
2014
|
-
/**
|
|
2015
|
-
* Format: date-time
|
|
2016
|
-
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
2017
|
-
*/
|
|
2018
|
-
expiresAt: string;
|
|
2019
|
-
/**
|
|
2020
|
-
* Format: date-time
|
|
2021
|
-
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
2022
|
-
*/
|
|
2023
|
-
releasedAt?: string | null;
|
|
2024
|
-
/**
|
|
2025
|
-
* Format: date-time
|
|
2026
|
-
* @description Timestamp of claim creation.
|
|
2027
|
-
*/
|
|
2028
|
-
createdAt: string;
|
|
2029
|
-
/**
|
|
2030
|
-
* Format: date-time
|
|
2031
|
-
* @description Timestamp of last claim modification.
|
|
2032
|
-
*/
|
|
2033
|
-
updatedAt: string;
|
|
2034
|
-
};
|
|
2035
|
-
/**
|
|
2036
|
-
* Format: date-time
|
|
2037
|
-
* @description Time the schedule was paused. Null when the schedule is not paused. Server-managed.
|
|
2038
|
-
*/
|
|
2039
|
-
pausedAt?: string | null;
|
|
2040
|
-
/** @description Identity that paused the schedule. Server-managed. */
|
|
2041
|
-
pausedBy?: string;
|
|
2042
|
-
/** @description Reason given for pausing the schedule. Server-managed. */
|
|
2043
|
-
pauseReason?: string;
|
|
2044
|
-
/**
|
|
2045
|
-
* Format: date-time
|
|
2046
|
-
* @description Timestamp of schedule creation.
|
|
2047
|
-
*/
|
|
2048
|
-
createdAt: string;
|
|
2049
|
-
/**
|
|
2050
|
-
* Format: date-time
|
|
2051
|
-
* @description Timestamp of last schedule modification.
|
|
2052
|
-
*/
|
|
2053
|
-
updatedAt: string;
|
|
2054
|
-
/**
|
|
2055
|
-
* Format: date-time
|
|
2056
|
-
* @description Timestamp when the schedule was soft-deleted. Null while live.
|
|
2057
|
-
*/
|
|
2058
|
-
deletedAt?: string | null;
|
|
2059
|
-
};
|
|
2060
|
-
};
|
|
2061
|
-
};
|
|
2062
|
-
/** @description Invalid request body or request param */
|
|
2063
|
-
400: {
|
|
2064
|
-
headers: {
|
|
2065
|
-
[name: string]: unknown;
|
|
2066
|
-
};
|
|
2067
|
-
content: {
|
|
2068
|
-
"text/plain": string;
|
|
2069
|
-
};
|
|
2070
|
-
};
|
|
2071
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
2072
|
-
401: {
|
|
2073
|
-
headers: {
|
|
2074
|
-
[name: string]: unknown;
|
|
2075
|
-
};
|
|
2076
|
-
content: {
|
|
2077
|
-
"text/plain": string;
|
|
2078
|
-
};
|
|
2079
|
-
};
|
|
2080
|
-
/** @description Result not found */
|
|
2081
|
-
404: {
|
|
2082
|
-
headers: {
|
|
2083
|
-
[name: string]: unknown;
|
|
2084
|
-
};
|
|
2085
|
-
content: {
|
|
2086
|
-
"text/plain": string;
|
|
2087
|
-
};
|
|
2088
|
-
};
|
|
2089
|
-
/** @description Internal server error */
|
|
2090
|
-
500: {
|
|
2091
|
-
headers: {
|
|
2092
|
-
[name: string]: unknown;
|
|
2093
|
-
};
|
|
2094
|
-
content: {
|
|
2095
|
-
"text/plain": string;
|
|
2096
|
-
};
|
|
2097
|
-
};
|
|
2098
|
-
};
|
|
2099
|
-
};
|
|
2100
|
-
deleteScheduleById: {
|
|
2101
|
-
parameters: {
|
|
2102
|
-
query?: never;
|
|
2103
|
-
header?: never;
|
|
2104
|
-
path: {
|
|
2105
|
-
/** @description Schedule ID */
|
|
2106
|
-
scheduleId: string;
|
|
2107
|
-
};
|
|
2108
|
-
cookie?: never;
|
|
2109
|
-
};
|
|
2110
|
-
requestBody?: never;
|
|
2111
|
-
responses: {
|
|
2112
|
-
/** @description Schedule deleted */
|
|
2113
|
-
204: {
|
|
2114
|
-
headers: {
|
|
2115
|
-
[name: string]: unknown;
|
|
2116
|
-
};
|
|
2117
|
-
content?: never;
|
|
2118
|
-
};
|
|
2119
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
2120
|
-
401: {
|
|
2121
|
-
headers: {
|
|
2122
|
-
[name: string]: unknown;
|
|
2123
|
-
};
|
|
2124
|
-
content: {
|
|
2125
|
-
"text/plain": string;
|
|
2126
|
-
};
|
|
2127
|
-
};
|
|
2128
|
-
/** @description Result not found */
|
|
2129
|
-
404: {
|
|
2130
|
-
headers: {
|
|
2131
|
-
[name: string]: unknown;
|
|
2132
|
-
};
|
|
2133
|
-
content: {
|
|
2134
|
-
"text/plain": string;
|
|
2135
|
-
};
|
|
2136
|
-
};
|
|
2137
|
-
/** @description Internal server error */
|
|
2138
|
-
500: {
|
|
2139
|
-
headers: {
|
|
2140
|
-
[name: string]: unknown;
|
|
2141
|
-
};
|
|
2142
|
-
content: {
|
|
2143
|
-
"text/plain": string;
|
|
2144
|
-
};
|
|
2145
|
-
};
|
|
2146
|
-
};
|
|
2147
|
-
};
|
|
2148
|
-
claimSchedule: {
|
|
2149
|
-
parameters: {
|
|
2150
|
-
query?: never;
|
|
2151
|
-
header?: never;
|
|
2152
|
-
path: {
|
|
2153
|
-
/** @description Schedule ID */
|
|
2154
|
-
scheduleId: string;
|
|
2155
|
-
};
|
|
2156
|
-
cookie?: never;
|
|
2157
|
-
};
|
|
2158
|
-
requestBody: {
|
|
2159
|
-
content: {
|
|
2160
|
-
"application/json": {
|
|
2161
|
-
/** @description Identity of the worker taking the claim. */
|
|
2162
|
-
claimant: string;
|
|
2163
|
-
/** @description Requested claim duration in minutes; the server applies its default when omitted and may cap it. */
|
|
2164
|
-
durationMinutes?: number;
|
|
2165
|
-
/** @description Claim even though the schedule is not yet due (trigger now). A live claim held by another claimant still refuses. */
|
|
2166
|
-
force?: boolean;
|
|
2167
|
-
/** @description Operator override that claims through the organization-wide and per-schedule pauses. */
|
|
2168
|
-
ignorePause?: boolean;
|
|
2169
|
-
};
|
|
2170
|
-
};
|
|
2171
|
-
};
|
|
2172
|
-
responses: {
|
|
2173
|
-
/** @description The claimed schedule */
|
|
2174
|
-
200: {
|
|
2175
|
-
headers: {
|
|
2176
|
-
[name: string]: unknown;
|
|
2177
|
-
};
|
|
2178
|
-
content: {
|
|
2179
|
-
"application/json": {
|
|
2180
|
-
/**
|
|
2181
|
-
* Format: uuid
|
|
2182
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2183
|
-
*/
|
|
2184
|
-
id: string;
|
|
2185
|
-
/**
|
|
2186
|
-
* Format: uuid
|
|
2187
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2188
|
-
*/
|
|
2189
|
-
organizationId: string;
|
|
2190
|
-
/**
|
|
2191
|
-
* Format: uuid
|
|
2192
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2193
|
-
*/
|
|
2194
|
-
workspaceId?: string;
|
|
2195
|
-
/** @description Human-readable name for the schedule. */
|
|
2196
|
-
name: string;
|
|
2197
|
-
/** @description The action the worker runs when it holds the schedule's claim, for example a command name. */
|
|
2198
|
-
action: string;
|
|
2199
|
-
/** @description Action parameters, stored as a JSON blob. */
|
|
2200
|
-
params?: Record<string, never>;
|
|
2201
|
-
/** @description Whether the schedule is eligible to run. A disabled schedule is never claimed. */
|
|
2202
|
-
enabled: boolean;
|
|
2203
|
-
/**
|
|
2204
|
-
* Format: date-time
|
|
2205
|
-
* @description Time the schedule first becomes due.
|
|
2206
|
-
*/
|
|
2207
|
-
runAt?: string | null;
|
|
2208
|
-
/**
|
|
2209
|
-
* Format: date-time
|
|
2210
|
-
* @description Next time a recurring or retrying schedule becomes due.
|
|
2211
|
-
*/
|
|
2212
|
-
nextRunAt?: string | null;
|
|
2213
|
-
/** @description Recurrence rule for repeating schedules. Empty for a run-once schedule. */
|
|
2214
|
-
recurrence?: string;
|
|
2215
|
-
/**
|
|
2216
|
-
* @description Lifecycle status. `pending`: created, not yet due-scheduled.
|
|
2217
|
-
* `scheduled`: waiting for its due time. `assigned`: designated for a
|
|
2218
|
-
* particular worker but not yet claimed. `claimed`: a worker holds the
|
|
2219
|
-
* claim and has not started. `running`: the claim holder is executing
|
|
2220
|
-
* it. `retrying`: the last attempt failed and another is due.
|
|
2221
|
-
* `completed`, `failed` and `cancelled` are terminal for a run-once
|
|
2222
|
-
* schedule; a recurring schedule returns to `scheduled`.
|
|
2223
|
-
* @enum {string}
|
|
2224
|
-
*/
|
|
2225
|
-
status: "pending" | "scheduled" | "assigned" | "claimed" | "running" | "retrying" | "completed" | "failed" | "cancelled";
|
|
2226
|
-
/** @description Attempts already retried for the current run. */
|
|
2227
|
-
retryCount: number;
|
|
2228
|
-
/** @description Maximum retries before the run is marked failed. */
|
|
2229
|
-
maxRetries: number;
|
|
2230
|
-
/** @description Minutes to wait before a retry becomes due. */
|
|
2231
|
-
retryDelayMinutes?: number;
|
|
2232
|
-
/**
|
|
2233
|
-
* Format: date-time
|
|
2234
|
-
* @description Time of the most recent attempt.
|
|
2235
|
-
*/
|
|
2236
|
-
lastRunAt?: string | null;
|
|
2237
|
-
/** @description Error reported by the most recent attempt. */
|
|
2238
|
-
lastError?: string;
|
|
2239
|
-
/**
|
|
2240
|
-
* Claim Schema
|
|
2241
|
-
* @description The schedule's live claim, when one is held. Server-managed; omitted when the schedule is unclaimed.
|
|
2242
|
-
*/
|
|
2243
|
-
claim?: {
|
|
2244
|
-
/**
|
|
2245
|
-
* Format: uuid
|
|
2246
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2247
|
-
*/
|
|
2248
|
-
id: string;
|
|
2249
|
-
/**
|
|
2250
|
-
* Format: uuid
|
|
2251
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2252
|
-
*/
|
|
2253
|
-
organizationId: string;
|
|
2254
|
-
/** @description Type of the claimed resource, for example `schedule`. */
|
|
2255
|
-
resourceType: string;
|
|
2256
|
-
/**
|
|
2257
|
-
* Format: uuid
|
|
2258
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2259
|
-
*/
|
|
2260
|
-
resourceId: string;
|
|
2261
|
-
/** @description Identity of the holder, as asserted by the worker that took the claim (for example a machine and process identifier). */
|
|
2262
|
-
claimant: string;
|
|
2263
|
-
/**
|
|
2264
|
-
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
2265
|
-
* @enum {string}
|
|
2266
|
-
*/
|
|
2267
|
-
status: "active" | "released" | "expired";
|
|
2268
|
-
/**
|
|
2269
|
-
* Format: date-time
|
|
2270
|
-
* @description Time the claim was taken.
|
|
2271
|
-
*/
|
|
2272
|
-
claimedAt: string;
|
|
2273
|
-
/**
|
|
2274
|
-
* Format: date-time
|
|
2275
|
-
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
2276
|
-
*/
|
|
2277
|
-
expiresAt: string;
|
|
2278
|
-
/**
|
|
2279
|
-
* Format: date-time
|
|
2280
|
-
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
2281
|
-
*/
|
|
2282
|
-
releasedAt?: string | null;
|
|
2283
|
-
/**
|
|
2284
|
-
* Format: date-time
|
|
2285
|
-
* @description Timestamp of claim creation.
|
|
2286
|
-
*/
|
|
2287
|
-
createdAt: string;
|
|
2288
|
-
/**
|
|
2289
|
-
* Format: date-time
|
|
2290
|
-
* @description Timestamp of last claim modification.
|
|
2291
|
-
*/
|
|
2292
|
-
updatedAt: string;
|
|
2293
|
-
};
|
|
2294
|
-
/**
|
|
2295
|
-
* Format: date-time
|
|
2296
|
-
* @description Time the schedule was paused. Null when the schedule is not paused. Server-managed.
|
|
2297
|
-
*/
|
|
2298
|
-
pausedAt?: string | null;
|
|
2299
|
-
/** @description Identity that paused the schedule. Server-managed. */
|
|
2300
|
-
pausedBy?: string;
|
|
2301
|
-
/** @description Reason given for pausing the schedule. Server-managed. */
|
|
2302
|
-
pauseReason?: string;
|
|
2303
|
-
/**
|
|
2304
|
-
* Format: date-time
|
|
2305
|
-
* @description Timestamp of schedule creation.
|
|
2306
|
-
*/
|
|
2307
|
-
createdAt: string;
|
|
2308
|
-
/**
|
|
2309
|
-
* Format: date-time
|
|
2310
|
-
* @description Timestamp of last schedule modification.
|
|
2311
|
-
*/
|
|
2312
|
-
updatedAt: string;
|
|
2313
|
-
/**
|
|
2314
|
-
* Format: date-time
|
|
2315
|
-
* @description Timestamp when the schedule was soft-deleted. Null while live.
|
|
2316
|
-
*/
|
|
2317
|
-
deletedAt?: string | null;
|
|
2318
|
-
};
|
|
2319
|
-
};
|
|
2320
|
-
};
|
|
2321
|
-
/** @description Invalid request body or request param */
|
|
2322
|
-
400: {
|
|
2323
|
-
headers: {
|
|
2324
|
-
[name: string]: unknown;
|
|
2325
|
-
};
|
|
2326
|
-
content: {
|
|
2327
|
-
"text/plain": string;
|
|
2328
|
-
};
|
|
2329
|
-
};
|
|
2330
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
2331
|
-
401: {
|
|
2332
|
-
headers: {
|
|
2333
|
-
[name: string]: unknown;
|
|
2334
|
-
};
|
|
2335
|
-
content: {
|
|
2336
|
-
"text/plain": string;
|
|
2337
|
-
};
|
|
2338
|
-
};
|
|
2339
|
-
/** @description Result not found */
|
|
2340
|
-
404: {
|
|
2341
|
-
headers: {
|
|
2342
|
-
[name: string]: unknown;
|
|
2343
|
-
};
|
|
2344
|
-
content: {
|
|
2345
|
-
"text/plain": string;
|
|
2346
|
-
};
|
|
2347
|
-
};
|
|
2348
|
-
/** @description Conflict - the schedule is held by another claimant's live claim, or the caller is not the holder of the claim it tried to renew or release */
|
|
2349
|
-
409: {
|
|
2350
|
-
headers: {
|
|
2351
|
-
[name: string]: unknown;
|
|
2352
|
-
};
|
|
2353
|
-
content: {
|
|
2354
|
-
"text/plain": string;
|
|
2355
|
-
};
|
|
2356
|
-
};
|
|
2357
|
-
/** @description Internal server error */
|
|
2358
|
-
500: {
|
|
2359
|
-
headers: {
|
|
2360
|
-
[name: string]: unknown;
|
|
2361
|
-
};
|
|
2362
|
-
content: {
|
|
2363
|
-
"text/plain": string;
|
|
2364
|
-
};
|
|
2365
|
-
};
|
|
2366
|
-
};
|
|
2367
|
-
};
|
|
2368
|
-
renewScheduleClaim: {
|
|
2369
|
-
parameters: {
|
|
2370
|
-
query?: never;
|
|
2371
|
-
header?: never;
|
|
2372
|
-
path: {
|
|
2373
|
-
/** @description Schedule ID */
|
|
2374
|
-
scheduleId: string;
|
|
2375
|
-
};
|
|
2376
|
-
cookie?: never;
|
|
2377
|
-
};
|
|
2378
|
-
requestBody: {
|
|
2379
|
-
content: {
|
|
2380
|
-
"application/json": {
|
|
2381
|
-
/** @description Identity of the holder renewing the claim. */
|
|
2382
|
-
claimant: string;
|
|
2383
|
-
/** @description Requested extension in minutes from now; the server applies its default when omitted and may cap it. */
|
|
2384
|
-
durationMinutes?: number;
|
|
2385
|
-
};
|
|
2386
|
-
};
|
|
2387
|
-
};
|
|
2388
|
-
responses: {
|
|
2389
|
-
/** @description The schedule with its renewed claim */
|
|
2390
|
-
200: {
|
|
2391
|
-
headers: {
|
|
2392
|
-
[name: string]: unknown;
|
|
2393
|
-
};
|
|
2394
|
-
content: {
|
|
2395
|
-
"application/json": {
|
|
2396
|
-
/**
|
|
2397
|
-
* Format: uuid
|
|
2398
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2399
|
-
*/
|
|
2400
|
-
id: string;
|
|
2401
|
-
/**
|
|
2402
|
-
* Format: uuid
|
|
2403
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2404
|
-
*/
|
|
2405
|
-
organizationId: string;
|
|
2406
|
-
/**
|
|
2407
|
-
* Format: uuid
|
|
2408
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1624
|
+
* Format: uuid
|
|
1625
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
2409
1626
|
*/
|
|
2410
1627
|
workspaceId?: string;
|
|
2411
1628
|
/** @description Human-readable name for the schedule. */
|
|
@@ -2514,7 +1731,7 @@ export interface operations {
|
|
|
2514
1731
|
pausedAt?: string | null;
|
|
2515
1732
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
2516
1733
|
pausedBy?: string;
|
|
2517
|
-
/** @description Reason given for pausing the schedule.
|
|
1734
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
2518
1735
|
pauseReason?: string;
|
|
2519
1736
|
/**
|
|
2520
1737
|
* Format: date-time
|
|
@@ -2561,8 +1778,47 @@ export interface operations {
|
|
|
2561
1778
|
"text/plain": string;
|
|
2562
1779
|
};
|
|
2563
1780
|
};
|
|
2564
|
-
/** @description
|
|
2565
|
-
|
|
1781
|
+
/** @description Internal server error */
|
|
1782
|
+
500: {
|
|
1783
|
+
headers: {
|
|
1784
|
+
[name: string]: unknown;
|
|
1785
|
+
};
|
|
1786
|
+
content: {
|
|
1787
|
+
"text/plain": string;
|
|
1788
|
+
};
|
|
1789
|
+
};
|
|
1790
|
+
};
|
|
1791
|
+
};
|
|
1792
|
+
deleteScheduleById: {
|
|
1793
|
+
parameters: {
|
|
1794
|
+
query?: never;
|
|
1795
|
+
header?: never;
|
|
1796
|
+
path: {
|
|
1797
|
+
/** @description Schedule ID */
|
|
1798
|
+
scheduleId: string;
|
|
1799
|
+
};
|
|
1800
|
+
cookie?: never;
|
|
1801
|
+
};
|
|
1802
|
+
requestBody?: never;
|
|
1803
|
+
responses: {
|
|
1804
|
+
/** @description Schedule deleted */
|
|
1805
|
+
204: {
|
|
1806
|
+
headers: {
|
|
1807
|
+
[name: string]: unknown;
|
|
1808
|
+
};
|
|
1809
|
+
content?: never;
|
|
1810
|
+
};
|
|
1811
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1812
|
+
401: {
|
|
1813
|
+
headers: {
|
|
1814
|
+
[name: string]: unknown;
|
|
1815
|
+
};
|
|
1816
|
+
content: {
|
|
1817
|
+
"text/plain": string;
|
|
1818
|
+
};
|
|
1819
|
+
};
|
|
1820
|
+
/** @description Result not found */
|
|
1821
|
+
404: {
|
|
2566
1822
|
headers: {
|
|
2567
1823
|
[name: string]: unknown;
|
|
2568
1824
|
};
|
|
@@ -2581,7 +1837,7 @@ export interface operations {
|
|
|
2581
1837
|
};
|
|
2582
1838
|
};
|
|
2583
1839
|
};
|
|
2584
|
-
|
|
1840
|
+
claimSchedule: {
|
|
2585
1841
|
parameters: {
|
|
2586
1842
|
query?: never;
|
|
2587
1843
|
header?: never;
|
|
@@ -2594,32 +1850,19 @@ export interface operations {
|
|
|
2594
1850
|
requestBody: {
|
|
2595
1851
|
content: {
|
|
2596
1852
|
"application/json": {
|
|
2597
|
-
/** @description Identity of the
|
|
1853
|
+
/** @description Identity of the worker taking the claim. */
|
|
2598
1854
|
claimant: string;
|
|
2599
|
-
/**
|
|
2600
|
-
|
|
2601
|
-
|
|
2602
|
-
|
|
2603
|
-
|
|
2604
|
-
|
|
2605
|
-
* Format: date-time
|
|
2606
|
-
* @description Time of the attempt being reported.
|
|
2607
|
-
*/
|
|
2608
|
-
lastRunAt?: string | null;
|
|
2609
|
-
/** @description Error reported by the attempt; empty on success. */
|
|
2610
|
-
lastError?: string;
|
|
2611
|
-
/**
|
|
2612
|
-
* Format: date-time
|
|
2613
|
-
* @description Next due time for a recurring or retrying schedule.
|
|
2614
|
-
*/
|
|
2615
|
-
nextRunAt?: string | null;
|
|
2616
|
-
/** @description Retries used so far for the current run. */
|
|
2617
|
-
retryCount?: number;
|
|
1855
|
+
/** @description Requested claim duration in minutes; the server applies its default when omitted and may cap it. */
|
|
1856
|
+
durationMinutes?: number;
|
|
1857
|
+
/** @description Claim even though the schedule is not yet due (trigger now). A live claim held by another claimant still refuses. */
|
|
1858
|
+
force?: boolean;
|
|
1859
|
+
/** @description Operator override that claims through the organization-wide and per-schedule pauses. */
|
|
1860
|
+
ignorePause?: boolean;
|
|
2618
1861
|
};
|
|
2619
1862
|
};
|
|
2620
1863
|
};
|
|
2621
1864
|
responses: {
|
|
2622
|
-
/** @description The
|
|
1865
|
+
/** @description The claimed schedule */
|
|
2623
1866
|
200: {
|
|
2624
1867
|
headers: {
|
|
2625
1868
|
[name: string]: unknown;
|
|
@@ -2747,7 +1990,7 @@ export interface operations {
|
|
|
2747
1990
|
pausedAt?: string | null;
|
|
2748
1991
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
2749
1992
|
pausedBy?: string;
|
|
2750
|
-
/** @description Reason given for pausing the schedule.
|
|
1993
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
2751
1994
|
pauseReason?: string;
|
|
2752
1995
|
/**
|
|
2753
1996
|
* Format: date-time
|
|
@@ -2814,7 +2057,7 @@ export interface operations {
|
|
|
2814
2057
|
};
|
|
2815
2058
|
};
|
|
2816
2059
|
};
|
|
2817
|
-
|
|
2060
|
+
renewScheduleClaim: {
|
|
2818
2061
|
parameters: {
|
|
2819
2062
|
query?: never;
|
|
2820
2063
|
header?: never;
|
|
@@ -2827,15 +2070,15 @@ export interface operations {
|
|
|
2827
2070
|
requestBody: {
|
|
2828
2071
|
content: {
|
|
2829
2072
|
"application/json": {
|
|
2830
|
-
/** @description Identity
|
|
2831
|
-
|
|
2832
|
-
/** @description
|
|
2833
|
-
|
|
2073
|
+
/** @description Identity of the holder renewing the claim. */
|
|
2074
|
+
claimant: string;
|
|
2075
|
+
/** @description Requested extension in minutes from now; the server applies its default when omitted and may cap it. */
|
|
2076
|
+
durationMinutes?: number;
|
|
2834
2077
|
};
|
|
2835
2078
|
};
|
|
2836
2079
|
};
|
|
2837
2080
|
responses: {
|
|
2838
|
-
/** @description The
|
|
2081
|
+
/** @description The schedule with its renewed claim */
|
|
2839
2082
|
200: {
|
|
2840
2083
|
headers: {
|
|
2841
2084
|
[name: string]: unknown;
|
|
@@ -2963,7 +2206,7 @@ export interface operations {
|
|
|
2963
2206
|
pausedAt?: string | null;
|
|
2964
2207
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
2965
2208
|
pausedBy?: string;
|
|
2966
|
-
/** @description Reason given for pausing the schedule.
|
|
2209
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
2967
2210
|
pauseReason?: string;
|
|
2968
2211
|
/**
|
|
2969
2212
|
* Format: date-time
|
|
@@ -3010,6 +2253,15 @@ export interface operations {
|
|
|
3010
2253
|
"text/plain": string;
|
|
3011
2254
|
};
|
|
3012
2255
|
};
|
|
2256
|
+
/** @description Conflict - the schedule is held by another claimant's live claim, or the caller is not the holder of the claim it tried to renew or release */
|
|
2257
|
+
409: {
|
|
2258
|
+
headers: {
|
|
2259
|
+
[name: string]: unknown;
|
|
2260
|
+
};
|
|
2261
|
+
content: {
|
|
2262
|
+
"text/plain": string;
|
|
2263
|
+
};
|
|
2264
|
+
};
|
|
3013
2265
|
/** @description Internal server error */
|
|
3014
2266
|
500: {
|
|
3015
2267
|
headers: {
|
|
@@ -3021,7 +2273,7 @@ export interface operations {
|
|
|
3021
2273
|
};
|
|
3022
2274
|
};
|
|
3023
2275
|
};
|
|
3024
|
-
|
|
2276
|
+
releaseScheduleClaim: {
|
|
3025
2277
|
parameters: {
|
|
3026
2278
|
query?: never;
|
|
3027
2279
|
header?: never;
|
|
@@ -3031,9 +2283,35 @@ export interface operations {
|
|
|
3031
2283
|
};
|
|
3032
2284
|
cookie?: never;
|
|
3033
2285
|
};
|
|
3034
|
-
requestBody
|
|
2286
|
+
requestBody: {
|
|
2287
|
+
content: {
|
|
2288
|
+
"application/json": {
|
|
2289
|
+
/** @description Identity of the holder releasing the claim. */
|
|
2290
|
+
claimant: string;
|
|
2291
|
+
/**
|
|
2292
|
+
* @description Outcome status to record with the release.
|
|
2293
|
+
* @enum {string}
|
|
2294
|
+
*/
|
|
2295
|
+
status?: "scheduled" | "retrying" | "completed" | "failed" | "cancelled";
|
|
2296
|
+
/**
|
|
2297
|
+
* Format: date-time
|
|
2298
|
+
* @description Time of the attempt being reported.
|
|
2299
|
+
*/
|
|
2300
|
+
lastRunAt?: string | null;
|
|
2301
|
+
/** @description Error reported by the attempt; empty on success. */
|
|
2302
|
+
lastError?: string;
|
|
2303
|
+
/**
|
|
2304
|
+
* Format: date-time
|
|
2305
|
+
* @description Next due time for a recurring or retrying schedule.
|
|
2306
|
+
*/
|
|
2307
|
+
nextRunAt?: string | null;
|
|
2308
|
+
/** @description Retries used so far for the current run. */
|
|
2309
|
+
retryCount?: number;
|
|
2310
|
+
};
|
|
2311
|
+
};
|
|
2312
|
+
};
|
|
3035
2313
|
responses: {
|
|
3036
|
-
/** @description The
|
|
2314
|
+
/** @description The released schedule */
|
|
3037
2315
|
200: {
|
|
3038
2316
|
headers: {
|
|
3039
2317
|
[name: string]: unknown;
|
|
@@ -3161,7 +2439,7 @@ export interface operations {
|
|
|
3161
2439
|
pausedAt?: string | null;
|
|
3162
2440
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
3163
2441
|
pausedBy?: string;
|
|
3164
|
-
/** @description Reason given for pausing the schedule.
|
|
2442
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
3165
2443
|
pauseReason?: string;
|
|
3166
2444
|
/**
|
|
3167
2445
|
* Format: date-time
|
|
@@ -3181,6 +2459,15 @@ export interface operations {
|
|
|
3181
2459
|
};
|
|
3182
2460
|
};
|
|
3183
2461
|
};
|
|
2462
|
+
/** @description Invalid request body or request param */
|
|
2463
|
+
400: {
|
|
2464
|
+
headers: {
|
|
2465
|
+
[name: string]: unknown;
|
|
2466
|
+
};
|
|
2467
|
+
content: {
|
|
2468
|
+
"text/plain": string;
|
|
2469
|
+
};
|
|
2470
|
+
};
|
|
3184
2471
|
/** @description Expired JWT token used or insufficient privilege */
|
|
3185
2472
|
401: {
|
|
3186
2473
|
headers: {
|
|
@@ -3199,6 +2486,15 @@ export interface operations {
|
|
|
3199
2486
|
"text/plain": string;
|
|
3200
2487
|
};
|
|
3201
2488
|
};
|
|
2489
|
+
/** @description Conflict - the schedule is held by another claimant's live claim, or the caller is not the holder of the claim it tried to renew or release */
|
|
2490
|
+
409: {
|
|
2491
|
+
headers: {
|
|
2492
|
+
[name: string]: unknown;
|
|
2493
|
+
};
|
|
2494
|
+
content: {
|
|
2495
|
+
"text/plain": string;
|
|
2496
|
+
};
|
|
2497
|
+
};
|
|
3202
2498
|
/** @description Internal server error */
|
|
3203
2499
|
500: {
|
|
3204
2500
|
headers: {
|
|
@@ -3369,7 +2665,7 @@ export interface operations {
|
|
|
3369
2665
|
pausedAt?: string | null;
|
|
3370
2666
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
3371
2667
|
pausedBy?: string;
|
|
3372
|
-
/** @description Reason given for pausing the schedule.
|
|
2668
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
3373
2669
|
pauseReason?: string;
|
|
3374
2670
|
/**
|
|
3375
2671
|
* Format: date-time
|
|
@@ -3561,7 +2857,7 @@ export interface operations {
|
|
|
3561
2857
|
pausedAt?: string | null;
|
|
3562
2858
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
3563
2859
|
pausedBy?: string;
|
|
3564
|
-
/** @description Reason given for pausing the schedule.
|
|
2860
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
3565
2861
|
pauseReason?: string;
|
|
3566
2862
|
/**
|
|
3567
2863
|
* Format: date-time
|
|
@@ -3752,7 +3048,7 @@ export interface operations {
|
|
|
3752
3048
|
pausedAt?: string | null;
|
|
3753
3049
|
/** @description Identity that paused the schedule. Server-managed. */
|
|
3754
3050
|
pausedBy?: string;
|
|
3755
|
-
/** @description Reason given for pausing the schedule.
|
|
3051
|
+
/** @description Reason given for pausing the schedule, set with `paused` on create or update. Empty when not paused. */
|
|
3756
3052
|
pauseReason?: string;
|
|
3757
3053
|
/**
|
|
3758
3054
|
* Format: date-time
|