Skip to content

Commit dfa3bf0

Browse files
github-actions[bot]github-actions
github-actions[bot]
and
github-actions
authored
chore(Timer): Updates OpenAPI generated types for Globus Service APIs (#606)
This PR was auto-generated by the `scheduled--generate-types` GitHub Action workflow. ### Continuous integration workflows were NOT run on the creation of this pull request. --- - [x] Update the title (scope) of this pull request to match the changes made. - [x] Close and reopen this pull request to trigger workflows. Co-authored-by: github-actions <[email protected]>
1 parent 14d8439 commit dfa3bf0

File tree

1 file changed

+180
-15
lines changed

1 file changed

+180
-15
lines changed

‎src/open-api/types/timers.ts‎

Lines changed: 180 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -151,13 +151,7 @@ export interface paths {
151151
put?: never;
152152
/**
153153
* Create Timer
154-
* @description Create a new Timer.
155-
*
156-
* If the job is set to stop after exactly 1 run then the interval must be null.
157-
* Otherwise, the job interval must be between 60 seconds and 365 days.
158-
*
159-
* The timer must specify a type.
160-
* Currently, only the "transfer" type is supported.
154+
* @description Create a new timer.
161155
*/
162156
post: operations["create_timer_v2_timer_post"];
163157
delete?: never;
@@ -223,6 +217,104 @@ export interface components {
223217
*/
224218
type?: "file" | "dir";
225219
};
220+
/** FlowStartDocument */
221+
FlowStartDocument: {
222+
/**
223+
* Body
224+
* @description Input variables to pass to the flow each time it is started.
225+
*/
226+
body: Record<string, unknown>;
227+
/**
228+
* Run Monitors
229+
* @description Principals (identities or groups) which are allowed to monitor each run.
230+
*/
231+
run_monitors?: string[];
232+
/**
233+
* Run Managers
234+
* @description Principals (identities or groups) which are allowed to manage each run.
235+
*/
236+
run_managers?: string[];
237+
/**
238+
* Tags
239+
* @description Tags that will be added to each run.
240+
*/
241+
tags?: string[];
242+
};
243+
/** FlowTimerRead */
244+
FlowTimerRead: {
245+
/** Name */
246+
name?: string;
247+
stop_after?: components["schemas"]["StopAfter"];
248+
/**
249+
* Interval
250+
* Format: time-delta
251+
*/
252+
interval?: number;
253+
/**
254+
* Scope
255+
* @example https://auth.globus.org/scopes/actions.globus.org/transfer/transfer
256+
*/
257+
scope?: string;
258+
timer_type: components["schemas"]["SupportedTimerType"];
259+
/**
260+
* Callback Url
261+
* Format: uri
262+
* @example [
263+
* "https://actions.automate.globus.org/transfer/transfer/run"
264+
* ]
265+
*/
266+
callback_url: string;
267+
/**
268+
* Callback Body
269+
* @example {
270+
* "request_id": "a403b459-376e-47a2-a55d-30e7ddbcc3d2",
271+
* "body": {
272+
* "source_endpoint_id": "just_an_example"
273+
* }
274+
* }
275+
*/
276+
callback_body: Record<string, unknown>;
277+
/**
278+
* Start
279+
* Format: date-time
280+
*/
281+
start: string;
282+
inactive_reason?: components["schemas"]["JobInactiveReason"];
283+
/**
284+
* Job Id
285+
* Format: uuid
286+
*/
287+
job_id: string;
288+
/** Status */
289+
status: string;
290+
/**
291+
* Submitted At
292+
* Format: date-time
293+
*/
294+
submitted_at: string;
295+
/**
296+
* Last Ran At
297+
* Format: date-time
298+
*/
299+
last_ran_at?: string;
300+
/**
301+
* Next Run
302+
* Format: date-time
303+
*/
304+
next_run?: string;
305+
/** N Runs */
306+
n_runs: number;
307+
/** N Errors */
308+
n_errors: number;
309+
results: components["schemas"]["JobResultPage"];
310+
/** Schedule */
311+
schedule: components["schemas"]["OnceSchedule"] | components["schemas"]["RecurringSchedule"];
312+
/**
313+
* Flow Id
314+
* Format: uuid
315+
*/
316+
flow_id: string;
317+
};
226318
/** HTTPValidationError */
227319
HTTPValidationError: {
228320
/** Detail */
@@ -294,6 +386,7 @@ export interface components {
294386
* @example https://auth.globus.org/scopes/actions.globus.org/transfer/transfer
295387
*/
296388
scope?: string;
389+
timer_type: components["schemas"]["SupportedTimerType"];
297390
/**
298391
* Callback Url
299392
* Format: uri
@@ -467,6 +560,14 @@ export interface components {
467560
/** N Runs */
468561
n_runs?: number;
469562
};
563+
/**
564+
* SupportedTimerType
565+
* @description Supported values for the `timer_type` of a Timer.
566+
*
567+
* As Timers are modeled under the name `Job`, this is `Job.timer_type`.
568+
* @enum {string}
569+
*/
570+
SupportedTimerType: "generic" | "transfer" | "flow";
470571
/** TransferTaskDocument */
471572
TransferTaskDocument: {
472573
/**
@@ -566,13 +667,78 @@ export interface components {
566667
/** Checksum Algorithm */
567668
checksum_algorithm?: string;
568669
};
670+
/** V2FlowTimerCreate */
671+
V2FlowTimerCreate: {
672+
/** Name */
673+
name?: string;
674+
/** Schedule */
675+
schedule: components["schemas"]["OnceSchedule"] | components["schemas"]["RecurringSchedule"];
676+
/**
677+
* @description discriminator enum property added by openapi-typescript
678+
* @enum {string}
679+
*/
680+
timer_type: "flow";
681+
/**
682+
* Flow Id
683+
* Format: uuid
684+
*/
685+
flow_id: string;
686+
body: components["schemas"]["FlowStartDocument"];
687+
};
688+
/** V2FlowTimerRead */
689+
V2FlowTimerRead: {
690+
/** Name */
691+
name?: string;
692+
/** Schedule */
693+
schedule: components["schemas"]["OnceSchedule"] | components["schemas"]["RecurringSchedule"];
694+
inactive_reason?: components["schemas"]["JobInactiveReason"];
695+
/**
696+
* Job Id
697+
* Format: uuid
698+
*/
699+
job_id: string;
700+
/** Status */
701+
status: string;
702+
/**
703+
* Submitted At
704+
* Format: date-time
705+
*/
706+
submitted_at: string;
707+
/**
708+
* Last Ran At
709+
* Format: date-time
710+
*/
711+
last_ran_at?: string;
712+
/**
713+
* Next Run
714+
* Format: date-time
715+
*/
716+
next_run?: string;
717+
/** Number Of Runs */
718+
number_of_runs: number;
719+
/** Number Of Errors */
720+
number_of_errors: number;
721+
/**
722+
* @description discriminator enum property added by openapi-typescript
723+
* @enum {string}
724+
*/
725+
timer_type: "flow";
726+
/**
727+
* Flow Id
728+
* Format: uuid
729+
*/
730+
flow_id: string;
731+
body: components["schemas"]["FlowStartDocument"];
732+
};
569733
/** V2TimerCreate */
570734
V2TimerCreate: {
571-
timer: components["schemas"]["V2TransferTimerCreate"];
735+
/** Timer */
736+
timer: components["schemas"]["V2TransferTimerCreate"] | components["schemas"]["V2FlowTimerCreate"];
572737
};
573738
/** V2TimerRead */
574739
V2TimerRead: {
575-
timer: components["schemas"]["V2TransferTimerRead"];
740+
/** Timer */
741+
timer: components["schemas"]["V2TransferTimerRead"] | components["schemas"]["V2FlowTimerRead"];
576742
};
577743
/** V2TransferTimerCreate */
578744
V2TransferTimerCreate: {
@@ -581,7 +747,7 @@ export interface components {
581747
/** Schedule */
582748
schedule: components["schemas"]["OnceSchedule"] | components["schemas"]["RecurringSchedule"];
583749
/**
584-
* Timer Type
750+
* @description discriminator enum property added by openapi-typescript
585751
* @enum {string}
586752
*/
587753
timer_type: "transfer";
@@ -627,8 +793,7 @@ export interface components {
627793
/** Number Of Errors */
628794
number_of_errors: number;
629795
/**
630-
* Timer Type
631-
* @default transfer
796+
* @description discriminator enum property added by openapi-typescript
632797
* @enum {string}
633798
*/
634799
timer_type: "transfer";
@@ -693,7 +858,7 @@ export interface operations {
693858
};
694859
content: {
695860
"application/json": {
696-
jobs?: components["schemas"]["JobRead"][];
861+
jobs?: (components["schemas"]["FlowTimerRead"] | components["schemas"]["JobRead"])[];
697862
};
698863
};
699864
};
@@ -761,7 +926,7 @@ export interface operations {
761926
[name: string]: unknown;
762927
};
763928
content: {
764-
"application/json": components["schemas"]["JobRead"];
929+
"application/json": components["schemas"]["FlowTimerRead"] | components["schemas"]["JobRead"];
765930
};
766931
};
767932
/** @description Validation Error */
@@ -796,7 +961,7 @@ export interface operations {
796961
[name: string]: unknown;
797962
};
798963
content: {
799-
"application/json": components["schemas"]["JobRead"];
964+
"application/json": components["schemas"]["JobRead"] | components["schemas"]["FlowTimerRead"];
800965
};
801966
};
802967
/** @description Validation Error */

0 commit comments

Comments
 (0)