Skip to content

Commit c672889

Browse files
github-actions[bot]github-actions
andauthored
chore(Flows): Adds singular GET for web inputs type (#873)
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 <github-actions@github.com>
1 parent 301e193 commit c672889

1 file changed

Lines changed: 152 additions & 41 deletions

File tree

src/open-api/types/flows.ts

Lines changed: 152 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2549,6 +2549,44 @@ export interface paths {
25492549
patch?: never;
25502550
trace?: never;
25512551
};
2552+
"/web_inputs/{web_input_id}": {
2553+
parameters: {
2554+
query?: never;
2555+
header?: never;
2556+
path?: never;
2557+
cookie?: never;
2558+
};
2559+
/** @description Get a Web Input by ID */
2560+
get: {
2561+
parameters: {
2562+
query?: never;
2563+
header?: never;
2564+
path: {
2565+
web_input_id: string;
2566+
};
2567+
cookie?: never;
2568+
};
2569+
requestBody?: never;
2570+
responses: {
2571+
/** @description Information about the Web Input */
2572+
200: {
2573+
headers: {
2574+
[name: string]: unknown;
2575+
};
2576+
content: {
2577+
"application/json": components["schemas"]["WebInputResponse"];
2578+
};
2579+
};
2580+
};
2581+
};
2582+
put?: never;
2583+
post?: never;
2584+
delete?: never;
2585+
options?: never;
2586+
head?: never;
2587+
patch?: never;
2588+
trace?: never;
2589+
};
25522590
"/web_inputs/{web_input_id}/response": {
25532591
parameters: {
25542592
query?: never;
@@ -2719,6 +2757,8 @@ export interface components {
27192757
/** @description The list of all roles the requesting user has on the Run. */
27202758
user_roles?: ("run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager")[];
27212759
tags: components["schemas"]["Tags"];
2760+
/** @description The ID of the Web Input from which the Run is currently awaiting input. This field is present, but null, if the Run is not awaiting input. */
2761+
blocking_web_input_id: string | null;
27222762
};
27232763
ValidateRun: {
27242764
/**
@@ -3153,56 +3193,127 @@ export interface components {
31533193
*/
31543194
updated_timestamp: string;
31553195
};
3156-
WebInputSummary: {
3196+
/**
3197+
* Format: date-time
3198+
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was closed. Null if the Web Input is still open.
3199+
*/
3200+
_WebInputClosedTimestamp: string | null;
3201+
/**
3202+
* @description Information that helps respondents understand what they're responding to.
3203+
* For example, "What file transfer am I approving or denying?"
3204+
*/
3205+
_WebInputContext: {
31573206
/**
3158-
* Format: uuid
3159-
* @description The unique identifier for the Web Input.
3207+
* @description A title for the Web Input.
3208+
* This may be displayed as an human-readable label for the Web Input itself, or it may be used as a bold header on a webpage displaying the Web Input as a form.
31603209
*/
3161-
id: string;
3210+
title?: string;
3211+
/** @description The suggested way by which the rows should be rendered for display. */
3212+
presentation_style?: string;
3213+
rows?: {
3214+
field: string;
3215+
value: string;
3216+
}[];
3217+
};
3218+
/** @description The Globus Auth identity that created the Web Input. Creators are not implicitly granted "view" access to the Web Input. */
3219+
_WebInputCreatorUrn: string;
3220+
/**
3221+
* Format: date-time
3222+
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was created.
3223+
*/
3224+
_WebInputCreatedTimestamp: string;
3225+
/**
3226+
* Format: date-time
3227+
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was last edited.
3228+
*/
3229+
_WebInputEditedTimestamp: string;
3230+
/** @description Info about the Flow associated with the Web Input. */
3231+
_WebInputFlowInfo: {
31623232
/**
3163-
* @description The current status of the Web Input. "open" indicates the Web Input is awaiting a response; "closed" indicates it has been completed.
3164-
* @enum {string}
3233+
* Format: uuid
3234+
* @description The unique identifier for the associated Flow.
31653235
*/
3166-
status: "open" | "closed";
3167-
/** @description The roles the current user has on this Web Input. */
3168-
user_roles: ("viewer" | "respondent")[];
3169-
/** @description The type of Web Input (e.g., "selection", "form"). */
3170-
input_type: string;
3171-
/** @description A human-readable title for the Web Input. */
3236+
id: string;
3237+
/** @description The title of the associated Flow. */
31723238
title: string;
3173-
flow: {
3174-
/**
3175-
* Format: uuid
3176-
* @description The unique identifier for the associated Flow.
3177-
*/
3178-
id: string;
3179-
/** @description The title of the associated Flow. */
3180-
title: string;
3181-
};
3182-
run: {
3183-
/**
3184-
* Format: uuid
3185-
* @description The unique identifier for the associated Run.
3186-
*/
3187-
id: string;
3188-
/** @description An optional label for the associated Run. */
3189-
label: string | null;
3190-
};
3191-
/**
3192-
* Format: date-time
3193-
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was created.
3194-
*/
3195-
created_timestamp: string;
3239+
};
3240+
/**
3241+
* Format: uuid
3242+
* @description The unique identifier for the Web Input.
3243+
*/
3244+
_WebInputId: string;
3245+
/** @description The input schema used to validate all responses to the Web Input. */
3246+
_WebInputInputSchema: Record<string, unknown>;
3247+
/**
3248+
* @description The type of Web Input.
3249+
* @enum {string}
3250+
*/
3251+
_WebInputInputType: "selection";
3252+
/** @description The individual options associated with Web Input. This field is only present when the input type is "selection". */
3253+
_WebInputOptions: {
31963254
/**
3197-
* Format: date-time
3198-
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was last edited.
3255+
* Format: uuid
3256+
* @description A UUID that identifies the option. If a respondent selects this option (like "Approve" or "Deny"), this is the value that should be submitted back to the Flows service.
31993257
*/
3200-
edited_timestamp: string;
3258+
option_id: string;
3259+
/** @description Text that is associated with the option. For example, this may be the word "Approve" or "Deny", and is probably displayed prominently on a button or other UI element that respondents can click on. */
3260+
label: string;
3261+
/** @description Additional context to clarify the option for respondents. For example, this may be text "Allow file egress from the protected collection." */
3262+
description: string;
3263+
}[];
3264+
/** @description The Globus Auth identities and groups that have been assigned roles/permissions to the Web Input. */
3265+
_WebInputRoles: {
3266+
/** @description Identities and groups that are allowed to view all of the Web Input's information. */
3267+
viewer_urns: string[];
3268+
/** @description Identities and groups that are allowed to submit responses to the Web Input. Respondents are also allowed to view information about the Web Input. */
3269+
respondent_urns: string[];
3270+
};
3271+
/** @description Info about the Run associated with the Web Input. */
3272+
_WebInputRunInfo: {
32013273
/**
3202-
* Format: date-time
3203-
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was closed. Null if the Web Input is still open.
3274+
* Format: uuid
3275+
* @description The unique identifier for the associated Run.
32043276
*/
3205-
closed_timestamp: string | null;
3277+
id: string;
3278+
/** @description An optional label for the associated Run. */
3279+
label: string | null;
3280+
};
3281+
/**
3282+
* @description The current status of the Web Input. "open" indicates the Web Input is awaiting a response; "closed" indicates it has been completed.
3283+
* @enum {string}
3284+
*/
3285+
_WebInputStatus: "open" | "closed";
3286+
/** @description A human-readable title for the Web Input. */
3287+
_WebInputTitle: string;
3288+
/** @description The roles the current user has on this Web Input. */
3289+
_WebInputUserRoles: ("viewer" | "respondent")[];
3290+
WebInputResponse: {
3291+
id: components["schemas"]["_WebInputId"];
3292+
status: components["schemas"]["_WebInputStatus"];
3293+
user_roles: components["schemas"]["_WebInputUserRoles"];
3294+
input_type: components["schemas"]["_WebInputInputType"];
3295+
input_schema: components["schemas"]["_WebInputInputSchema"];
3296+
context: components["schemas"]["_WebInputContext"];
3297+
flow: components["schemas"]["_WebInputFlowInfo"];
3298+
run: components["schemas"]["_WebInputRunInfo"];
3299+
roles: components["schemas"]["_WebInputRoles"];
3300+
creator_urn: components["schemas"]["_WebInputCreatorUrn"];
3301+
created_timestamp: components["schemas"]["_WebInputCreatedTimestamp"];
3302+
edited_timestamp: components["schemas"]["_WebInputEditedTimestamp"];
3303+
closed_timestamp: components["schemas"]["_WebInputClosedTimestamp"];
3304+
options?: components["schemas"]["_WebInputOptions"];
3305+
};
3306+
WebInputSummary: {
3307+
id: components["schemas"]["_WebInputId"];
3308+
status: components["schemas"]["_WebInputStatus"];
3309+
user_roles: components["schemas"]["_WebInputUserRoles"];
3310+
input_type: components["schemas"]["_WebInputInputType"];
3311+
title: components["schemas"]["_WebInputTitle"];
3312+
flow: components["schemas"]["_WebInputFlowInfo"];
3313+
run: components["schemas"]["_WebInputRunInfo"];
3314+
created_timestamp: components["schemas"]["_WebInputCreatedTimestamp"];
3315+
edited_timestamp: components["schemas"]["_WebInputEditedTimestamp"];
3316+
closed_timestamp: components["schemas"]["_WebInputClosedTimestamp"];
32063317
};
32073318
RegisteredApi: components["schemas"]["RegisteredApiSummary"] & {
32083319
/**

0 commit comments

Comments
 (0)