@meshery/schemas 1.2.21 → 1.2.23
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 +1728 -1527
- package/dist/cloudApi.d.ts +1728 -1527
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6537 -5918
- package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
- package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
- package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
- package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
- package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
- package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
- package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
- package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
- package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
- package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
- package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
- package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
- package/dist/constructs/v1beta1/role/RoleSchema.js +1 -1
- package/dist/constructs/v1beta1/role/RoleSchema.mjs +1 -1
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
- package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
- package/dist/constructs/v1beta1/system/System.d.ts +434 -0
- package/dist/constructs/v1beta1/system/System.js +1 -0
- package/dist/constructs/v1beta1/system/System.mjs +0 -0
- package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
- package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
- package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta1/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta1/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta1/view/View.d.ts +833 -664
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
- package/dist/constructs/v1beta2/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta2/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
- package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
- package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
- package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
- package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
- package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
- package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
- package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
- package/dist/constructs/v1beta2/role/RoleSchema.js +1 -1
- package/dist/constructs/v1beta2/role/RoleSchema.mjs +1 -1
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
- package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
- package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta2/view/View.d.ts +838 -669
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7844 -7226
- package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
- package/dist/constructs/v1beta3/design/Design.d.ts +5729 -5307
- package/dist/constructs/v1beta3/design/DesignSchema.js +8 -8
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +8 -8
- package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
- package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
- package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
- package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
- package/dist/index.d.mts +5520 -5062
- package/dist/index.d.ts +5520 -5062
- package/dist/mesheryApi.d.mts +1318 -526
- package/dist/mesheryApi.d.ts +1318 -526
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/dist/permissions.d.mts +1 -1
- package/dist/permissions.d.ts +1 -1
- package/package.json +1 -2
|
@@ -4,250 +4,60 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
/** Returns a specific schedule by its ID. */
|
|
15
|
-
get: operations["getSchedule"];
|
|
16
|
-
/** Deletes a schedule by its ID. */
|
|
17
|
-
delete: operations["deleteSchedule"];
|
|
18
|
-
};
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
export interface components {
|
|
22
|
-
schemas: {
|
|
23
|
-
/** @description A schedule defines a recurring cron-based trigger for performance tests or other automated tasks. */
|
|
24
|
-
Schedule: {
|
|
25
|
-
/**
|
|
26
|
-
* Format: uuid
|
|
27
|
-
* @description Unique identifier for the schedule.
|
|
28
|
-
*/
|
|
29
|
-
id?: string;
|
|
30
|
-
/** @description Human-readable name for the schedule. */
|
|
31
|
-
name: string;
|
|
32
|
-
/**
|
|
33
|
-
* Format: uuid
|
|
34
|
-
* @description UUID of the user who owns this schedule.
|
|
35
|
-
*/
|
|
36
|
-
userId: string;
|
|
37
|
-
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
38
|
-
cronExpression: string;
|
|
39
|
-
/**
|
|
40
|
-
* Format: date-time
|
|
41
|
-
* @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
42
|
-
*/
|
|
43
|
-
lastRun?: string;
|
|
44
|
-
/**
|
|
45
|
-
* Format: date-time
|
|
46
|
-
* @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
|
|
47
|
-
*/
|
|
48
|
-
nextRun?: string;
|
|
49
|
-
/**
|
|
50
|
-
* Format: date-time
|
|
51
|
-
* @description Timestamp when the schedule was created.
|
|
52
|
-
*/
|
|
53
|
-
createdAt?: string;
|
|
54
|
-
/**
|
|
55
|
-
* Format: date-time
|
|
56
|
-
* @description Timestamp when the schedule was last updated.
|
|
57
|
-
*/
|
|
58
|
-
updatedAt?: string;
|
|
59
|
-
};
|
|
60
|
-
/** @description Payload for upserting a schedule. Includes only client-settable fields. */
|
|
61
|
-
SchedulePayload: {
|
|
62
|
-
/**
|
|
63
|
-
* Format: uuid
|
|
64
|
-
* @description Existing schedule ID for updates; omit on create.
|
|
65
|
-
*/
|
|
66
|
-
id?: string;
|
|
67
|
-
/** @description Human-readable name for the schedule. */
|
|
68
|
-
name: string;
|
|
69
|
-
/**
|
|
70
|
-
* Format: uuid
|
|
71
|
-
* @description Owner user ID; inferred from the authenticated user when omitted.
|
|
72
|
-
*/
|
|
73
|
-
userId?: string;
|
|
74
|
-
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
75
|
-
cronExpression: string;
|
|
76
|
-
};
|
|
77
|
-
/** @description A paginated list of schedules. */
|
|
78
|
-
SchedulePage: {
|
|
79
|
-
/** @description Current page number (zero-based). */
|
|
80
|
-
page: number;
|
|
81
|
-
/** @description Number of schedules per page. */
|
|
82
|
-
pageSize: number;
|
|
83
|
-
/** @description Total number of schedules across all pages. */
|
|
84
|
-
totalCount: number;
|
|
85
|
-
/** @description The schedules of the schedulepage. */
|
|
86
|
-
schedules: {
|
|
87
|
-
/**
|
|
88
|
-
* Format: uuid
|
|
89
|
-
* @description Unique identifier for the schedule.
|
|
90
|
-
*/
|
|
91
|
-
id?: string;
|
|
92
|
-
/** @description Human-readable name for the schedule. */
|
|
93
|
-
name: string;
|
|
94
|
-
/**
|
|
95
|
-
* Format: uuid
|
|
96
|
-
* @description UUID of the user who owns this schedule.
|
|
97
|
-
*/
|
|
98
|
-
userId: string;
|
|
99
|
-
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
100
|
-
cronExpression: string;
|
|
7
|
+
"/user/schedules": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
101
14
|
/**
|
|
102
|
-
*
|
|
103
|
-
* @description
|
|
15
|
+
* Get schedules
|
|
16
|
+
* @description Returns all schedules for the authenticated user.
|
|
104
17
|
*/
|
|
105
|
-
|
|
18
|
+
get: operations["getSchedules"];
|
|
19
|
+
put?: never;
|
|
106
20
|
/**
|
|
107
|
-
*
|
|
108
|
-
* @description
|
|
21
|
+
* Create or update schedule
|
|
22
|
+
* @description Creates or updates a schedule for the authenticated user.
|
|
109
23
|
*/
|
|
110
|
-
|
|
24
|
+
post: operations["upsertSchedule"];
|
|
25
|
+
delete?: never;
|
|
26
|
+
options?: never;
|
|
27
|
+
head?: never;
|
|
28
|
+
patch?: never;
|
|
29
|
+
trace?: never;
|
|
30
|
+
};
|
|
31
|
+
"/user/schedules/{scheduleId}": {
|
|
32
|
+
parameters: {
|
|
33
|
+
query?: never;
|
|
34
|
+
header?: never;
|
|
35
|
+
path?: never;
|
|
36
|
+
cookie?: never;
|
|
37
|
+
};
|
|
111
38
|
/**
|
|
112
|
-
*
|
|
113
|
-
* @description
|
|
39
|
+
* Get schedule by ID
|
|
40
|
+
* @description Returns a specific schedule by its ID.
|
|
114
41
|
*/
|
|
115
|
-
|
|
42
|
+
get: operations["getSchedule"];
|
|
43
|
+
put?: never;
|
|
44
|
+
post?: never;
|
|
116
45
|
/**
|
|
117
|
-
*
|
|
118
|
-
* @description
|
|
46
|
+
* Delete schedule
|
|
47
|
+
* @description Deletes a schedule by its ID.
|
|
119
48
|
*/
|
|
120
|
-
|
|
121
|
-
|
|
49
|
+
delete: operations["deleteSchedule"];
|
|
50
|
+
options?: never;
|
|
51
|
+
head?: never;
|
|
52
|
+
patch?: never;
|
|
53
|
+
trace?: never;
|
|
122
54
|
};
|
|
123
|
-
};
|
|
124
|
-
responses: {
|
|
125
|
-
/** Invalid request body or request param */
|
|
126
|
-
400: {
|
|
127
|
-
content: {
|
|
128
|
-
"text/plain": string;
|
|
129
|
-
};
|
|
130
|
-
};
|
|
131
|
-
/** Expired JWT token used or insufficient privilege */
|
|
132
|
-
401: {
|
|
133
|
-
content: {
|
|
134
|
-
"text/plain": string;
|
|
135
|
-
};
|
|
136
|
-
};
|
|
137
|
-
/** Result not found */
|
|
138
|
-
404: {
|
|
139
|
-
content: {
|
|
140
|
-
"text/plain": string;
|
|
141
|
-
};
|
|
142
|
-
};
|
|
143
|
-
/** Internal server error */
|
|
144
|
-
500: {
|
|
145
|
-
content: {
|
|
146
|
-
"text/plain": string;
|
|
147
|
-
};
|
|
148
|
-
};
|
|
149
|
-
};
|
|
150
|
-
parameters: {
|
|
151
|
-
/** @description Schedule ID */
|
|
152
|
-
scheduleId: string;
|
|
153
|
-
/** @description Get responses by page */
|
|
154
|
-
page: string;
|
|
155
|
-
/** @description Get responses by page size */
|
|
156
|
-
pageSize: string;
|
|
157
|
-
/** @description Get responses that match search param value */
|
|
158
|
-
search: string;
|
|
159
|
-
/** @description Get ordered responses */
|
|
160
|
-
order: string;
|
|
161
|
-
};
|
|
162
55
|
}
|
|
163
|
-
|
|
164
|
-
export interface
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
query: {
|
|
169
|
-
/** Get responses by page */
|
|
170
|
-
page?: string;
|
|
171
|
-
/** Get responses by page size */
|
|
172
|
-
pageSize?: string;
|
|
173
|
-
/** Get responses that match search param value */
|
|
174
|
-
search?: string;
|
|
175
|
-
/** Get ordered responses */
|
|
176
|
-
order?: string;
|
|
177
|
-
};
|
|
178
|
-
};
|
|
179
|
-
responses: {
|
|
180
|
-
/** Schedules response */
|
|
181
|
-
200: {
|
|
182
|
-
content: {
|
|
183
|
-
"application/json": {
|
|
184
|
-
/** @description Current page number (zero-based). */
|
|
185
|
-
page: number;
|
|
186
|
-
/** @description Number of schedules per page. */
|
|
187
|
-
pageSize: number;
|
|
188
|
-
/** @description Total number of schedules across all pages. */
|
|
189
|
-
totalCount: number;
|
|
190
|
-
/** @description The schedules of the schedulepage. */
|
|
191
|
-
schedules: {
|
|
192
|
-
/**
|
|
193
|
-
* Format: uuid
|
|
194
|
-
* @description Unique identifier for the schedule.
|
|
195
|
-
*/
|
|
196
|
-
id?: string;
|
|
197
|
-
/** @description Human-readable name for the schedule. */
|
|
198
|
-
name: string;
|
|
199
|
-
/**
|
|
200
|
-
* Format: uuid
|
|
201
|
-
* @description UUID of the user who owns this schedule.
|
|
202
|
-
*/
|
|
203
|
-
userId: string;
|
|
204
|
-
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
205
|
-
cronExpression: string;
|
|
206
|
-
/**
|
|
207
|
-
* Format: date-time
|
|
208
|
-
* @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
209
|
-
*/
|
|
210
|
-
lastRun?: string;
|
|
211
|
-
/**
|
|
212
|
-
* Format: date-time
|
|
213
|
-
* @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
|
|
214
|
-
*/
|
|
215
|
-
nextRun?: string;
|
|
216
|
-
/**
|
|
217
|
-
* Format: date-time
|
|
218
|
-
* @description Timestamp when the schedule was created.
|
|
219
|
-
*/
|
|
220
|
-
createdAt?: string;
|
|
221
|
-
/**
|
|
222
|
-
* Format: date-time
|
|
223
|
-
* @description Timestamp when the schedule was last updated.
|
|
224
|
-
*/
|
|
225
|
-
updatedAt?: string;
|
|
226
|
-
}[];
|
|
227
|
-
};
|
|
228
|
-
};
|
|
229
|
-
};
|
|
230
|
-
/** Expired JWT token used or insufficient privilege */
|
|
231
|
-
401: {
|
|
232
|
-
content: {
|
|
233
|
-
"text/plain": string;
|
|
234
|
-
};
|
|
235
|
-
};
|
|
236
|
-
/** Internal server error */
|
|
237
|
-
500: {
|
|
238
|
-
content: {
|
|
239
|
-
"text/plain": string;
|
|
240
|
-
};
|
|
241
|
-
};
|
|
242
|
-
};
|
|
243
|
-
};
|
|
244
|
-
/** Creates or updates a schedule for the authenticated user. */
|
|
245
|
-
upsertSchedule: {
|
|
246
|
-
responses: {
|
|
247
|
-
/** Schedule upserted */
|
|
248
|
-
200: {
|
|
249
|
-
content: {
|
|
250
|
-
"application/json": {
|
|
56
|
+
export type webhooks = Record<string, never>;
|
|
57
|
+
export interface components {
|
|
58
|
+
schemas: {
|
|
59
|
+
/** @description A schedule defines a recurring cron-based trigger for performance tests or other automated tasks. */
|
|
60
|
+
Schedule: {
|
|
251
61
|
/**
|
|
252
62
|
* Format: uuid
|
|
253
63
|
* @description Unique identifier for the schedule.
|
|
@@ -282,150 +92,450 @@ export interface operations {
|
|
|
282
92
|
* @description Timestamp when the schedule was last updated.
|
|
283
93
|
*/
|
|
284
94
|
updatedAt?: string;
|
|
285
|
-
};
|
|
286
95
|
};
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
400: {
|
|
290
|
-
content: {
|
|
291
|
-
"text/plain": string;
|
|
292
|
-
};
|
|
293
|
-
};
|
|
294
|
-
/** Expired JWT token used or insufficient privilege */
|
|
295
|
-
401: {
|
|
296
|
-
content: {
|
|
297
|
-
"text/plain": string;
|
|
298
|
-
};
|
|
299
|
-
};
|
|
300
|
-
/** Internal server error */
|
|
301
|
-
500: {
|
|
302
|
-
content: {
|
|
303
|
-
"text/plain": string;
|
|
304
|
-
};
|
|
305
|
-
};
|
|
306
|
-
};
|
|
307
|
-
requestBody: {
|
|
308
|
-
content: {
|
|
309
|
-
"application/json": {
|
|
310
|
-
/**
|
|
311
|
-
* Format: uuid
|
|
312
|
-
* @description Existing schedule ID for updates; omit on create.
|
|
313
|
-
*/
|
|
314
|
-
id?: string;
|
|
315
|
-
/** @description Human-readable name for the schedule. */
|
|
316
|
-
name: string;
|
|
317
|
-
/**
|
|
318
|
-
* Format: uuid
|
|
319
|
-
* @description Owner user ID; inferred from the authenticated user when omitted.
|
|
320
|
-
*/
|
|
321
|
-
userId?: string;
|
|
322
|
-
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
323
|
-
cronExpression: string;
|
|
324
|
-
};
|
|
325
|
-
};
|
|
326
|
-
};
|
|
327
|
-
};
|
|
328
|
-
/** Returns a specific schedule by its ID. */
|
|
329
|
-
getSchedule: {
|
|
330
|
-
parameters: {
|
|
331
|
-
path: {
|
|
332
|
-
/** Schedule ID */
|
|
333
|
-
scheduleId: string;
|
|
334
|
-
};
|
|
335
|
-
};
|
|
336
|
-
responses: {
|
|
337
|
-
/** Schedule response */
|
|
338
|
-
200: {
|
|
339
|
-
content: {
|
|
340
|
-
"application/json": {
|
|
96
|
+
/** @description Payload for upserting a schedule. Includes only client-settable fields. */
|
|
97
|
+
SchedulePayload: {
|
|
341
98
|
/**
|
|
342
99
|
* Format: uuid
|
|
343
|
-
* @description
|
|
100
|
+
* @description Existing schedule ID for updates; omit on create.
|
|
344
101
|
*/
|
|
345
102
|
id?: string;
|
|
346
103
|
/** @description Human-readable name for the schedule. */
|
|
347
104
|
name: string;
|
|
348
105
|
/**
|
|
349
106
|
* Format: uuid
|
|
350
|
-
* @description
|
|
107
|
+
* @description Owner user ID; inferred from the authenticated user when omitted.
|
|
351
108
|
*/
|
|
352
|
-
userId
|
|
109
|
+
userId?: string;
|
|
353
110
|
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
354
111
|
cronExpression: string;
|
|
355
|
-
/**
|
|
356
|
-
* Format: date-time
|
|
357
|
-
* @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
358
|
-
*/
|
|
359
|
-
lastRun?: string;
|
|
360
|
-
/**
|
|
361
|
-
* Format: date-time
|
|
362
|
-
* @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
|
|
363
|
-
*/
|
|
364
|
-
nextRun?: string;
|
|
365
|
-
/**
|
|
366
|
-
* Format: date-time
|
|
367
|
-
* @description Timestamp when the schedule was created.
|
|
368
|
-
*/
|
|
369
|
-
createdAt?: string;
|
|
370
|
-
/**
|
|
371
|
-
* Format: date-time
|
|
372
|
-
* @description Timestamp when the schedule was last updated.
|
|
373
|
-
*/
|
|
374
|
-
updatedAt?: string;
|
|
375
|
-
};
|
|
376
112
|
};
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
113
|
+
/** @description A paginated list of schedules. */
|
|
114
|
+
SchedulePage: {
|
|
115
|
+
/** @description Current page number (zero-based). */
|
|
116
|
+
page: number;
|
|
117
|
+
/** @description Number of schedules per page. */
|
|
118
|
+
pageSize: number;
|
|
119
|
+
/** @description Total number of schedules across all pages. */
|
|
120
|
+
totalCount: number;
|
|
121
|
+
/** @description The schedules of the schedulepage. */
|
|
122
|
+
schedules: {
|
|
123
|
+
/**
|
|
124
|
+
* Format: uuid
|
|
125
|
+
* @description Unique identifier for the schedule.
|
|
126
|
+
*/
|
|
127
|
+
id?: string;
|
|
128
|
+
/** @description Human-readable name for the schedule. */
|
|
129
|
+
name: string;
|
|
130
|
+
/**
|
|
131
|
+
* Format: uuid
|
|
132
|
+
* @description UUID of the user who owns this schedule.
|
|
133
|
+
*/
|
|
134
|
+
userId: string;
|
|
135
|
+
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
136
|
+
cronExpression: string;
|
|
137
|
+
/**
|
|
138
|
+
* Format: date-time
|
|
139
|
+
* @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
140
|
+
*/
|
|
141
|
+
lastRun?: string;
|
|
142
|
+
/**
|
|
143
|
+
* Format: date-time
|
|
144
|
+
* @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
|
|
145
|
+
*/
|
|
146
|
+
nextRun?: string;
|
|
147
|
+
/**
|
|
148
|
+
* Format: date-time
|
|
149
|
+
* @description Timestamp when the schedule was created.
|
|
150
|
+
*/
|
|
151
|
+
createdAt?: string;
|
|
152
|
+
/**
|
|
153
|
+
* Format: date-time
|
|
154
|
+
* @description Timestamp when the schedule was last updated.
|
|
155
|
+
*/
|
|
156
|
+
updatedAt?: string;
|
|
157
|
+
}[];
|
|
382
158
|
};
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
159
|
+
};
|
|
160
|
+
responses: {
|
|
161
|
+
/** @description Invalid request body or request param */
|
|
162
|
+
400: {
|
|
163
|
+
headers: {
|
|
164
|
+
[name: string]: unknown;
|
|
165
|
+
};
|
|
166
|
+
content: {
|
|
167
|
+
"text/plain": string;
|
|
168
|
+
};
|
|
169
|
+
};
|
|
170
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
171
|
+
401: {
|
|
172
|
+
headers: {
|
|
173
|
+
[name: string]: unknown;
|
|
174
|
+
};
|
|
175
|
+
content: {
|
|
176
|
+
"text/plain": string;
|
|
177
|
+
};
|
|
388
178
|
};
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
179
|
+
/** @description Result not found */
|
|
180
|
+
404: {
|
|
181
|
+
headers: {
|
|
182
|
+
[name: string]: unknown;
|
|
183
|
+
};
|
|
184
|
+
content: {
|
|
185
|
+
"text/plain": string;
|
|
186
|
+
};
|
|
187
|
+
};
|
|
188
|
+
/** @description Internal server error */
|
|
189
|
+
500: {
|
|
190
|
+
headers: {
|
|
191
|
+
[name: string]: unknown;
|
|
192
|
+
};
|
|
193
|
+
content: {
|
|
194
|
+
"text/plain": string;
|
|
195
|
+
};
|
|
394
196
|
};
|
|
395
|
-
};
|
|
396
197
|
};
|
|
397
|
-
};
|
|
398
|
-
/** Deletes a schedule by its ID. */
|
|
399
|
-
deleteSchedule: {
|
|
400
198
|
parameters: {
|
|
401
|
-
|
|
402
|
-
/** Schedule ID */
|
|
199
|
+
/** @description Schedule ID */
|
|
403
200
|
scheduleId: string;
|
|
404
|
-
|
|
201
|
+
/** @description Get responses by page */
|
|
202
|
+
page: string;
|
|
203
|
+
/** @description Get responses by page size */
|
|
204
|
+
pageSize: string;
|
|
205
|
+
/** @description Get responses that match search param value */
|
|
206
|
+
search: string;
|
|
207
|
+
/** @description Get ordered responses */
|
|
208
|
+
order: string;
|
|
405
209
|
};
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
210
|
+
requestBodies: never;
|
|
211
|
+
headers: never;
|
|
212
|
+
pathItems: never;
|
|
213
|
+
}
|
|
214
|
+
export type $defs = Record<string, never>;
|
|
215
|
+
export interface operations {
|
|
216
|
+
getSchedules: {
|
|
217
|
+
parameters: {
|
|
218
|
+
query?: {
|
|
219
|
+
/** @description Get responses by page */
|
|
220
|
+
page?: string;
|
|
221
|
+
/** @description Get responses by page size */
|
|
222
|
+
pageSize?: string;
|
|
223
|
+
/** @description Get responses that match search param value */
|
|
224
|
+
search?: string;
|
|
225
|
+
/** @description Get ordered responses */
|
|
226
|
+
order?: string;
|
|
227
|
+
};
|
|
228
|
+
header?: never;
|
|
229
|
+
path?: never;
|
|
230
|
+
cookie?: never;
|
|
231
|
+
};
|
|
232
|
+
requestBody?: never;
|
|
233
|
+
responses: {
|
|
234
|
+
/** @description Schedules response */
|
|
235
|
+
200: {
|
|
236
|
+
headers: {
|
|
237
|
+
[name: string]: unknown;
|
|
238
|
+
};
|
|
239
|
+
content: {
|
|
240
|
+
"application/json": {
|
|
241
|
+
/** @description Current page number (zero-based). */
|
|
242
|
+
page: number;
|
|
243
|
+
/** @description Number of schedules per page. */
|
|
244
|
+
pageSize: number;
|
|
245
|
+
/** @description Total number of schedules across all pages. */
|
|
246
|
+
totalCount: number;
|
|
247
|
+
/** @description The schedules of the schedulepage. */
|
|
248
|
+
schedules: {
|
|
249
|
+
/**
|
|
250
|
+
* Format: uuid
|
|
251
|
+
* @description Unique identifier for the schedule.
|
|
252
|
+
*/
|
|
253
|
+
id?: string;
|
|
254
|
+
/** @description Human-readable name for the schedule. */
|
|
255
|
+
name: string;
|
|
256
|
+
/**
|
|
257
|
+
* Format: uuid
|
|
258
|
+
* @description UUID of the user who owns this schedule.
|
|
259
|
+
*/
|
|
260
|
+
userId: string;
|
|
261
|
+
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
262
|
+
cronExpression: string;
|
|
263
|
+
/**
|
|
264
|
+
* Format: date-time
|
|
265
|
+
* @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
266
|
+
*/
|
|
267
|
+
lastRun?: string;
|
|
268
|
+
/**
|
|
269
|
+
* Format: date-time
|
|
270
|
+
* @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
|
|
271
|
+
*/
|
|
272
|
+
nextRun?: string;
|
|
273
|
+
/**
|
|
274
|
+
* Format: date-time
|
|
275
|
+
* @description Timestamp when the schedule was created.
|
|
276
|
+
*/
|
|
277
|
+
createdAt?: string;
|
|
278
|
+
/**
|
|
279
|
+
* Format: date-time
|
|
280
|
+
* @description Timestamp when the schedule was last updated.
|
|
281
|
+
*/
|
|
282
|
+
updatedAt?: string;
|
|
283
|
+
}[];
|
|
284
|
+
};
|
|
285
|
+
};
|
|
286
|
+
};
|
|
287
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
288
|
+
401: {
|
|
289
|
+
headers: {
|
|
290
|
+
[name: string]: unknown;
|
|
291
|
+
};
|
|
292
|
+
content: {
|
|
293
|
+
"text/plain": string;
|
|
294
|
+
};
|
|
295
|
+
};
|
|
296
|
+
/** @description Internal server error */
|
|
297
|
+
500: {
|
|
298
|
+
headers: {
|
|
299
|
+
[name: string]: unknown;
|
|
300
|
+
};
|
|
301
|
+
content: {
|
|
302
|
+
"text/plain": string;
|
|
303
|
+
};
|
|
304
|
+
};
|
|
305
|
+
};
|
|
306
|
+
};
|
|
307
|
+
upsertSchedule: {
|
|
308
|
+
parameters: {
|
|
309
|
+
query?: never;
|
|
310
|
+
header?: never;
|
|
311
|
+
path?: never;
|
|
312
|
+
cookie?: never;
|
|
413
313
|
};
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
314
|
+
requestBody: {
|
|
315
|
+
content: {
|
|
316
|
+
"application/json": {
|
|
317
|
+
/**
|
|
318
|
+
* Format: uuid
|
|
319
|
+
* @description Existing schedule ID for updates; omit on create.
|
|
320
|
+
*/
|
|
321
|
+
id?: string;
|
|
322
|
+
/** @description Human-readable name for the schedule. */
|
|
323
|
+
name: string;
|
|
324
|
+
/**
|
|
325
|
+
* Format: uuid
|
|
326
|
+
* @description Owner user ID; inferred from the authenticated user when omitted.
|
|
327
|
+
*/
|
|
328
|
+
userId?: string;
|
|
329
|
+
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
330
|
+
cronExpression: string;
|
|
331
|
+
};
|
|
332
|
+
};
|
|
419
333
|
};
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
334
|
+
responses: {
|
|
335
|
+
/** @description Schedule upserted */
|
|
336
|
+
200: {
|
|
337
|
+
headers: {
|
|
338
|
+
[name: string]: unknown;
|
|
339
|
+
};
|
|
340
|
+
content: {
|
|
341
|
+
"application/json": {
|
|
342
|
+
/**
|
|
343
|
+
* Format: uuid
|
|
344
|
+
* @description Unique identifier for the schedule.
|
|
345
|
+
*/
|
|
346
|
+
id?: string;
|
|
347
|
+
/** @description Human-readable name for the schedule. */
|
|
348
|
+
name: string;
|
|
349
|
+
/**
|
|
350
|
+
* Format: uuid
|
|
351
|
+
* @description UUID of the user who owns this schedule.
|
|
352
|
+
*/
|
|
353
|
+
userId: string;
|
|
354
|
+
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
355
|
+
cronExpression: string;
|
|
356
|
+
/**
|
|
357
|
+
* Format: date-time
|
|
358
|
+
* @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
359
|
+
*/
|
|
360
|
+
lastRun?: string;
|
|
361
|
+
/**
|
|
362
|
+
* Format: date-time
|
|
363
|
+
* @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
|
|
364
|
+
*/
|
|
365
|
+
nextRun?: string;
|
|
366
|
+
/**
|
|
367
|
+
* Format: date-time
|
|
368
|
+
* @description Timestamp when the schedule was created.
|
|
369
|
+
*/
|
|
370
|
+
createdAt?: string;
|
|
371
|
+
/**
|
|
372
|
+
* Format: date-time
|
|
373
|
+
* @description Timestamp when the schedule was last updated.
|
|
374
|
+
*/
|
|
375
|
+
updatedAt?: string;
|
|
376
|
+
};
|
|
377
|
+
};
|
|
378
|
+
};
|
|
379
|
+
/** @description Invalid request body or request param */
|
|
380
|
+
400: {
|
|
381
|
+
headers: {
|
|
382
|
+
[name: string]: unknown;
|
|
383
|
+
};
|
|
384
|
+
content: {
|
|
385
|
+
"text/plain": string;
|
|
386
|
+
};
|
|
387
|
+
};
|
|
388
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
389
|
+
401: {
|
|
390
|
+
headers: {
|
|
391
|
+
[name: string]: unknown;
|
|
392
|
+
};
|
|
393
|
+
content: {
|
|
394
|
+
"text/plain": string;
|
|
395
|
+
};
|
|
396
|
+
};
|
|
397
|
+
/** @description Internal server error */
|
|
398
|
+
500: {
|
|
399
|
+
headers: {
|
|
400
|
+
[name: string]: unknown;
|
|
401
|
+
};
|
|
402
|
+
content: {
|
|
403
|
+
"text/plain": string;
|
|
404
|
+
};
|
|
405
|
+
};
|
|
406
|
+
};
|
|
407
|
+
};
|
|
408
|
+
getSchedule: {
|
|
409
|
+
parameters: {
|
|
410
|
+
query?: never;
|
|
411
|
+
header?: never;
|
|
412
|
+
path: {
|
|
413
|
+
/** @description Schedule ID */
|
|
414
|
+
scheduleId: string;
|
|
415
|
+
};
|
|
416
|
+
cookie?: never;
|
|
417
|
+
};
|
|
418
|
+
requestBody?: never;
|
|
419
|
+
responses: {
|
|
420
|
+
/** @description Schedule response */
|
|
421
|
+
200: {
|
|
422
|
+
headers: {
|
|
423
|
+
[name: string]: unknown;
|
|
424
|
+
};
|
|
425
|
+
content: {
|
|
426
|
+
"application/json": {
|
|
427
|
+
/**
|
|
428
|
+
* Format: uuid
|
|
429
|
+
* @description Unique identifier for the schedule.
|
|
430
|
+
*/
|
|
431
|
+
id?: string;
|
|
432
|
+
/** @description Human-readable name for the schedule. */
|
|
433
|
+
name: string;
|
|
434
|
+
/**
|
|
435
|
+
* Format: uuid
|
|
436
|
+
* @description UUID of the user who owns this schedule.
|
|
437
|
+
*/
|
|
438
|
+
userId: string;
|
|
439
|
+
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
440
|
+
cronExpression: string;
|
|
441
|
+
/**
|
|
442
|
+
* Format: date-time
|
|
443
|
+
* @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
444
|
+
*/
|
|
445
|
+
lastRun?: string;
|
|
446
|
+
/**
|
|
447
|
+
* Format: date-time
|
|
448
|
+
* @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
|
|
449
|
+
*/
|
|
450
|
+
nextRun?: string;
|
|
451
|
+
/**
|
|
452
|
+
* Format: date-time
|
|
453
|
+
* @description Timestamp when the schedule was created.
|
|
454
|
+
*/
|
|
455
|
+
createdAt?: string;
|
|
456
|
+
/**
|
|
457
|
+
* Format: date-time
|
|
458
|
+
* @description Timestamp when the schedule was last updated.
|
|
459
|
+
*/
|
|
460
|
+
updatedAt?: string;
|
|
461
|
+
};
|
|
462
|
+
};
|
|
463
|
+
};
|
|
464
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
465
|
+
401: {
|
|
466
|
+
headers: {
|
|
467
|
+
[name: string]: unknown;
|
|
468
|
+
};
|
|
469
|
+
content: {
|
|
470
|
+
"text/plain": string;
|
|
471
|
+
};
|
|
472
|
+
};
|
|
473
|
+
/** @description Result not found */
|
|
474
|
+
404: {
|
|
475
|
+
headers: {
|
|
476
|
+
[name: string]: unknown;
|
|
477
|
+
};
|
|
478
|
+
content: {
|
|
479
|
+
"text/plain": string;
|
|
480
|
+
};
|
|
481
|
+
};
|
|
482
|
+
/** @description Internal server error */
|
|
483
|
+
500: {
|
|
484
|
+
headers: {
|
|
485
|
+
[name: string]: unknown;
|
|
486
|
+
};
|
|
487
|
+
content: {
|
|
488
|
+
"text/plain": string;
|
|
489
|
+
};
|
|
490
|
+
};
|
|
491
|
+
};
|
|
492
|
+
};
|
|
493
|
+
deleteSchedule: {
|
|
494
|
+
parameters: {
|
|
495
|
+
query?: never;
|
|
496
|
+
header?: never;
|
|
497
|
+
path: {
|
|
498
|
+
/** @description Schedule ID */
|
|
499
|
+
scheduleId: string;
|
|
500
|
+
};
|
|
501
|
+
cookie?: never;
|
|
502
|
+
};
|
|
503
|
+
requestBody?: never;
|
|
504
|
+
responses: {
|
|
505
|
+
/** @description Schedule deleted */
|
|
506
|
+
204: {
|
|
507
|
+
headers: {
|
|
508
|
+
[name: string]: unknown;
|
|
509
|
+
};
|
|
510
|
+
content?: never;
|
|
511
|
+
};
|
|
512
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
513
|
+
401: {
|
|
514
|
+
headers: {
|
|
515
|
+
[name: string]: unknown;
|
|
516
|
+
};
|
|
517
|
+
content: {
|
|
518
|
+
"text/plain": string;
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
/** @description Result not found */
|
|
522
|
+
404: {
|
|
523
|
+
headers: {
|
|
524
|
+
[name: string]: unknown;
|
|
525
|
+
};
|
|
526
|
+
content: {
|
|
527
|
+
"text/plain": string;
|
|
528
|
+
};
|
|
529
|
+
};
|
|
530
|
+
/** @description Internal server error */
|
|
531
|
+
500: {
|
|
532
|
+
headers: {
|
|
533
|
+
[name: string]: unknown;
|
|
534
|
+
};
|
|
535
|
+
content: {
|
|
536
|
+
"text/plain": string;
|
|
537
|
+
};
|
|
538
|
+
};
|
|
425
539
|
};
|
|
426
|
-
};
|
|
427
540
|
};
|
|
428
|
-
};
|
|
429
541
|
}
|
|
430
|
-
|
|
431
|
-
export interface external {}
|