diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index 01b14d582809..10a68b595ed9 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -3047,10 +3047,7 @@ export interface components { }; /** CreateInvocationsFromStorePayload */ CreateInvocationsFromStorePayload: { - /** - * History ID - * @example 0123456789ABCDEF - */ + /** History ID */ history_id: string; /** * Legacy Job State @@ -7075,11 +7072,8 @@ export interface components { * @example 0123456789ABCDEF */ id: string; - /** - * Job ID - * @description The encoded ID of the job associated with this workflow invocation step. - */ - job_id?: string | null; + /** Job Id */ + job_id: string | null; /** * Jobs * @description Jobs associated with the workflow invocation step. @@ -7118,11 +7112,8 @@ export interface components { * @description Describes where in the scheduling process the workflow invocation step is. */ state?: components["schemas"]["InvocationStepState"] | components["schemas"]["JobState"] | null; - /** - * Subworkflow invocation ID - * @description The encoded ID of the subworkflow invocation. - */ - subworkflow_invocation_id?: string | null; + /** Subworkflow Invocation Id */ + subworkflow_invocation_id: string | null; /** * Update Time * @description The last time and date this item was updated. @@ -11343,6 +11334,7 @@ export interface operations { * configuration settings are returned. */ parameters?: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -11764,6 +11756,7 @@ export interface operations { /** Search datasets or collections using a query system. */ parameters?: { /** @description Optional identifier of a History. Use it to restrict the search within a particular History. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ /** @description The value to filter by. */ @@ -11849,6 +11842,7 @@ export interface operations { parameters: { /** @description The type of information about the dataset to be requested. */ /** @description The type of information about the dataset to be requested. Each of these values may require additional parameters in the request and may return different responses. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { hda_ldda?: components["schemas"]["DatasetSourceType"]; @@ -11948,6 +11942,7 @@ export interface operations { * **Note**: `view` and `keys` are also available to control the serialization of the dataset. */ parameters: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -13753,6 +13748,7 @@ export interface operations { /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ /** @description The maximum number of items to return. */ /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { all?: boolean | null; @@ -13795,6 +13791,7 @@ export interface operations { * @description The new history can also be copied form a existing history or imported from an archive or URL. */ parameters?: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -13837,6 +13834,7 @@ export interface operations { * Archived histories are histories are not part of the active histories of the user but they can be accessed using this endpoint. */ parameters?: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ /** @description The value to filter by. */ @@ -13908,6 +13906,7 @@ export interface operations { /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ /** @description The maximum number of items to return. */ /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { all?: boolean | null; @@ -13946,6 +13945,7 @@ export interface operations { undelete_api_histories_deleted__history_id__undelete_post: { /** Restores a deleted history with the given ID (that hasn't been purged). */ parameters: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -13981,6 +13981,7 @@ export interface operations { create_from_store_api_histories_from_store_post: { /** Create histories from a model store. */ parameters?: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -14045,6 +14046,7 @@ export interface operations { show_recent_api_histories_most_recently_used_get: { /** Returns the most recently used history of the user. */ parameters?: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -14081,6 +14083,7 @@ export interface operations { /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ /** @description The maximum number of items to return. */ /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { q?: string[] | null; @@ -14123,6 +14126,7 @@ export interface operations { /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ /** @description The maximum number of items to return. */ /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { q?: string[] | null; @@ -14160,6 +14164,7 @@ export interface operations { history_api_histories__history_id__get: { /** Returns the history with the given ID. */ parameters: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -14195,6 +14200,7 @@ export interface operations { update_api_histories__history_id__put: { /** Updates the values for the history with the given ID. */ parameters: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -14235,6 +14241,7 @@ export interface operations { delete_api_histories__history_id__delete: { /** Marks the history with the given ID as deleted. */ parameters: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { purge?: boolean; @@ -14427,6 +14434,7 @@ export interface operations { * @description Whether to return visible or hidden datasets only. Leave unset for both. */ /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ /** @description The value to filter by. */ @@ -14483,6 +14491,7 @@ export interface operations { * will be made to the items. */ parameters: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -14525,6 +14534,7 @@ export interface operations { */ parameters: { /** @description The type of the target history element. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { type?: components["schemas"]["HistoryContentType"] | null; @@ -15115,6 +15125,7 @@ export interface operations { parameters: { /** @description The type of the target history element. */ /** @description This value can be used to broadly restrict the magnitude of the number of elements returned via the API for large collections. The number of actual elements returned may be "a bit" more than this number or "a lot" less - varying on the depth of nesting, balance of nesting at each level, and size of target collection. The consumer of this API should not expect a stable number or pre-calculable number of elements to be produced given this parameter - the only promise is that this API will not respond with an order of magnitude more elements estimated with this value. The UI uses this parameter to fetch a "balanced" concept of the "start" of large collections at every depth of the collection. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { type?: components["schemas"]["HistoryContentType"]; @@ -15161,6 +15172,7 @@ export interface operations { */ parameters: { /** @description The type of the target history element. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { type?: components["schemas"]["HistoryContentType"]; @@ -15224,6 +15236,7 @@ export interface operations { * @deprecated * @description Whether to stop the creating job if all outputs of the job have been deleted. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { type?: components["schemas"]["HistoryContentType"]; @@ -15335,6 +15348,7 @@ export interface operations { * @description Whether to return visible or hidden datasets only. Leave unset for both. */ /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ /** @description The value to filter by. */ @@ -15391,6 +15405,7 @@ export interface operations { * @description Create a new `HDA` or `HDCA` in the given History. */ parameters: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -15448,6 +15463,7 @@ export interface operations { */ parameters: { /** @description This value can be used to broadly restrict the magnitude of the number of elements returned via the API for large collections. The number of actual elements returned may be "a bit" more than this number or "a lot" less - varying on the depth of nesting, balance of nesting at each level, and size of target collection. The consumer of this API should not expect a stable number or pre-calculable number of elements to be produced given this parameter - the only promise is that this API will not respond with an order of magnitude more elements estimated with this value. The UI uses this parameter to fetch a "balanced" concept of the "start" of large collections at every depth of the collection. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { fuzzy_count?: number | null; @@ -15493,6 +15509,7 @@ export interface operations { * @description Updates the values for the history content item with the given ``ID``. */ parameters: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -15556,6 +15573,7 @@ export interface operations { * @deprecated * @description Whether to stop the creating job if all outputs of the job have been deleted. */ + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { purge?: boolean | null; @@ -15726,6 +15744,7 @@ export interface operations { * or hand-crafted JSON dictionary. */ parameters: { + /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { view?: string | null; @@ -16430,19 +16449,31 @@ export interface operations { * :raises: exceptions.MessageException, exceptions.ObjectNotFound */ parameters?: { + /** @description Return only invocations for this Workflow ID */ + /** @description Return only invocations for this History ID */ + /** @description Return only invocations for this Job ID */ + /** @description Return invocations for this User ID. */ + /** @description Sort Workflow Invocations by this attribute */ + /** @description Sort in descending order? */ + /** @description Set to false to only include terminal Invocations. */ + /** @description Limit the number of invocations to return. */ + /** @description Number of invocations to skip. */ + /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ + /** @description View to be passed to the serializer */ + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ query?: { workflow_id?: string | null; history_id?: string | null; job_id?: string | null; user_id?: string | null; sort_by?: components["schemas"]["InvocationSortByEnum"] | null; - sort_desc?: boolean | null; + sort_desc?: boolean; include_terminal?: boolean | null; limit?: number | null; offset?: number | null; instance?: boolean | null; - view?: components["schemas"]["InvocationSerializationView"] | null; - step_details?: boolean | null; + view?: string | null; + step_details?: boolean; }; /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ header?: { @@ -16453,7 +16484,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["WorkflowInvocationCollectionView"][]; + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; /** @description Validation Error */ @@ -16484,7 +16515,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["WorkflowInvocationCollectionView"][]; + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; /** @description Validation Error */ @@ -21330,23 +21361,35 @@ export interface operations { * @description An alias for GET '/api/invocations' */ parameters: { + /** @description Return only invocations for this History ID */ + /** @description Return only invocations for this Job ID */ + /** @description Return invocations for this User ID. */ + /** @description Sort Workflow Invocations by this attribute */ + /** @description Sort in descending order? */ + /** @description Set to false to only include terminal Invocations. */ + /** @description Limit the number of invocations to return. */ + /** @description Number of invocations to skip. */ + /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ + /** @description View to be passed to the serializer */ + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ query?: { history_id?: string | null; job_id?: string | null; user_id?: string | null; sort_by?: components["schemas"]["InvocationSortByEnum"] | null; - sort_desc?: boolean | null; + sort_desc?: boolean; include_terminal?: boolean | null; limit?: number | null; offset?: number | null; instance?: boolean | null; - view?: components["schemas"]["InvocationSerializationView"] | null; - step_details?: boolean | null; + view?: string | null; + step_details?: boolean; }; /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ header?: { "run-as"?: string | null; }; + /** @description The encoded database identifier of the Stored Workflow. */ path: { workflow_id: string; }; @@ -21355,7 +21398,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["WorkflowInvocationCollectionView"][]; + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; /** @description Validation Error */ @@ -22285,6 +22328,7 @@ export interface operations { header?: { "run-as"?: string | null; }; + /** @description The encoded database identifier of the Stored Workflow. */ path: { workflow_id: string; };