@meshery/schemas 1.3.72 → 1.3.73
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 +23587 -20833
- package/dist/cloudApi.d.ts +23587 -20833
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +4 -0
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.js +7 -4
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.mjs +7 -4
- package/dist/constructs/v1beta3/academy/Academy.d.ts +9 -9
- package/dist/constructs/v1beta3/academy/AcademySchema.js +2 -2
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +2 -2
- package/dist/constructs/v1beta3/claim/Claim.d.ts +919 -0
- package/dist/constructs/v1beta3/claim/ClaimSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/claim/ClaimSchema.js +88 -0
- package/dist/constructs/v1beta3/claim/ClaimSchema.mjs +88 -0
- package/dist/constructs/v1beta3/connection/Connection.d.ts +5 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/{blowhorn_content/BlowhornContent.d.ts → content_piece/ContentPiece.d.ts} +101 -83
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.js +48 -0
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.mjs +48 -0
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +33 -33
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +3804 -0
- package/dist/constructs/v1beta3/schedule/Schedule.js +1 -0
- package/dist/constructs/v1beta3/schedule/Schedule.mjs +0 -0
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +61 -0
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +61 -0
- package/dist/index.d.mts +17 -1
- package/dist/index.d.ts +17 -1
- package/dist/index.js +2 -2
- package/dist/index.mjs +2 -2
- package/package.json +1 -1
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.d.ts +0 -2
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.js +0 -43
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.mjs +0 -43
- package/dist/constructs/v1beta3/job_lease/JobLease.d.ts +0 -2570
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.d.ts +0 -2
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.js +0 -83
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.mjs +0 -83
- /package/dist/constructs/v1beta3/{blowhorn_content/BlowhornContent.js → claim/Claim.js} +0 -0
- /package/dist/constructs/v1beta3/{blowhorn_content/BlowhornContent.mjs → claim/Claim.mjs} +0 -0
- /package/dist/constructs/v1beta3/{job_lease/JobLease.js → content_piece/ContentPiece.js} +0 -0
- /package/dist/constructs/v1beta3/{job_lease/JobLease.mjs → content_piece/ContentPiece.mjs} +0 -0
|
@@ -0,0 +1,919 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/api/claims": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
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.
|
|
17
|
+
*/
|
|
18
|
+
get: operations["listClaims"];
|
|
19
|
+
put?: never;
|
|
20
|
+
/**
|
|
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.
|
|
27
|
+
*/
|
|
28
|
+
post: operations["createClaim"];
|
|
29
|
+
delete?: never;
|
|
30
|
+
options?: never;
|
|
31
|
+
head?: never;
|
|
32
|
+
patch?: never;
|
|
33
|
+
trace?: never;
|
|
34
|
+
};
|
|
35
|
+
"/api/claims/{claimId}": {
|
|
36
|
+
parameters: {
|
|
37
|
+
query?: never;
|
|
38
|
+
header?: never;
|
|
39
|
+
path?: never;
|
|
40
|
+
cookie?: never;
|
|
41
|
+
};
|
|
42
|
+
/** Get a claim by ID */
|
|
43
|
+
get: operations["getClaim"];
|
|
44
|
+
put?: never;
|
|
45
|
+
post?: never;
|
|
46
|
+
delete?: never;
|
|
47
|
+
options?: never;
|
|
48
|
+
head?: never;
|
|
49
|
+
patch?: never;
|
|
50
|
+
trace?: never;
|
|
51
|
+
};
|
|
52
|
+
"/api/claims/{claimId}/renew": {
|
|
53
|
+
parameters: {
|
|
54
|
+
query?: never;
|
|
55
|
+
header?: never;
|
|
56
|
+
path?: never;
|
|
57
|
+
cookie?: never;
|
|
58
|
+
};
|
|
59
|
+
get?: never;
|
|
60
|
+
put?: never;
|
|
61
|
+
/**
|
|
62
|
+
* 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.
|
|
64
|
+
*/
|
|
65
|
+
post: operations["renewClaim"];
|
|
66
|
+
delete?: never;
|
|
67
|
+
options?: never;
|
|
68
|
+
head?: never;
|
|
69
|
+
patch?: never;
|
|
70
|
+
trace?: never;
|
|
71
|
+
};
|
|
72
|
+
"/api/claims/{claimId}/release": {
|
|
73
|
+
parameters: {
|
|
74
|
+
query?: never;
|
|
75
|
+
header?: never;
|
|
76
|
+
path?: never;
|
|
77
|
+
cookie?: never;
|
|
78
|
+
};
|
|
79
|
+
get?: never;
|
|
80
|
+
put?: never;
|
|
81
|
+
/**
|
|
82
|
+
* 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.
|
|
84
|
+
*/
|
|
85
|
+
post: operations["releaseClaim"];
|
|
86
|
+
delete?: never;
|
|
87
|
+
options?: never;
|
|
88
|
+
head?: never;
|
|
89
|
+
patch?: never;
|
|
90
|
+
trace?: never;
|
|
91
|
+
};
|
|
92
|
+
}
|
|
93
|
+
export type webhooks = Record<string, never>;
|
|
94
|
+
export interface components {
|
|
95
|
+
schemas: {
|
|
96
|
+
/**
|
|
97
|
+
* Claim Schema
|
|
98
|
+
* @description Server-returned claim: a time-bound hold that one claimant takes on one
|
|
99
|
+
* resource so that competing workers never act on it twice. A claim is
|
|
100
|
+
* 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
|
+
*/
|
|
109
|
+
Claim: {
|
|
110
|
+
/**
|
|
111
|
+
* Format: uuid
|
|
112
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
113
|
+
*/
|
|
114
|
+
id: string;
|
|
115
|
+
/**
|
|
116
|
+
* Format: uuid
|
|
117
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
118
|
+
*/
|
|
119
|
+
organizationId: string;
|
|
120
|
+
/** @description Type of the claimed resource, for example `schedule`. */
|
|
121
|
+
resourceType: string;
|
|
122
|
+
/**
|
|
123
|
+
* Format: uuid
|
|
124
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
125
|
+
*/
|
|
126
|
+
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
|
+
/**
|
|
130
|
+
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
131
|
+
* @enum {string}
|
|
132
|
+
*/
|
|
133
|
+
status: "active" | "released" | "expired";
|
|
134
|
+
/**
|
|
135
|
+
* Format: date-time
|
|
136
|
+
* @description Time the claim was taken.
|
|
137
|
+
*/
|
|
138
|
+
claimedAt: string;
|
|
139
|
+
/**
|
|
140
|
+
* Format: date-time
|
|
141
|
+
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
142
|
+
*/
|
|
143
|
+
expiresAt: string;
|
|
144
|
+
/**
|
|
145
|
+
* Format: date-time
|
|
146
|
+
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
147
|
+
*/
|
|
148
|
+
releasedAt?: string | null;
|
|
149
|
+
/**
|
|
150
|
+
* Format: date-time
|
|
151
|
+
* @description Timestamp of claim creation.
|
|
152
|
+
*/
|
|
153
|
+
createdAt: string;
|
|
154
|
+
/**
|
|
155
|
+
* Format: date-time
|
|
156
|
+
* @description Timestamp of last claim modification.
|
|
157
|
+
*/
|
|
158
|
+
updatedAt: string;
|
|
159
|
+
};
|
|
160
|
+
/**
|
|
161
|
+
* @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.
|
|
164
|
+
*/
|
|
165
|
+
ClaimPayload: {
|
|
166
|
+
/** @description Type of the resource to claim, for example `schedule`. */
|
|
167
|
+
resourceType: string;
|
|
168
|
+
/**
|
|
169
|
+
* Format: uuid
|
|
170
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
171
|
+
*/
|
|
172
|
+
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. */
|
|
176
|
+
durationMinutes?: number;
|
|
177
|
+
};
|
|
178
|
+
/** @description Payload for renewing a claim. Only the holder named by `claimant` may renew. */
|
|
179
|
+
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. */
|
|
183
|
+
durationMinutes?: number;
|
|
184
|
+
};
|
|
185
|
+
/** @description Payload for releasing a claim. Only the holder named by `claimant` may release. */
|
|
186
|
+
ClaimReleasePayload: {
|
|
187
|
+
/** @description Identity of the holder releasing the claim. */
|
|
188
|
+
claimant: string;
|
|
189
|
+
};
|
|
190
|
+
/** @description Paginated collection of claims. */
|
|
191
|
+
ClaimPage: {
|
|
192
|
+
/** @description Current page number of the result set. */
|
|
193
|
+
page: number;
|
|
194
|
+
/** @description Number of items per page. */
|
|
195
|
+
pageSize: number;
|
|
196
|
+
/** @description Total number of items available. */
|
|
197
|
+
totalCount: number;
|
|
198
|
+
/** @description Claims included on this page of results. */
|
|
199
|
+
claims: {
|
|
200
|
+
/**
|
|
201
|
+
* Format: uuid
|
|
202
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
203
|
+
*/
|
|
204
|
+
id: string;
|
|
205
|
+
/**
|
|
206
|
+
* Format: uuid
|
|
207
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
208
|
+
*/
|
|
209
|
+
organizationId: string;
|
|
210
|
+
/** @description Type of the claimed resource, for example `schedule`. */
|
|
211
|
+
resourceType: string;
|
|
212
|
+
/**
|
|
213
|
+
* Format: uuid
|
|
214
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
215
|
+
*/
|
|
216
|
+
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
|
+
/**
|
|
220
|
+
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
221
|
+
* @enum {string}
|
|
222
|
+
*/
|
|
223
|
+
status: "active" | "released" | "expired";
|
|
224
|
+
/**
|
|
225
|
+
* Format: date-time
|
|
226
|
+
* @description Time the claim was taken.
|
|
227
|
+
*/
|
|
228
|
+
claimedAt: string;
|
|
229
|
+
/**
|
|
230
|
+
* Format: date-time
|
|
231
|
+
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
232
|
+
*/
|
|
233
|
+
expiresAt: string;
|
|
234
|
+
/**
|
|
235
|
+
* Format: date-time
|
|
236
|
+
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
237
|
+
*/
|
|
238
|
+
releasedAt?: string | null;
|
|
239
|
+
/**
|
|
240
|
+
* Format: date-time
|
|
241
|
+
* @description Timestamp of claim creation.
|
|
242
|
+
*/
|
|
243
|
+
createdAt: string;
|
|
244
|
+
/**
|
|
245
|
+
* Format: date-time
|
|
246
|
+
* @description Timestamp of last claim modification.
|
|
247
|
+
*/
|
|
248
|
+
updatedAt: string;
|
|
249
|
+
}[];
|
|
250
|
+
};
|
|
251
|
+
};
|
|
252
|
+
responses: {
|
|
253
|
+
/** @description Invalid request body or request param */
|
|
254
|
+
400: {
|
|
255
|
+
headers: {
|
|
256
|
+
[name: string]: unknown;
|
|
257
|
+
};
|
|
258
|
+
content: {
|
|
259
|
+
"text/plain": string;
|
|
260
|
+
};
|
|
261
|
+
};
|
|
262
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
263
|
+
401: {
|
|
264
|
+
headers: {
|
|
265
|
+
[name: string]: unknown;
|
|
266
|
+
};
|
|
267
|
+
content: {
|
|
268
|
+
"text/plain": string;
|
|
269
|
+
};
|
|
270
|
+
};
|
|
271
|
+
/** @description Result not found */
|
|
272
|
+
404: {
|
|
273
|
+
headers: {
|
|
274
|
+
[name: string]: unknown;
|
|
275
|
+
};
|
|
276
|
+
content: {
|
|
277
|
+
"text/plain": string;
|
|
278
|
+
};
|
|
279
|
+
};
|
|
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 */
|
|
281
|
+
409: {
|
|
282
|
+
headers: {
|
|
283
|
+
[name: string]: unknown;
|
|
284
|
+
};
|
|
285
|
+
content: {
|
|
286
|
+
"text/plain": string;
|
|
287
|
+
};
|
|
288
|
+
};
|
|
289
|
+
/** @description Internal server error */
|
|
290
|
+
500: {
|
|
291
|
+
headers: {
|
|
292
|
+
[name: string]: unknown;
|
|
293
|
+
};
|
|
294
|
+
content: {
|
|
295
|
+
"text/plain": string;
|
|
296
|
+
};
|
|
297
|
+
};
|
|
298
|
+
};
|
|
299
|
+
parameters: {
|
|
300
|
+
/** @description Claim ID */
|
|
301
|
+
claimId: string;
|
|
302
|
+
/** @description Get responses by page */
|
|
303
|
+
page: number;
|
|
304
|
+
/** @description Number of items per page. */
|
|
305
|
+
pageSize: number;
|
|
306
|
+
/** @description Get ordered responses */
|
|
307
|
+
order: string;
|
|
308
|
+
};
|
|
309
|
+
requestBodies: never;
|
|
310
|
+
headers: never;
|
|
311
|
+
pathItems: never;
|
|
312
|
+
}
|
|
313
|
+
export type $defs = Record<string, never>;
|
|
314
|
+
export interface operations {
|
|
315
|
+
listClaims: {
|
|
316
|
+
parameters: {
|
|
317
|
+
query?: {
|
|
318
|
+
/** @description Get responses by page */
|
|
319
|
+
page?: number;
|
|
320
|
+
/** @description Number of items per page. */
|
|
321
|
+
pageSize?: number;
|
|
322
|
+
/** @description Get ordered responses */
|
|
323
|
+
order?: string;
|
|
324
|
+
/** @description Filter by claimed resource type. */
|
|
325
|
+
resourceType?: string;
|
|
326
|
+
/** @description Filter by claimed resource ID. */
|
|
327
|
+
resourceId?: string;
|
|
328
|
+
/** @description Filter by holder identity. */
|
|
329
|
+
claimant?: string;
|
|
330
|
+
/** @description Filter by claim status. */
|
|
331
|
+
status?: "active" | "released" | "expired";
|
|
332
|
+
};
|
|
333
|
+
header?: never;
|
|
334
|
+
path?: never;
|
|
335
|
+
cookie?: never;
|
|
336
|
+
};
|
|
337
|
+
requestBody?: never;
|
|
338
|
+
responses: {
|
|
339
|
+
/** @description Claims page */
|
|
340
|
+
200: {
|
|
341
|
+
headers: {
|
|
342
|
+
[name: string]: unknown;
|
|
343
|
+
};
|
|
344
|
+
content: {
|
|
345
|
+
"application/json": {
|
|
346
|
+
/** @description Current page number of the result set. */
|
|
347
|
+
page: number;
|
|
348
|
+
/** @description Number of items per page. */
|
|
349
|
+
pageSize: number;
|
|
350
|
+
/** @description Total number of items available. */
|
|
351
|
+
totalCount: number;
|
|
352
|
+
/** @description Claims included on this page of results. */
|
|
353
|
+
claims: {
|
|
354
|
+
/**
|
|
355
|
+
* Format: uuid
|
|
356
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
357
|
+
*/
|
|
358
|
+
id: string;
|
|
359
|
+
/**
|
|
360
|
+
* Format: uuid
|
|
361
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
362
|
+
*/
|
|
363
|
+
organizationId: string;
|
|
364
|
+
/** @description Type of the claimed resource, for example `schedule`. */
|
|
365
|
+
resourceType: string;
|
|
366
|
+
/**
|
|
367
|
+
* Format: uuid
|
|
368
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
369
|
+
*/
|
|
370
|
+
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
|
+
/**
|
|
374
|
+
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
375
|
+
* @enum {string}
|
|
376
|
+
*/
|
|
377
|
+
status: "active" | "released" | "expired";
|
|
378
|
+
/**
|
|
379
|
+
* Format: date-time
|
|
380
|
+
* @description Time the claim was taken.
|
|
381
|
+
*/
|
|
382
|
+
claimedAt: string;
|
|
383
|
+
/**
|
|
384
|
+
* Format: date-time
|
|
385
|
+
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
386
|
+
*/
|
|
387
|
+
expiresAt: string;
|
|
388
|
+
/**
|
|
389
|
+
* Format: date-time
|
|
390
|
+
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
391
|
+
*/
|
|
392
|
+
releasedAt?: string | null;
|
|
393
|
+
/**
|
|
394
|
+
* Format: date-time
|
|
395
|
+
* @description Timestamp of claim creation.
|
|
396
|
+
*/
|
|
397
|
+
createdAt: string;
|
|
398
|
+
/**
|
|
399
|
+
* Format: date-time
|
|
400
|
+
* @description Timestamp of last claim modification.
|
|
401
|
+
*/
|
|
402
|
+
updatedAt: string;
|
|
403
|
+
}[];
|
|
404
|
+
};
|
|
405
|
+
};
|
|
406
|
+
};
|
|
407
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
408
|
+
401: {
|
|
409
|
+
headers: {
|
|
410
|
+
[name: string]: unknown;
|
|
411
|
+
};
|
|
412
|
+
content: {
|
|
413
|
+
"text/plain": string;
|
|
414
|
+
};
|
|
415
|
+
};
|
|
416
|
+
/** @description Result not found */
|
|
417
|
+
404: {
|
|
418
|
+
headers: {
|
|
419
|
+
[name: string]: unknown;
|
|
420
|
+
};
|
|
421
|
+
content: {
|
|
422
|
+
"text/plain": string;
|
|
423
|
+
};
|
|
424
|
+
};
|
|
425
|
+
/** @description Internal server error */
|
|
426
|
+
500: {
|
|
427
|
+
headers: {
|
|
428
|
+
[name: string]: unknown;
|
|
429
|
+
};
|
|
430
|
+
content: {
|
|
431
|
+
"text/plain": string;
|
|
432
|
+
};
|
|
433
|
+
};
|
|
434
|
+
};
|
|
435
|
+
};
|
|
436
|
+
createClaim: {
|
|
437
|
+
parameters: {
|
|
438
|
+
query?: never;
|
|
439
|
+
header?: never;
|
|
440
|
+
path?: never;
|
|
441
|
+
cookie?: never;
|
|
442
|
+
};
|
|
443
|
+
requestBody: {
|
|
444
|
+
content: {
|
|
445
|
+
"application/json": {
|
|
446
|
+
/** @description Type of the resource to claim, for example `schedule`. */
|
|
447
|
+
resourceType: string;
|
|
448
|
+
/**
|
|
449
|
+
* Format: uuid
|
|
450
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
451
|
+
*/
|
|
452
|
+
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. */
|
|
456
|
+
durationMinutes?: number;
|
|
457
|
+
};
|
|
458
|
+
};
|
|
459
|
+
};
|
|
460
|
+
responses: {
|
|
461
|
+
/** @description Claim taken */
|
|
462
|
+
201: {
|
|
463
|
+
headers: {
|
|
464
|
+
[name: string]: unknown;
|
|
465
|
+
};
|
|
466
|
+
content: {
|
|
467
|
+
"application/json": {
|
|
468
|
+
/**
|
|
469
|
+
* Format: uuid
|
|
470
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
471
|
+
*/
|
|
472
|
+
id: string;
|
|
473
|
+
/**
|
|
474
|
+
* Format: uuid
|
|
475
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
476
|
+
*/
|
|
477
|
+
organizationId: string;
|
|
478
|
+
/** @description Type of the claimed resource, for example `schedule`. */
|
|
479
|
+
resourceType: string;
|
|
480
|
+
/**
|
|
481
|
+
* Format: uuid
|
|
482
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
483
|
+
*/
|
|
484
|
+
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
|
+
/**
|
|
488
|
+
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
489
|
+
* @enum {string}
|
|
490
|
+
*/
|
|
491
|
+
status: "active" | "released" | "expired";
|
|
492
|
+
/**
|
|
493
|
+
* Format: date-time
|
|
494
|
+
* @description Time the claim was taken.
|
|
495
|
+
*/
|
|
496
|
+
claimedAt: string;
|
|
497
|
+
/**
|
|
498
|
+
* Format: date-time
|
|
499
|
+
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
500
|
+
*/
|
|
501
|
+
expiresAt: string;
|
|
502
|
+
/**
|
|
503
|
+
* Format: date-time
|
|
504
|
+
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
505
|
+
*/
|
|
506
|
+
releasedAt?: string | null;
|
|
507
|
+
/**
|
|
508
|
+
* Format: date-time
|
|
509
|
+
* @description Timestamp of claim creation.
|
|
510
|
+
*/
|
|
511
|
+
createdAt: string;
|
|
512
|
+
/**
|
|
513
|
+
* Format: date-time
|
|
514
|
+
* @description Timestamp of last claim modification.
|
|
515
|
+
*/
|
|
516
|
+
updatedAt: string;
|
|
517
|
+
};
|
|
518
|
+
};
|
|
519
|
+
};
|
|
520
|
+
/** @description Invalid request body or request param */
|
|
521
|
+
400: {
|
|
522
|
+
headers: {
|
|
523
|
+
[name: string]: unknown;
|
|
524
|
+
};
|
|
525
|
+
content: {
|
|
526
|
+
"text/plain": string;
|
|
527
|
+
};
|
|
528
|
+
};
|
|
529
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
530
|
+
401: {
|
|
531
|
+
headers: {
|
|
532
|
+
[name: string]: unknown;
|
|
533
|
+
};
|
|
534
|
+
content: {
|
|
535
|
+
"text/plain": string;
|
|
536
|
+
};
|
|
537
|
+
};
|
|
538
|
+
/** @description Result not found */
|
|
539
|
+
404: {
|
|
540
|
+
headers: {
|
|
541
|
+
[name: string]: unknown;
|
|
542
|
+
};
|
|
543
|
+
content: {
|
|
544
|
+
"text/plain": string;
|
|
545
|
+
};
|
|
546
|
+
};
|
|
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 */
|
|
548
|
+
409: {
|
|
549
|
+
headers: {
|
|
550
|
+
[name: string]: unknown;
|
|
551
|
+
};
|
|
552
|
+
content: {
|
|
553
|
+
"text/plain": string;
|
|
554
|
+
};
|
|
555
|
+
};
|
|
556
|
+
/** @description Internal server error */
|
|
557
|
+
500: {
|
|
558
|
+
headers: {
|
|
559
|
+
[name: string]: unknown;
|
|
560
|
+
};
|
|
561
|
+
content: {
|
|
562
|
+
"text/plain": string;
|
|
563
|
+
};
|
|
564
|
+
};
|
|
565
|
+
};
|
|
566
|
+
};
|
|
567
|
+
getClaim: {
|
|
568
|
+
parameters: {
|
|
569
|
+
query?: never;
|
|
570
|
+
header?: never;
|
|
571
|
+
path: {
|
|
572
|
+
/** @description Claim ID */
|
|
573
|
+
claimId: string;
|
|
574
|
+
};
|
|
575
|
+
cookie?: never;
|
|
576
|
+
};
|
|
577
|
+
requestBody?: never;
|
|
578
|
+
responses: {
|
|
579
|
+
/** @description Claim response */
|
|
580
|
+
200: {
|
|
581
|
+
headers: {
|
|
582
|
+
[name: string]: unknown;
|
|
583
|
+
};
|
|
584
|
+
content: {
|
|
585
|
+
"application/json": {
|
|
586
|
+
/**
|
|
587
|
+
* Format: uuid
|
|
588
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
589
|
+
*/
|
|
590
|
+
id: string;
|
|
591
|
+
/**
|
|
592
|
+
* Format: uuid
|
|
593
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
594
|
+
*/
|
|
595
|
+
organizationId: string;
|
|
596
|
+
/** @description Type of the claimed resource, for example `schedule`. */
|
|
597
|
+
resourceType: string;
|
|
598
|
+
/**
|
|
599
|
+
* Format: uuid
|
|
600
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
601
|
+
*/
|
|
602
|
+
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
|
+
/**
|
|
606
|
+
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
607
|
+
* @enum {string}
|
|
608
|
+
*/
|
|
609
|
+
status: "active" | "released" | "expired";
|
|
610
|
+
/**
|
|
611
|
+
* Format: date-time
|
|
612
|
+
* @description Time the claim was taken.
|
|
613
|
+
*/
|
|
614
|
+
claimedAt: string;
|
|
615
|
+
/**
|
|
616
|
+
* Format: date-time
|
|
617
|
+
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
618
|
+
*/
|
|
619
|
+
expiresAt: string;
|
|
620
|
+
/**
|
|
621
|
+
* Format: date-time
|
|
622
|
+
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
623
|
+
*/
|
|
624
|
+
releasedAt?: string | null;
|
|
625
|
+
/**
|
|
626
|
+
* Format: date-time
|
|
627
|
+
* @description Timestamp of claim creation.
|
|
628
|
+
*/
|
|
629
|
+
createdAt: string;
|
|
630
|
+
/**
|
|
631
|
+
* Format: date-time
|
|
632
|
+
* @description Timestamp of last claim modification.
|
|
633
|
+
*/
|
|
634
|
+
updatedAt: string;
|
|
635
|
+
};
|
|
636
|
+
};
|
|
637
|
+
};
|
|
638
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
639
|
+
401: {
|
|
640
|
+
headers: {
|
|
641
|
+
[name: string]: unknown;
|
|
642
|
+
};
|
|
643
|
+
content: {
|
|
644
|
+
"text/plain": string;
|
|
645
|
+
};
|
|
646
|
+
};
|
|
647
|
+
/** @description Result not found */
|
|
648
|
+
404: {
|
|
649
|
+
headers: {
|
|
650
|
+
[name: string]: unknown;
|
|
651
|
+
};
|
|
652
|
+
content: {
|
|
653
|
+
"text/plain": string;
|
|
654
|
+
};
|
|
655
|
+
};
|
|
656
|
+
/** @description Internal server error */
|
|
657
|
+
500: {
|
|
658
|
+
headers: {
|
|
659
|
+
[name: string]: unknown;
|
|
660
|
+
};
|
|
661
|
+
content: {
|
|
662
|
+
"text/plain": string;
|
|
663
|
+
};
|
|
664
|
+
};
|
|
665
|
+
};
|
|
666
|
+
};
|
|
667
|
+
renewClaim: {
|
|
668
|
+
parameters: {
|
|
669
|
+
query?: never;
|
|
670
|
+
header?: never;
|
|
671
|
+
path: {
|
|
672
|
+
/** @description Claim ID */
|
|
673
|
+
claimId: string;
|
|
674
|
+
};
|
|
675
|
+
cookie?: never;
|
|
676
|
+
};
|
|
677
|
+
requestBody: {
|
|
678
|
+
content: {
|
|
679
|
+
"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. */
|
|
683
|
+
durationMinutes?: number;
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
};
|
|
687
|
+
responses: {
|
|
688
|
+
/** @description Claim renewed */
|
|
689
|
+
200: {
|
|
690
|
+
headers: {
|
|
691
|
+
[name: string]: unknown;
|
|
692
|
+
};
|
|
693
|
+
content: {
|
|
694
|
+
"application/json": {
|
|
695
|
+
/**
|
|
696
|
+
* Format: uuid
|
|
697
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
698
|
+
*/
|
|
699
|
+
id: string;
|
|
700
|
+
/**
|
|
701
|
+
* Format: uuid
|
|
702
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
703
|
+
*/
|
|
704
|
+
organizationId: string;
|
|
705
|
+
/** @description Type of the claimed resource, for example `schedule`. */
|
|
706
|
+
resourceType: string;
|
|
707
|
+
/**
|
|
708
|
+
* Format: uuid
|
|
709
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
710
|
+
*/
|
|
711
|
+
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
|
+
/**
|
|
715
|
+
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
716
|
+
* @enum {string}
|
|
717
|
+
*/
|
|
718
|
+
status: "active" | "released" | "expired";
|
|
719
|
+
/**
|
|
720
|
+
* Format: date-time
|
|
721
|
+
* @description Time the claim was taken.
|
|
722
|
+
*/
|
|
723
|
+
claimedAt: string;
|
|
724
|
+
/**
|
|
725
|
+
* Format: date-time
|
|
726
|
+
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
727
|
+
*/
|
|
728
|
+
expiresAt: string;
|
|
729
|
+
/**
|
|
730
|
+
* Format: date-time
|
|
731
|
+
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
732
|
+
*/
|
|
733
|
+
releasedAt?: string | null;
|
|
734
|
+
/**
|
|
735
|
+
* Format: date-time
|
|
736
|
+
* @description Timestamp of claim creation.
|
|
737
|
+
*/
|
|
738
|
+
createdAt: string;
|
|
739
|
+
/**
|
|
740
|
+
* Format: date-time
|
|
741
|
+
* @description Timestamp of last claim modification.
|
|
742
|
+
*/
|
|
743
|
+
updatedAt: string;
|
|
744
|
+
};
|
|
745
|
+
};
|
|
746
|
+
};
|
|
747
|
+
/** @description Invalid request body or request param */
|
|
748
|
+
400: {
|
|
749
|
+
headers: {
|
|
750
|
+
[name: string]: unknown;
|
|
751
|
+
};
|
|
752
|
+
content: {
|
|
753
|
+
"text/plain": string;
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
757
|
+
401: {
|
|
758
|
+
headers: {
|
|
759
|
+
[name: string]: unknown;
|
|
760
|
+
};
|
|
761
|
+
content: {
|
|
762
|
+
"text/plain": string;
|
|
763
|
+
};
|
|
764
|
+
};
|
|
765
|
+
/** @description Result not found */
|
|
766
|
+
404: {
|
|
767
|
+
headers: {
|
|
768
|
+
[name: string]: unknown;
|
|
769
|
+
};
|
|
770
|
+
content: {
|
|
771
|
+
"text/plain": string;
|
|
772
|
+
};
|
|
773
|
+
};
|
|
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 */
|
|
775
|
+
409: {
|
|
776
|
+
headers: {
|
|
777
|
+
[name: string]: unknown;
|
|
778
|
+
};
|
|
779
|
+
content: {
|
|
780
|
+
"text/plain": string;
|
|
781
|
+
};
|
|
782
|
+
};
|
|
783
|
+
/** @description Internal server error */
|
|
784
|
+
500: {
|
|
785
|
+
headers: {
|
|
786
|
+
[name: string]: unknown;
|
|
787
|
+
};
|
|
788
|
+
content: {
|
|
789
|
+
"text/plain": string;
|
|
790
|
+
};
|
|
791
|
+
};
|
|
792
|
+
};
|
|
793
|
+
};
|
|
794
|
+
releaseClaim: {
|
|
795
|
+
parameters: {
|
|
796
|
+
query?: never;
|
|
797
|
+
header?: never;
|
|
798
|
+
path: {
|
|
799
|
+
/** @description Claim ID */
|
|
800
|
+
claimId: string;
|
|
801
|
+
};
|
|
802
|
+
cookie?: never;
|
|
803
|
+
};
|
|
804
|
+
requestBody: {
|
|
805
|
+
content: {
|
|
806
|
+
"application/json": {
|
|
807
|
+
/** @description Identity of the holder releasing the claim. */
|
|
808
|
+
claimant: string;
|
|
809
|
+
};
|
|
810
|
+
};
|
|
811
|
+
};
|
|
812
|
+
responses: {
|
|
813
|
+
/** @description Claim released */
|
|
814
|
+
200: {
|
|
815
|
+
headers: {
|
|
816
|
+
[name: string]: unknown;
|
|
817
|
+
};
|
|
818
|
+
content: {
|
|
819
|
+
"application/json": {
|
|
820
|
+
/**
|
|
821
|
+
* Format: uuid
|
|
822
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
823
|
+
*/
|
|
824
|
+
id: string;
|
|
825
|
+
/**
|
|
826
|
+
* Format: uuid
|
|
827
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
828
|
+
*/
|
|
829
|
+
organizationId: string;
|
|
830
|
+
/** @description Type of the claimed resource, for example `schedule`. */
|
|
831
|
+
resourceType: string;
|
|
832
|
+
/**
|
|
833
|
+
* Format: uuid
|
|
834
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
835
|
+
*/
|
|
836
|
+
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
|
+
/**
|
|
840
|
+
* @description Lifecycle of the claim. `active` while held, `released` once the holder lets it go, `expired` once `expiresAt` passed without a renewal.
|
|
841
|
+
* @enum {string}
|
|
842
|
+
*/
|
|
843
|
+
status: "active" | "released" | "expired";
|
|
844
|
+
/**
|
|
845
|
+
* Format: date-time
|
|
846
|
+
* @description Time the claim was taken.
|
|
847
|
+
*/
|
|
848
|
+
claimedAt: string;
|
|
849
|
+
/**
|
|
850
|
+
* Format: date-time
|
|
851
|
+
* @description Time the claim lapses unless the holder renews it. Always set by the server; a claim past this time is stale.
|
|
852
|
+
*/
|
|
853
|
+
expiresAt: string;
|
|
854
|
+
/**
|
|
855
|
+
* Format: date-time
|
|
856
|
+
* @description Time the holder released the claim. Null while the claim is active or after it expired.
|
|
857
|
+
*/
|
|
858
|
+
releasedAt?: string | null;
|
|
859
|
+
/**
|
|
860
|
+
* Format: date-time
|
|
861
|
+
* @description Timestamp of claim creation.
|
|
862
|
+
*/
|
|
863
|
+
createdAt: string;
|
|
864
|
+
/**
|
|
865
|
+
* Format: date-time
|
|
866
|
+
* @description Timestamp of last claim modification.
|
|
867
|
+
*/
|
|
868
|
+
updatedAt: string;
|
|
869
|
+
};
|
|
870
|
+
};
|
|
871
|
+
};
|
|
872
|
+
/** @description Invalid request body or request param */
|
|
873
|
+
400: {
|
|
874
|
+
headers: {
|
|
875
|
+
[name: string]: unknown;
|
|
876
|
+
};
|
|
877
|
+
content: {
|
|
878
|
+
"text/plain": string;
|
|
879
|
+
};
|
|
880
|
+
};
|
|
881
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
882
|
+
401: {
|
|
883
|
+
headers: {
|
|
884
|
+
[name: string]: unknown;
|
|
885
|
+
};
|
|
886
|
+
content: {
|
|
887
|
+
"text/plain": string;
|
|
888
|
+
};
|
|
889
|
+
};
|
|
890
|
+
/** @description Result not found */
|
|
891
|
+
404: {
|
|
892
|
+
headers: {
|
|
893
|
+
[name: string]: unknown;
|
|
894
|
+
};
|
|
895
|
+
content: {
|
|
896
|
+
"text/plain": string;
|
|
897
|
+
};
|
|
898
|
+
};
|
|
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 */
|
|
900
|
+
409: {
|
|
901
|
+
headers: {
|
|
902
|
+
[name: string]: unknown;
|
|
903
|
+
};
|
|
904
|
+
content: {
|
|
905
|
+
"text/plain": string;
|
|
906
|
+
};
|
|
907
|
+
};
|
|
908
|
+
/** @description Internal server error */
|
|
909
|
+
500: {
|
|
910
|
+
headers: {
|
|
911
|
+
[name: string]: unknown;
|
|
912
|
+
};
|
|
913
|
+
content: {
|
|
914
|
+
"text/plain": string;
|
|
915
|
+
};
|
|
916
|
+
};
|
|
917
|
+
};
|
|
918
|
+
};
|
|
919
|
+
}
|