@globus/sdk 6.2.0 → 6.3.0-canary.2.34be3d1

package/dist/esm/open-api/types/flows.d.ts

@@ -22,25 +22,15 @@ export interface paths {
                      *     once an initial marker has been received.
                      */
                     marker?: string;
-                    /**
-                     * @description The number of results to return in a single paged response.
-                     * @example 50
-                     */
+                    /** @description The number of results to return in a single paged response. */
                     per_page?: number;
-                    /**
-                     * @description The page of results to return.
-                     * @example 2
-                     */
+                    /** @description The page of results to return. */
                     page?: number;
                     /**
                      * @description Return Flows for which the user has the supplied role. The role the
                      *     user has on the Flow dictates the operations they can perform. If
                      *     multiple roles are specified, the user will have at least one of the
                      *     specified roles on each Flow returned.
-                     * @example [
-                     *       "flow_owner",
-                     *       "flow_viewers"
-                     *     ]
                      */
                     filter_roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors")[];
                     /**
@@ -53,7 +43,6 @@ export interface paths {
                      *     include all Flows for which the user has "flow_viewer" role as
                      *     well. If not provided, only Flows for which the caller has
                      *     "flow_owner" role will be returned.
-                     * @example flow_starter
                      */
                     filter_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "run_manager" | "run_monitor";
                     /**
@@ -61,20 +50,12 @@ export interface paths {
                      *     scope string fields. If multiple values are specified, each Flow
                      *     returned is guaranteed to contain at least one of the strings in its
                      *     scope strings.
-                     * @example [
-                     *       "0abc",
-                     *       "100"
-                     *     ]
                      */
                     filter_scope_string?: string[];
                     /**
                      * @description Performs a case insensitive substring based search on the Flows' title
                      *     field. If multiple values are specified, each Flow returned
                      *     is guaranteed to contain at least one of the strings in its title.
-                     * @example [
-                     *       "hello",
-                     *       "science"
-                     *     ]
                      */
                     filter_title?: string[];
                     /**
@@ -82,10 +63,6 @@ export interface paths {
                      *     subtitle field. If multiple values are specified, each Flow returned
                      *     is guaranteed to contain at least one of the strings in its
                      *     subtitle.
-                     * @example [
-                     *       "hello",
-                     *       "science"
-                     *     ]
                      */
                     filter_subtitle?: string[];
                     /**
@@ -93,10 +70,6 @@ export interface paths {
                      *     description field. If multiple values are specified, each Flow returned
                      *     is guaranteed to contain at least one of the strings in its
                      *     description.
-                     * @example [
-                     *       "hello",
-                     *       "science"
-                     *     ]
                      */
                     filter_description?: string[];
                     /**
@@ -104,10 +77,6 @@ export interface paths {
                      *     keywords field. If multiple values are specified, each Flow returned
                      *     is guaranteed to contain at least one of the substrings as a
                      *     keyword.
-                     * @example [
-                     *       "hello",
-                     *       "science"
-                     *     ]
                      */
                     filter_keywords?: string[];
                     /**
@@ -122,9 +91,6 @@ export interface paths {
                      *       - description
                      *       - id
                      *       - flow_administrators
-                     * @example [
-                     *       "globus"
-                     *     ]
                      */
                     filter_fulltext?: string[];
                     /**
@@ -164,10 +130,6 @@ export interface paths {
                      *
                      *     - `ASC`
                      *     - `DESC`
-                     * @example [
-                     *       "title ASC",
-                     *       "id DESC"
-                     *     ]
                      */
                     orderby?: components["parameters"]["list_flows_orderby"];
                 };
@@ -1025,7 +987,88 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/runs/{run_id}/resume": paths["/flows/{flow_id}/{run_id}/resume"];
+    "/runs/{run_id}/resume": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The run ID */
+                run_id: components["parameters"]["run_id"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Resume a Run
+         * @description Attempt to resume a Run, particularly when it has reached a
+         *     status of INACTIVE. A Flow Run may reach an INACTIVE status
+         *     when an Action type state within the Flow returns its status
+         *     as INACTIVE. The resume operation on the Flow Run provides a
+         *     hint that the cause of the Action becoming INACTIVE may have
+         *     been cleared, and thus the resume operation on the Action
+         *     Provider should be invoked to allow the Action state to resume
+         *     and thus resume the Flow Run.
+         *
+         *     In the particular case that an Action state is INACTIVE with a
+         *     code value of "ConsentRequired" it is further assumed that the
+         *     Bearer token provided in the Authorization header on the
+         *     resume operation now carries sufficient consents to continue
+         *     the INACTIVE Action. Thus, the Flow service will use the
+         *     Bearer token to generate new dependent tokens for running the
+         *     Action and use these tokens to request that the Action be
+         *     resumed at the Action Provider.
+         *
+         *     Note again that in reasons other than "ConsentRequired" for a
+         *     Flow or Action to go INACTIVE, the resume operation is just a
+         *     hint. For example, when the code is "ActivationRequired,"
+         *     indicating that a Globus collection or endpoint needs to be
+         *     Activated by the user, performing that Activation out-of-band
+         *     from the Flow will allow the Flow to proceed even without the
+         *     resume operation as the Action is periodically polled for
+         *     progress. Performing the resume operation may simply cause a
+         *     poll to happen more quickly and thus allow the Action to
+         *     resume more quickly.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description The run ID */
+                    run_id: components["parameters"]["run_id"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description The request was successful. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["FlowRun"];
+                    };
+                };
+                /**
+                 * @description The requested Run or Flow was not found.
+                 *     Or, the requestor did not have access to manage the Run.
+                 */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/runs/{run_id}/cancel": {
         parameters: {
             query?: never;
@@ -1098,7 +1141,13 @@ export interface paths {
                 limit?: number;
                 /** @description A flag to indicate if log records should be returned in reverse order. */
                 reverse_order?: boolean;
-                /** @description A token used to iterate through pages of returned log records. */
+                /** @description An opaque token used to iterate through pages of returned log records. */
+                marker?: string;
+                /**
+                 * @deprecated
+                 * @description A token used to iterate through pages of returned log records.
+                 *     ("marker" is now the preferred name for this parameter.)
+                 */
                 pagination_token?: string;
             };
             header?: never;
@@ -1121,7 +1170,13 @@ export interface paths {
                     limit?: number;
                     /** @description A flag to indicate if log records should be returned in reverse order. */
                     reverse_order?: boolean;
-                    /** @description A token used to iterate through pages of returned log records. */
+                    /** @description An opaque token used to iterate through pages of returned log records. */
+                    marker?: string;
+                    /**
+                     * @deprecated
+                     * @description A token used to iterate through pages of returned log records.
+                     *     ("marker" is now the preferred name for this parameter.)
+                     */
                     pagination_token?: string;
                 };
                 header?: never;
@@ -1182,7 +1237,93 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/runs/{run_id}/log": paths["/flows/{flow_id}/runs/{run_id}/log"];
+    "/runs/{run_id}/log": {
+        parameters: {
+            query?: {
+                /** @description An integer limit on the number of log records returned. */
+                limit?: number;
+                /** @description A flag to indicate if log records should be returned in reverse order. */
+                reverse_order?: boolean;
+                /** @description A token used to iterate through pages of returned log records. */
+                pagination_token?: string;
+            };
+            header?: never;
+            path: {
+                /** @description The run ID */
+                run_id: components["parameters"]["run_id"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Get execution details on a Run
+         * @description Retrieve detailed execution information for a particular Flow Run
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description An integer limit on the number of log records returned. */
+                    limit?: number;
+                    /** @description A flag to indicate if log records should be returned in reverse order. */
+                    reverse_order?: boolean;
+                    /** @description A token used to iterate through pages of returned log records. */
+                    pagination_token?: string;
+                };
+                header?: never;
+                path: {
+                    /** @description The run ID */
+                    run_id: components["parameters"]["run_id"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description The request was successfully received. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description The number of log states returned. */
+                            limit: number;
+                            /**
+                             * @description An opaque pagination token for iterating through returned
+                             *     records. If there are no more entries, this field will not
+                             *     exist.
+                             */
+                            marker?: string;
+                            has_next_page: boolean;
+                            entries: Record<string, unknown>[];
+                        };
+                    };
+                };
+                /** @description There was an issue parsing the query parameters. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /**
+                 * @description The requested Run or Flow was not found.
+                 *     Or, the requestor did not have access to view the Run.
+                 */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/flows/{flow_id}/runs": {
         parameters: {
             query?: never;
@@ -1221,24 +1362,15 @@ export interface paths {
                      *     received.
                      */
                     pagination_token?: string;
-                    /**
-                     * @description The number of results to return in a single paged response.
-                     * @example 50
-                     */
+                    /** @description The number of results to return in a single paged response. */
                     per_page?: number;
-                    /**
-                     * @description The page of results to return.
-                     * @example 2
-                     */
+                    /** @description The page of results to return. */
                     page?: number;
                     /**
                      * @description Return Actions for which the user has the supplied role. The role the
                      *     user has on the Action dictates the operations they can perform.
                      *     If multiple roles are specified, the user will have at least one of
                      *     the specified roles on each Action returned.
-                     * @example [
-                     *       "run_manager"
-                     *     ]
                      */
                     filter_roles?: ("run_owner" | "run_manager" | "run_monitor" | "flow_run_manager" | "flow_run_monitor")[];
                     /**
@@ -1251,9 +1383,6 @@ export interface paths {
                      *     manager will also include all Actions for which the user
                      *     has "run_monitor" role as well. If not provided, only Actions
                      *     for which the caller has "run_owner" role will be returned.
-                     * @example [
-                     *       "run_manager"
-                     *     ]
                      */
                     filter_role?: "run_monitor" | "run_manager" | "run_owner" | "flow_run_manager" | "flow_run_monitor";
                     /**
@@ -1262,20 +1391,12 @@ export interface paths {
                      *     multiple statuses are specified, each Action returned will be in one
                      *     of the specified states. By default, Actions in any state will be
                      *     returned.
-                     * @example [
-                     *       "FAILED",
-                     *       "INACTIVE"
-                     *     ]
                      */
                     filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
                     /**
                      * @description Performs a case insensitive string based search on the Actions'
                      *     label fields. If multiple values are specified, each Action returned
                      *     is guaranteed to contain at least one of the strings in its label.
-                     * @example [
-                     *       "science",
-                     *       "tests"
-                     *     ]
                      */
                     filter_label?: string[];
                     /**
@@ -1295,7 +1416,6 @@ export interface paths {
                      *
                      *     Note that runs which are still executing will not have a completion time
                      *     and will be automatically excluded if this filter is applied.
-                     * @example 2021-03-09T21:52:14,2021-03-09T21:53
                      */
                     filter_completion_time?: components["parameters"]["filter_completion_time"];
                     /**
@@ -1312,7 +1432,6 @@ export interface paths {
                      *
                      *     Results will contain runs which began between the first datetime
                      *     onwards, up to (but not including) the second datetime.
-                     * @example 2021-03-09T21:52:14,2021-03-09T21:53
                      */
                     filter_start_time?: components["parameters"]["filter_start_time"];
                     /**
@@ -1350,10 +1469,6 @@ export interface paths {
                      *
                      *     - `ASC`
                      *     - `DESC`
-                     * @example [
-                     *       "start_time ASC",
-                     *       "id DESC"
-                     *     ]
                      */
                     orderby?: components["parameters"]["list_runs_orderby"];
                 };
@@ -1446,25 +1561,15 @@ export interface paths {
                      *     received.
                      */
                     pagination_token?: string;
-                    /**
-                     * @description The number of results to return in a single paged response.
-                     * @example 50
-                     */
+                    /** @description The number of results to return in a single paged response. */
                     per_page?: number;
-                    /**
-                     * @description The page of results to return.
-                     * @example 2
-                     */
+                    /** @description The page of results to return. */
                     page?: number;
                     /**
                      * @description Return Runs for which the user has the supplied role. The role the
                      *     user has on the Action dictates the operations they can perform.
                      *     If multiple roles are specified, the user will have at least one of
                      *     the specified roles on each Action returned.
-                     * @example [
-                     *       "run_owner",
-                     *       "run_managers"
-                     *     ]
                      */
                     filter_roles?: ("run_owner" | "run_managers" | "run_monitors" | "flow_run_managers" | "flow_run_monitors")[];
                     /**
@@ -1477,7 +1582,6 @@ export interface paths {
                      *     manager will also include all Runs for which the user
                      *     has "run_monitor" role as well. If not provided, only Runs
                      *     for which the caller has "run_owner" role will be returned.
-                     * @example run_manager
                      */
                     filter_role?: "run_monitor" | "run_manager" | "run_owner";
                     /**
@@ -1486,20 +1590,12 @@ export interface paths {
                      *     multiple statuses are specified, each Action returned will be in one
                      *     of the specified states. By default, Actions in any state will be
                      *     returned.
-                     * @example [
-                     *       "FAILED",
-                     *       "INACTIVE"
-                     *     ]
                      */
                     filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
                     /**
                      * @description Performs a case insensitive string based search on the Actions'
                      *     label fields. If multiple values are specified, each Action returned
                      *     is guaranteed to contain at least one of the strings in its label.
-                     * @example [
-                     *       "science",
-                     *       "tests"
-                     *     ]
                      */
                     filter_label?: string[];
                     /**
@@ -1507,10 +1603,6 @@ export interface paths {
                      *     Actions which have parent Flow's with a matching title(s). If
                      *     multiple values are specified, each Action returned will have a
                      *     parent Flow with a title matching at least one of the strings.
-                     * @example [
-                     *       "globus",
-                     *       "tests"
-                     *     ]
                      */
                     filter_flow_title?: string[];
                     /**
@@ -1518,10 +1610,6 @@ export interface paths {
                      *     initiated from the specified Flow ID(s). If multiple values are
                      *     specified, each Run returned will have been initiated from at least
                      *     one of the specified Flow IDs.
-                     * @example [
-                     *       "00000000-19d9-4f5b-9329-22ed12d4d3dd",
-                     *       "11111111-19a5-4d19-998e-0709c40321e9"
-                     *     ]
                      */
                     filter_flow_id?: string[];
                     /**
@@ -1541,7 +1629,6 @@ export interface paths {
                      *
                      *     Note that runs which are still executing will not have a completion time
                      *     and will be automatically excluded if this filter is applied.
-                     * @example 2021-03-09T21:52:14,2021-03-09T21:53
                      */
                     filter_completion_time?: components["parameters"]["filter_completion_time"];
                     /**
@@ -1558,7 +1645,6 @@ export interface paths {
                      *
                      *     Results will contain runs which began between the first datetime
                      *     onwards, up to (but not including) the second datetime.
-                     * @example 2021-03-09T21:52:14,2021-03-09T21:53
                      */
                     filter_start_time?: components["parameters"]["filter_start_time"];
                     /**
@@ -1596,10 +1682,6 @@ export interface paths {
                      *
                      *     - `ASC`
                      *     - `DESC`
-                     * @example [
-                     *       "start_time ASC",
-                     *       "id DESC"
-                     *     ]
                      */
                     orderby?: components["parameters"]["list_runs_orderby"];
                 };
@@ -1675,7 +1757,6 @@ export interface paths {
                     /**
                      * @description If present and set to a true value,
                      *     metadata about the associated flow will be included.
-                     * @example true
                      */
                     include_flow_description?: true | true | false | false;
                 };
@@ -1905,6 +1986,144 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/registered_apis": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Registered APIs
+         * @description Retrieve a listing of Registered APIs available to a user
+         *     according to the permissions (role) they have on the Registered API.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /**
+                     * @description An opaque token used to iterate through pages of returned Registered APIs.
+                     *     If provided, all other query arguments will be ignored.
+                     *     The marker encodes all state in a given query,
+                     *     therefore it's unnecessary to provide query arguments
+                     *     once an initial marker has been received.
+                     */
+                    marker?: string;
+                    /** @description The number of results to return in a single paged response. */
+                    per_page?: number;
+                    /**
+                     * @description Return Registered APIs for which the user has one of the supplied roles.
+                     *     The role the user has on the Registered API dictates the operations they
+                     *     can perform. If multiple roles are specified (comma-separated), the user
+                     *     will have at least one of the specified roles on each Registered API returned.
+                     *     If not provided, only Registered APIs for which the caller has "owner"
+                     *     role will be returned.
+                     */
+                    filter_roles?: ("owner" | "administrator" | "viewer")[];
+                    /**
+                     * @description Ordering criteria to apply to the list of Registered APIs.
+                     *
+                     *     This field is a comma-separated list of sort criteria,
+                     *     and follows this syntax:
+                     *
+                     *     ```
+                     *     CRITERION1[,CRITERION2[,...]]
+                     *     ```
+                     *
+                     *     and each individual `CRITERION` follows this syntax:
+                     *
+                     *     ```
+                     *     FIELD ORDERING
+                     *     ```
+                     *
+                     *     The first value, `FIELD`, indicates the field to sort by;
+                     *     the second value, `ORDERING`, indicates the sorting order.
+                     *
+                     *     When additional comma-separated criteria are added,
+                     *     the first criterion will be used to sort the data;
+                     *     subsequent criteria will be applied for ties.
+                     *
+                     *     Supported fields are:
+                     *
+                     *     - `id`
+                     *     - `name`
+                     *     - `created_timestamp`
+                     *     - `updated_timestamp`
+                     *
+                     *     Supported orderings are:
+                     *
+                     *     - `ASC`
+                     *     - `DESC`
+                     */
+                    orderby?: components["parameters"]["list_registered_apis_orderby"];
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /**
+                 * @description The requestor has successfully authenticated and queried the Flows
+                 *     service for the Registered APIs available for them.
+                 */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            registered_apis: components["schemas"]["RegisteredApiSummary"][];
+                            /** @description The number of Registered APIs returned. */
+                            limit: number;
+                            /**
+                             * @description An opaque pagination token for iterating through returned
+                             *     Registered APIs. Null if there are no more pages.
+                             */
+                            marker?: string | null;
+                            /** @description Whether there are more results available. */
+                            has_next_page: boolean;
+                        };
+                    };
+                };
+                /** @description There was an issue parsing the query parameters. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description The requestor presented a token with insufficient scopes. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description The requested resource was not found. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description The request's query parameters did not pass validation. */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -1965,10 +2184,13 @@ export interface components {
             run_monitors?: components["schemas"]["RunMonitors"];
             run_managers?: components["schemas"]["RunManagers"];
             /**
+             * @deprecated
              * @description The role the requesting user has on the Run.
              * @enum {string}
              */
-            user_role: "run_monitor" | "run_manager" | "run_owner";
+            user_role: "run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager";
+            /** @description The list of all roles the requesting user has on the Run. */
+            user_roles?: ("run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager")[];
             tags: components["schemas"]["Tags"];
         };
         ValidateRun: {
@@ -2251,10 +2473,13 @@ export interface components {
             /** @description A list of scopes according to RunAs values as defined in the Flow. */
             globus_auth_scopes_by_RunAs?: string[];
             /**
+             * @deprecated
              * @description The role the requesting user has on the Flow.
              * @enum {string}
              */
-            user_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner";
+            user_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "run_monitor" | "run_manager";
+            /** @description The list of all roles the requesting user has on the Flow. */
+            user_roles?: ("flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "flow_run_monitor" | "flow_run_manager")[];
             /**
              * @description A set of Principal URN values, or the value "public"
              *     indicating the identity of users who can view the Flow
@@ -2375,6 +2600,32 @@ export interface components {
         FlowScopes: {
             [key: string]: string[];
         };
+        RegisteredApiSummary: {
+            /**
+             * Format: uuid
+             * @description The unique identifier for the Registered API.
+             */
+            id: string;
+            /**
+             * @description A non-unique, human-friendly name used for displaying the
+             *     Registered API to end users.
+             */
+            name: string;
+            /** @description A detailed description of the Registered API. */
+            description: string;
+            /**
+             * Format: date-time
+             * @description A timezone-aware ISO8601 format string that represents the time at
+             *     which the Registered API was created.
+             */
+            created_timestamp: string;
+            /**
+             * Format: date-time
+             * @description A timezone-aware ISO8601 format string that represents the time at
+             *     which the Registered API was last updated.
+             */
+            updated_timestamp: string;
+        };
         BatchRunUpdateOperation: {
             tags?: string[];
             run_managers?: components["schemas"]["PrincipalURN"][];
@@ -2457,7 +2708,6 @@ export interface components {
          *
          *     Note that runs which are still executing will not have a completion time
          *     and will be automatically excluded if this filter is applied.
-         * @example 2021-03-09T21:52:14,2021-03-09T21:53
          */
         filter_completion_time: string;
         /**
@@ -2474,7 +2724,6 @@ export interface components {
          *
          *     Results will contain runs which began between the first datetime
          *     onwards, up to (but not including) the second datetime.
-         * @example 2021-03-09T21:52:14,2021-03-09T21:53
          */
         filter_start_time: string;
         /**
@@ -2514,10 +2763,6 @@ export interface components {
          *
          *     - `ASC`
          *     - `DESC`
-         * @example [
-         *       "title ASC",
-         *       "id DESC"
-         *     ]
          */
         list_flows_orderby: string[];
         /**
@@ -2555,12 +2800,44 @@ export interface components {
          *
          *     - `ASC`
          *     - `DESC`
-         * @example [
-         *       "start_time ASC",
-         *       "id DESC"
-         *     ]
          */
         list_runs_orderby: string[];
+        /**
+         * @description Ordering criteria to apply to the list of Registered APIs.
+         *
+         *     This field is a comma-separated list of sort criteria,
+         *     and follows this syntax:
+         *
+         *     ```
+         *     CRITERION1[,CRITERION2[,...]]
+         *     ```
+         *
+         *     and each individual `CRITERION` follows this syntax:
+         *
+         *     ```
+         *     FIELD ORDERING
+         *     ```
+         *
+         *     The first value, `FIELD`, indicates the field to sort by;
+         *     the second value, `ORDERING`, indicates the sorting order.
+         *
+         *     When additional comma-separated criteria are added,
+         *     the first criterion will be used to sort the data;
+         *     subsequent criteria will be applied for ties.
+         *
+         *     Supported fields are:
+         *
+         *     - `id`
+         *     - `name`
+         *     - `created_timestamp`
+         *     - `updated_timestamp`
+         *
+         *     Supported orderings are:
+         *
+         *     - `ASC`
+         *     - `DESC`
+         */
+        list_registered_apis_orderby: string[];
     };
     requestBodies: never;
     headers: never;