@meshery/schemas 1.2.14 → 1.2.16
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 +1516 -1516
- package/dist/cloudApi.d.ts +1516 -1516
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +114 -0
- package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +2 -0
- package/dist/constructs/v1alpha1/core/Core.d.ts +832 -0
- package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1937 -0
- package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6417 -0
- package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/badge/Badge.d.ts +546 -0
- package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/capability/Capability.d.ts +114 -0
- package/dist/constructs/v1beta1/capability/CapabilitySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1beta1/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/category/Category.d.ts +46 -0
- package/dist/constructs/v1beta1/category/CategorySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/component/Component.d.ts +869 -0
- package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1300 -0
- package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/core/Core.d.ts +832 -0
- package/dist/constructs/v1beta1/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/credential/Credential.d.ts +530 -0
- package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/environment/Environment.d.ts +759 -0
- package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6338 -0
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/event/Event.d.ts +570 -0
- package/dist/constructs/v1beta1/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/feature/Feature.d.ts +308 -0
- package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +983 -0
- package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/key/Key.d.ts +514 -0
- package/dist/constructs/v1beta1/key/KeySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +642 -0
- package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/model/Model.d.ts +659 -0
- package/dist/constructs/v1beta1/model/ModelSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1598 -0
- package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +18407 -0
- package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/plan/Plan.d.ts +149 -0
- package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/relationship/Relationship.d.ts +1921 -0
- package/dist/constructs/v1beta1/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/role/Role.d.ts +745 -0
- package/dist/constructs/v1beta1/role/RoleSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +374 -0
- package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +68 -0
- package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +752 -0
- package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/support/Support.d.ts +91 -0
- package/dist/constructs/v1beta1/support/SupportSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +846 -0
- package/dist/constructs/v1beta1/team/TeamSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/token/Token.d.ts +539 -0
- package/dist/constructs/v1beta1/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/user/User.d.ts +1677 -0
- package/dist/constructs/v1beta1/user/UserSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/view/View.d.ts +759 -0
- package/dist/constructs/v1beta1/view/ViewSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4947 -0
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7762 -0
- package/dist/constructs/v1beta2/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta2/badge/Badge.d.ts +563 -0
- package/dist/constructs/v1beta2/badge/BadgeSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1beta2/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/component/Component.d.ts +887 -0
- package/dist/constructs/v1beta2/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1330 -0
- package/dist/constructs/v1beta2/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/core/Core.d.ts +866 -0
- package/dist/constructs/v1beta2/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/credential/Credential.d.ts +519 -0
- package/dist/constructs/v1beta2/credential/CredentialSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/design/Design.d.ts +19039 -0
- package/dist/constructs/v1beta2/design/DesignSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/event/Event.d.ts +626 -0
- package/dist/constructs/v1beta2/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1052 -0
- package/dist/constructs/v1beta2/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/key/Key.d.ts +524 -0
- package/dist/constructs/v1beta2/key/KeySchema.d.ts +2 -0
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +652 -0
- package/dist/constructs/v1beta2/keychain/KeychainSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/model/Model.d.ts +697 -0
- package/dist/constructs/v1beta2/model/ModelSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/organization/Organization.d.ts +1915 -0
- package/dist/constructs/v1beta2/organization/OrganizationSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/plan/Plan.d.ts +162 -0
- package/dist/constructs/v1beta2/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2134 -0
- package/dist/constructs/v1beta2/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/role/Role.d.ts +752 -0
- package/dist/constructs/v1beta2/role/RoleSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +431 -0
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +785 -0
- package/dist/constructs/v1beta2/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/team/Team.d.ts +960 -0
- package/dist/constructs/v1beta2/team/TeamSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/token/Token.d.ts +544 -0
- package/dist/constructs/v1beta2/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/user/User.d.ts +1677 -0
- package/dist/constructs/v1beta2/user/UserSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/view/View.d.ts +767 -0
- package/dist/constructs/v1beta2/view/ViewSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7762 -0
- package/dist/constructs/v1beta3/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta3/component/Component.d.ts +892 -0
- package/dist/constructs/v1beta3/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1414 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/design/Design.d.ts +5704 -0
- package/dist/constructs/v1beta3/design/DesignSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/environment/Environment.d.ts +785 -0
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/event/Event.d.ts +720 -0
- package/dist/constructs/v1beta3/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1452 -0
- package/dist/constructs/v1beta3/filter/FilterSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1060 -0
- package/dist/constructs/v1beta3/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +813 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/plan/Plan.d.ts +199 -0
- package/dist/constructs/v1beta3/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2134 -0
- package/dist/constructs/v1beta3/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +915 -0
- package/dist/constructs/v1beta3/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/token/Token.d.ts +544 -0
- package/dist/constructs/v1beta3/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5086 -0
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.d.ts +2 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/mesheryApi.d.mts +546 -546
- package/dist/mesheryApi.d.ts +546 -546
- package/package.json +2 -2
|
@@ -0,0 +1,431 @@
|
|
|
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
|
+
"/user/schedules": {
|
|
8
|
+
/** Returns all schedules for the authenticated user. */
|
|
9
|
+
get: operations["getSchedules"];
|
|
10
|
+
/** Creates or updates a schedule for the authenticated user. */
|
|
11
|
+
post: operations["upsertSchedule"];
|
|
12
|
+
};
|
|
13
|
+
"/user/schedules/{scheduleId}": {
|
|
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;
|
|
101
|
+
/**
|
|
102
|
+
* Format: date-time
|
|
103
|
+
* @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.
|
|
104
|
+
*/
|
|
105
|
+
lastRun?: string;
|
|
106
|
+
/**
|
|
107
|
+
* Format: date-time
|
|
108
|
+
* @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.
|
|
109
|
+
*/
|
|
110
|
+
nextRun?: string;
|
|
111
|
+
/**
|
|
112
|
+
* Format: date-time
|
|
113
|
+
* @description Timestamp when the schedule was created.
|
|
114
|
+
*/
|
|
115
|
+
createdAt?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Format: date-time
|
|
118
|
+
* @description Timestamp when the schedule was last updated.
|
|
119
|
+
*/
|
|
120
|
+
updatedAt?: string;
|
|
121
|
+
}[];
|
|
122
|
+
};
|
|
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
|
+
}
|
|
163
|
+
|
|
164
|
+
export interface operations {
|
|
165
|
+
/** Returns all schedules for the authenticated user. */
|
|
166
|
+
getSchedules: {
|
|
167
|
+
parameters: {
|
|
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": {
|
|
251
|
+
/**
|
|
252
|
+
* Format: uuid
|
|
253
|
+
* @description Unique identifier for the schedule.
|
|
254
|
+
*/
|
|
255
|
+
id?: string;
|
|
256
|
+
/** @description Human-readable name for the schedule. */
|
|
257
|
+
name: string;
|
|
258
|
+
/**
|
|
259
|
+
* Format: uuid
|
|
260
|
+
* @description UUID of the user who owns this schedule.
|
|
261
|
+
*/
|
|
262
|
+
userId: string;
|
|
263
|
+
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
264
|
+
cronExpression: string;
|
|
265
|
+
/**
|
|
266
|
+
* Format: date-time
|
|
267
|
+
* @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.
|
|
268
|
+
*/
|
|
269
|
+
lastRun?: string;
|
|
270
|
+
/**
|
|
271
|
+
* Format: date-time
|
|
272
|
+
* @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.
|
|
273
|
+
*/
|
|
274
|
+
nextRun?: string;
|
|
275
|
+
/**
|
|
276
|
+
* Format: date-time
|
|
277
|
+
* @description Timestamp when the schedule was created.
|
|
278
|
+
*/
|
|
279
|
+
createdAt?: string;
|
|
280
|
+
/**
|
|
281
|
+
* Format: date-time
|
|
282
|
+
* @description Timestamp when the schedule was last updated.
|
|
283
|
+
*/
|
|
284
|
+
updatedAt?: string;
|
|
285
|
+
};
|
|
286
|
+
};
|
|
287
|
+
};
|
|
288
|
+
/** Invalid request body or request param */
|
|
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": {
|
|
341
|
+
/**
|
|
342
|
+
* Format: uuid
|
|
343
|
+
* @description Unique identifier for the schedule.
|
|
344
|
+
*/
|
|
345
|
+
id?: string;
|
|
346
|
+
/** @description Human-readable name for the schedule. */
|
|
347
|
+
name: string;
|
|
348
|
+
/**
|
|
349
|
+
* Format: uuid
|
|
350
|
+
* @description UUID of the user who owns this schedule.
|
|
351
|
+
*/
|
|
352
|
+
userId: string;
|
|
353
|
+
/** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
|
|
354
|
+
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
|
+
};
|
|
377
|
+
};
|
|
378
|
+
/** Expired JWT token used or insufficient privilege */
|
|
379
|
+
401: {
|
|
380
|
+
content: {
|
|
381
|
+
"text/plain": string;
|
|
382
|
+
};
|
|
383
|
+
};
|
|
384
|
+
/** Result not found */
|
|
385
|
+
404: {
|
|
386
|
+
content: {
|
|
387
|
+
"text/plain": string;
|
|
388
|
+
};
|
|
389
|
+
};
|
|
390
|
+
/** Internal server error */
|
|
391
|
+
500: {
|
|
392
|
+
content: {
|
|
393
|
+
"text/plain": string;
|
|
394
|
+
};
|
|
395
|
+
};
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
/** Deletes a schedule by its ID. */
|
|
399
|
+
deleteSchedule: {
|
|
400
|
+
parameters: {
|
|
401
|
+
path: {
|
|
402
|
+
/** Schedule ID */
|
|
403
|
+
scheduleId: string;
|
|
404
|
+
};
|
|
405
|
+
};
|
|
406
|
+
responses: {
|
|
407
|
+
/** Schedule deleted */
|
|
408
|
+
204: never;
|
|
409
|
+
/** Expired JWT token used or insufficient privilege */
|
|
410
|
+
401: {
|
|
411
|
+
content: {
|
|
412
|
+
"text/plain": string;
|
|
413
|
+
};
|
|
414
|
+
};
|
|
415
|
+
/** Result not found */
|
|
416
|
+
404: {
|
|
417
|
+
content: {
|
|
418
|
+
"text/plain": string;
|
|
419
|
+
};
|
|
420
|
+
};
|
|
421
|
+
/** Internal server error */
|
|
422
|
+
500: {
|
|
423
|
+
content: {
|
|
424
|
+
"text/plain": string;
|
|
425
|
+
};
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
};
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
export interface external {}
|