From 924841bd3554d00ec1a4ea3db44b7a2efe7ea0f5 Mon Sep 17 00:00:00 2001 From: heisner-tillman Date: Thu, 4 Apr 2024 19:07:07 +0200 Subject: [PATCH] Regenerate the client schema --- client/src/api/schema/schema.ts | 1180 +++++++++++++++++++++++++++---- 1 file changed, 1025 insertions(+), 155 deletions(-) diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index ca45107b5671..6f2fcca3a3b2 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -5771,6 +5771,249 @@ export interface components { visualizations?: components["schemas"]["Visualization"][] | null; [key: string]: unknown | undefined; }; + /** HDACustomWithOutputName */ + HDACustomWithOutputName: { + /** + * Accessible + * @description Whether this item is accessible to the current user due to permissions. + */ + accessible?: boolean | null; + /** + * Annotation + * @description An annotation to provide details or to help understand the purpose and usage of this item. + */ + annotation?: string | null; + /** + * API Type + * @deprecated + * @description TODO + */ + api_type?: "file" | null; + /** Copied From Ldda Id */ + copied_from_ldda_id?: string | null; + /** + * Create Time + * @description The time and date this item was created. + */ + create_time?: string | null; + /** + * Created from basename + * @description The basename of the output that produced this dataset. + */ + created_from_basename?: string | null; + /** + * Creating Job ID + * @description The encoded ID of the job that created this dataset. + */ + creating_job?: string | null; + /** + * Data Type + * @description The fully qualified name of the class implementing the data type of this dataset. + */ + data_type?: string | null; + /** + * Dataset ID + * @description The encoded ID of the dataset associated with this item. + * @example 0123456789ABCDEF + */ + dataset_id?: string; + /** + * Deleted + * @description Whether this item is marked as deleted. + */ + deleted?: boolean | null; + /** + * Display Applications + * @description Contains new-style display app urls. + */ + display_apps?: components["schemas"]["DisplayApp"][] | null; + /** + * Legacy Display Applications + * @description Contains old-style display app urls. + */ + display_types?: components["schemas"]["DisplayApp"][] | null; + /** + * Download URL + * @description The URL to download this item from the server. + */ + download_url?: string | null; + /** + * DRS ID + * @description The DRS ID of the dataset. + */ + drs_id?: string | null; + /** + * Extension + * @description The extension of the dataset. + */ + extension?: string | null; + /** + * File extension + * @description The extension of the file. + */ + file_ext?: string | null; + /** + * File Name + * @description The full path to the dataset file. + */ + file_name?: string | null; + /** + * File Size + * @description The file size in bytes. + */ + file_size?: number | null; + /** + * Genome Build + * @description TODO + */ + genome_build?: string | null; + /** + * Hashes + * @description The list of hashes associated with this dataset. + */ + hashes?: components["schemas"]["DatasetHash"][] | null; + /** + * HDA or LDDA + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + */ + hda_ldda?: components["schemas"]["DatasetSourceType"] | null; + /** + * HID + * @description The index position of this item in the History. + */ + hid?: number | null; + /** + * History Content Type + * @description This is always `dataset` for datasets. + */ + history_content_type?: "dataset" | null; + /** + * History ID + * @example 0123456789ABCDEF + */ + history_id?: string; + /** + * Id + * @example 0123456789ABCDEF + */ + id?: string; + /** + * Metadata Files + * @description Collection of metadata files associated with this dataset. + */ + meta_files?: components["schemas"]["MetadataFile"][] | null; + /** + * Metadata + * @description The metadata associated with this dataset. + */ + metadata?: Record | null; + /** + * Miscellaneous Blurb + * @description TODO + */ + misc_blurb?: string | null; + /** + * Miscellaneous Information + * @description TODO + */ + misc_info?: string | null; + /** + * Model class + * @description The name of the database model class. + * @constant + */ + model_class?: "HistoryDatasetAssociation"; + /** + * Name + * @description The name of the item. + */ + name?: string | null; + /** + * Output Name + * @description The name of the tool output + */ + output_name: string; + /** + * Peek + * @description A few lines of contents from the start of the file. + */ + peek?: string | null; + /** + * Permissions + * @description Role-based access and manage control permissions for the dataset. + */ + permissions?: components["schemas"]["DatasetPermissions"] | null; + /** + * Purged + * @description Whether this dataset has been removed from disk. + */ + purged?: boolean | null; + /** + * Rerunnable + * @description Whether the job creating this dataset can be run again. + */ + rerunnable?: boolean | null; + /** + * Resubmitted + * @description Whether the job creating this dataset has been resubmitted. + */ + resubmitted?: boolean | null; + /** + * Sources + * @description The list of sources associated with this dataset. + */ + sources?: components["schemas"]["DatasetSource"][] | null; + /** + * State + * @description The current state of this dataset. + */ + state?: components["schemas"]["DatasetState"] | null; + tags?: components["schemas"]["TagCollection"] | null; + /** + * Type + * @description This is always `file` for datasets. + */ + type?: "file" | null; + /** + * Type - ID + * @description The type and the encoded ID of this item. Used for caching. + */ + type_id?: string | null; + /** + * Update Time + * @description The last time and date this item was updated. + */ + update_time?: string | null; + /** + * URL + * @deprecated + * @description The relative URL to access this item. + */ + url?: string | null; + /** Uuid */ + uuid?: string | null; + /** + * Validated State + * @description The state of the datatype validation for this dataset. + */ + validated_state?: components["schemas"]["DatasetValidatedState"] | null; + /** + * Validated State Message + * @description The message with details about the datatype validation result for this dataset. + */ + validated_state_message?: string | null; + /** + * Visible + * @description Whether this item is visible or hidden to the user by default. + */ + visible?: boolean | null; + /** + * Visualizations + * @description The collection of visualizations that can be applied to this dataset. + */ + visualizations?: components["schemas"]["Visualization"][] | null; + [key: string]: unknown | undefined; + }; /** * HDADetailed * @description History Dataset Association detailed information. @@ -5894,7 +6137,670 @@ export interface components { * @description This is always `dataset` for datasets. * @constant */ - history_content_type: "dataset"; + history_content_type: "dataset"; + /** + * History ID + * @example 0123456789ABCDEF + */ + history_id: string; + /** + * Id + * @example 0123456789ABCDEF + */ + id: string; + /** + * Metadata Files + * @description Collection of metadata files associated with this dataset. + */ + meta_files: components["schemas"]["MetadataFile"][]; + /** + * Metadata + * @description The metadata associated with this dataset. + */ + metadata?: Record | null; + /** + * Miscellaneous Blurb + * @description TODO + */ + misc_blurb?: string | null; + /** + * Miscellaneous Information + * @description TODO + */ + misc_info?: string | null; + /** + * Model class + * @description The name of the database model class. + * @constant + */ + model_class: "HistoryDatasetAssociation"; + /** + * Name + * @description The name of the item. + */ + name: string | null; + /** + * Peek + * @description A few lines of contents from the start of the file. + */ + peek?: string | null; + /** + * Permissions + * @description Role-based access and manage control permissions for the dataset. + */ + permissions: components["schemas"]["DatasetPermissions"]; + /** + * Purged + * @description Whether this dataset has been removed from disk. + */ + purged: boolean; + /** + * Rerunnable + * @description Whether the job creating this dataset can be run again. + */ + rerunnable: boolean; + /** + * Resubmitted + * @description Whether the job creating this dataset has been resubmitted. + */ + resubmitted: boolean; + /** + * Sources + * @description The list of sources associated with this dataset. + */ + sources: components["schemas"]["DatasetSource"][]; + /** + * State + * @description The current state of this dataset. + */ + state: components["schemas"]["DatasetState"]; + tags: components["schemas"]["TagCollection"]; + /** + * Type + * @description This is always `file` for datasets. + * @default file + * @constant + */ + type?: "file"; + /** + * Type - ID + * @description The type and the encoded ID of this item. Used for caching. + */ + type_id?: string | null; + /** + * Update Time + * @description The last time and date this item was updated. + */ + update_time: string | null; + /** + * URL + * @deprecated + * @description The relative URL to access this item. + */ + url: string; + /** + * UUID + * Format: uuid4 + * @description Universal unique identifier for this dataset. + */ + uuid: string; + /** + * Validated State + * @description The state of the datatype validation for this dataset. + */ + validated_state: components["schemas"]["DatasetValidatedState"]; + /** + * Validated State Message + * @description The message with details about the datatype validation result for this dataset. + */ + validated_state_message?: string | null; + /** + * Visible + * @description Whether this item is visible or hidden to the user by default. + */ + visible: boolean; + }; + /** HDADetailedWithOutputName */ + HDADetailedWithOutputName: { + /** + * Accessible + * @description Whether this item is accessible to the current user due to permissions. + */ + accessible: boolean; + /** + * Annotation + * @description An annotation to provide details or to help understand the purpose and usage of this item. + */ + annotation: string | null; + /** + * API Type + * @deprecated + * @description TODO + * @default file + * @constant + */ + api_type?: "file"; + /** Copied From Ldda Id */ + copied_from_ldda_id?: string | null; + /** + * Create Time + * @description The time and date this item was created. + */ + create_time: string | null; + /** + * Created from basename + * @description The basename of the output that produced this dataset. + */ + created_from_basename?: string | null; + /** + * Creating Job ID + * @description The encoded ID of the job that created this dataset. + */ + creating_job: string; + /** + * Data Type + * @description The fully qualified name of the class implementing the data type of this dataset. + */ + data_type: string; + /** + * Dataset ID + * @description The encoded ID of the dataset associated with this item. + * @example 0123456789ABCDEF + */ + dataset_id: string; + /** + * Deleted + * @description Whether this item is marked as deleted. + */ + deleted: boolean; + /** + * Display Applications + * @description Contains new-style display app urls. + */ + display_apps: components["schemas"]["DisplayApp"][]; + /** + * Legacy Display Applications + * @description Contains old-style display app urls. + */ + display_types: components["schemas"]["DisplayApp"][]; + /** + * Download URL + * @description The URL to download this item from the server. + */ + download_url: string; + /** + * DRS ID + * @description The DRS ID of the dataset. + */ + drs_id: string; + /** + * Extension + * @description The extension of the dataset. + */ + extension: string | null; + /** + * File extension + * @description The extension of the file. + */ + file_ext: string; + /** + * File Name + * @description The full path to the dataset file. + */ + file_name?: string | null; + /** + * File Size + * @description The file size in bytes. + */ + file_size: number; + /** + * Genome Build + * @description TODO + * @default ? + */ + genome_build?: string | null; + /** + * Hashes + * @description The list of hashes associated with this dataset. + */ + hashes: components["schemas"]["DatasetHash"][]; + /** + * HDA or LDDA + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + * @default hda + */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + /** + * HID + * @description The index position of this item in the History. + */ + hid: number; + /** + * History Content Type + * @description This is always `dataset` for datasets. + * @constant + */ + history_content_type: "dataset"; + /** + * History ID + * @example 0123456789ABCDEF + */ + history_id: string; + /** + * Id + * @example 0123456789ABCDEF + */ + id: string; + /** + * Metadata Files + * @description Collection of metadata files associated with this dataset. + */ + meta_files: components["schemas"]["MetadataFile"][]; + /** + * Metadata + * @description The metadata associated with this dataset. + */ + metadata?: Record | null; + /** + * Miscellaneous Blurb + * @description TODO + */ + misc_blurb?: string | null; + /** + * Miscellaneous Information + * @description TODO + */ + misc_info?: string | null; + /** + * Model class + * @description The name of the database model class. + * @constant + */ + model_class: "HistoryDatasetAssociation"; + /** + * Name + * @description The name of the item. + */ + name: string | null; + /** + * Output Name + * @description The name of the tool output + */ + output_name: string; + /** + * Peek + * @description A few lines of contents from the start of the file. + */ + peek?: string | null; + /** + * Permissions + * @description Role-based access and manage control permissions for the dataset. + */ + permissions: components["schemas"]["DatasetPermissions"]; + /** + * Purged + * @description Whether this dataset has been removed from disk. + */ + purged: boolean; + /** + * Rerunnable + * @description Whether the job creating this dataset can be run again. + */ + rerunnable: boolean; + /** + * Resubmitted + * @description Whether the job creating this dataset has been resubmitted. + */ + resubmitted: boolean; + /** + * Sources + * @description The list of sources associated with this dataset. + */ + sources: components["schemas"]["DatasetSource"][]; + /** + * State + * @description The current state of this dataset. + */ + state: components["schemas"]["DatasetState"]; + tags: components["schemas"]["TagCollection"]; + /** + * Type + * @description This is always `file` for datasets. + * @default file + * @constant + */ + type?: "file"; + /** + * Type - ID + * @description The type and the encoded ID of this item. Used for caching. + */ + type_id?: string | null; + /** + * Update Time + * @description The last time and date this item was updated. + */ + update_time: string | null; + /** + * URL + * @deprecated + * @description The relative URL to access this item. + */ + url: string; + /** + * UUID + * Format: uuid4 + * @description Universal unique identifier for this dataset. + */ + uuid: string; + /** + * Validated State + * @description The state of the datatype validation for this dataset. + */ + validated_state: components["schemas"]["DatasetValidatedState"]; + /** + * Validated State Message + * @description The message with details about the datatype validation result for this dataset. + */ + validated_state_message?: string | null; + /** + * Visible + * @description Whether this item is visible or hidden to the user by default. + */ + visible: boolean; + }; + /** + * HDAObject + * @description History Dataset Association Object + */ + HDAObject: { + /** Copied From Ldda Id */ + copied_from_ldda_id?: string | null; + /** + * HDA or LDDA + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + * @default hda + */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + /** + * History ID + * @example 0123456789ABCDEF + */ + history_id: string; + /** + * History Dataset Association ID + * @example 0123456789ABCDEF + */ + id: string; + /** + * Model class + * @description The name of the database model class. + * @constant + */ + model_class: "HistoryDatasetAssociation"; + /** + * State + * @description The current state of this dataset. + */ + state: components["schemas"]["DatasetState"]; + /** Tags */ + tags: string[]; + [key: string]: unknown | undefined; + }; + /** + * HDASummary + * @description History Dataset Association summary information. + */ + HDASummary: { + /** Copied From Ldda Id */ + copied_from_ldda_id?: string | null; + /** + * Create Time + * @description The time and date this item was created. + */ + create_time: string | null; + /** + * Dataset ID + * @description The encoded ID of the dataset associated with this item. + * @example 0123456789ABCDEF + */ + dataset_id: string; + /** + * Deleted + * @description Whether this item is marked as deleted. + */ + deleted: boolean; + /** + * Extension + * @description The extension of the dataset. + */ + extension: string | null; + /** + * Genome Build + * @description TODO + * @default ? + */ + genome_build?: string | null; + /** + * HID + * @description The index position of this item in the History. + */ + hid: number; + /** + * History Content Type + * @description This is always `dataset` for datasets. + * @constant + */ + history_content_type: "dataset"; + /** + * History ID + * @example 0123456789ABCDEF + */ + history_id: string; + /** + * Id + * @example 0123456789ABCDEF + */ + id: string; + /** + * Name + * @description The name of the item. + */ + name: string | null; + /** + * Purged + * @description Whether this dataset has been removed from disk. + */ + purged: boolean; + /** + * State + * @description The current state of this dataset. + */ + state: components["schemas"]["DatasetState"]; + tags: components["schemas"]["TagCollection"]; + /** + * Type + * @description The type of this item. + */ + type: string; + /** + * Type - ID + * @description The type and the encoded ID of this item. Used for caching. + */ + type_id?: string | null; + /** + * Update Time + * @description The last time and date this item was updated. + */ + update_time: string | null; + /** + * URL + * @deprecated + * @description The relative URL to access this item. + */ + url: string; + /** + * Visible + * @description Whether this item is visible or hidden to the user by default. + */ + visible: boolean; + }; + /** HDASummaryWithOutputName */ + HDASummaryWithOutputName: { + /** Copied From Ldda Id */ + copied_from_ldda_id?: string | null; + /** + * Create Time + * @description The time and date this item was created. + */ + create_time: string | null; + /** + * Dataset ID + * @description The encoded ID of the dataset associated with this item. + * @example 0123456789ABCDEF + */ + dataset_id: string; + /** + * Deleted + * @description Whether this item is marked as deleted. + */ + deleted: boolean; + /** + * Extension + * @description The extension of the dataset. + */ + extension: string | null; + /** + * Genome Build + * @description TODO + * @default ? + */ + genome_build?: string | null; + /** + * HID + * @description The index position of this item in the History. + */ + hid: number; + /** + * History Content Type + * @description This is always `dataset` for datasets. + * @constant + */ + history_content_type: "dataset"; + /** + * History ID + * @example 0123456789ABCDEF + */ + history_id: string; + /** + * Id + * @example 0123456789ABCDEF + */ + id: string; + /** + * Name + * @description The name of the item. + */ + name: string | null; + /** + * Output Name + * @description The name of the tool output + */ + output_name: string; + /** + * Purged + * @description Whether this dataset has been removed from disk. + */ + purged: boolean; + /** + * State + * @description The current state of this dataset. + */ + state: components["schemas"]["DatasetState"]; + tags: components["schemas"]["TagCollection"]; + /** + * Type + * @description The type of this item. + */ + type: string; + /** + * Type - ID + * @description The type and the encoded ID of this item. Used for caching. + */ + type_id?: string | null; + /** + * Update Time + * @description The last time and date this item was updated. + */ + update_time: string | null; + /** + * URL + * @deprecated + * @description The relative URL to access this item. + */ + url: string; + /** + * Visible + * @description Whether this item is visible or hidden to the user by default. + */ + visible: boolean; + }; + /** + * HDCADetailed + * @description History Dataset Collection Association detailed information. + */ + HDCADetailed: { + /** + * Dataset Collection ID + * @example 0123456789ABCDEF + */ + collection_id: string; + /** + * Collection Type + * @description The type of the collection, can be `list`, `paired`, or define subcollections using `:` as separator like `list:paired` or `list:list`. + */ + collection_type: string; + /** + * Contents URL + * @description The relative URL to access the contents of this History. + */ + contents_url: string; + /** + * Create Time + * @description The time and date this item was created. + */ + create_time: string | null; + /** + * Deleted + * @description Whether this item is marked as deleted. + */ + deleted: boolean; + /** + * Element Count + * @description The number of elements contained in the dataset collection. It may be None or undefined if the collection could not be populated. + */ + element_count?: number | null; + /** + * Elements + * @description The summary information of each of the elements inside the dataset collection. + * @default [] + */ + elements?: components["schemas"]["DCESummary"][]; + /** + * Elements Datatypes + * @description A set containing all the different element datatypes in the collection. + */ + elements_datatypes: string[]; + /** + * HID + * @description The index position of this item in the History. + */ + hid: number; + /** + * History Content Type + * @description This is always `dataset_collection` for dataset collections. + * @constant + */ + history_content_type: "dataset_collection"; /** * History ID * @example 0123456789ABCDEF @@ -5906,79 +6812,59 @@ export interface components { */ id: string; /** - * Metadata Files - * @description Collection of metadata files associated with this dataset. + * Implicit Collection Jobs Id + * @description Encoded ID for the ICJ object describing the collection of jobs corresponding to this collection */ - meta_files: components["schemas"]["MetadataFile"][]; + implicit_collection_jobs_id?: string | null; /** - * Metadata - * @description The metadata associated with this dataset. + * Job Source ID + * @description The encoded ID of the Job that produced this dataset collection. Used to track the state of the job. */ - metadata?: Record | null; + job_source_id?: string | null; /** - * Miscellaneous Blurb - * @description TODO + * Job Source Type + * @description The type of job (model class) that produced this dataset collection. Used to track the state of the job. */ - misc_blurb?: string | null; + job_source_type?: components["schemas"]["JobSourceType"] | null; /** - * Miscellaneous Information - * @description TODO + * Job State Summary + * @description Overview of the job states working inside the dataset collection. */ - misc_info?: string | null; + job_state_summary?: components["schemas"]["HDCJobStateSummary"] | null; /** * Model class * @description The name of the database model class. * @constant */ - model_class: "HistoryDatasetAssociation"; + model_class: "HistoryDatasetCollectionAssociation"; /** * Name * @description The name of the item. */ name: string | null; /** - * Peek - * @description A few lines of contents from the start of the file. - */ - peek?: string | null; - /** - * Permissions - * @description Role-based access and manage control permissions for the dataset. - */ - permissions: components["schemas"]["DatasetPermissions"]; - /** - * Purged - * @description Whether this dataset has been removed from disk. - */ - purged: boolean; - /** - * Rerunnable - * @description Whether the job creating this dataset can be run again. - */ - rerunnable: boolean; - /** - * Resubmitted - * @description Whether the job creating this dataset has been resubmitted. + * Populated + * @description Whether the dataset collection elements (and any subcollections elements) were successfully populated. */ - resubmitted: boolean; + populated?: boolean; /** - * Sources - * @description The list of sources associated with this dataset. + * Populated State + * @description Indicates the general state of the elements in the dataset collection:- 'new': new dataset collection, unpopulated elements.- 'ok': collection elements populated (HDAs may or may not have errors).- 'failed': some problem populating, won't be populated. */ - sources: components["schemas"]["DatasetSource"][]; + populated_state: components["schemas"]["DatasetCollectionPopulatedState"]; /** - * State - * @description The current state of this dataset. + * Populated State Message + * @description Optional message with further information in case the population of the dataset collection failed. */ - state: components["schemas"]["DatasetState"]; + populated_state_message?: string | null; tags: components["schemas"]["TagCollection"]; /** * Type - * @description This is always `file` for datasets. - * @default file + * @description This is always `collection` for dataset collections. + * @default collection * @constant */ - type?: "file"; + type?: "collection"; /** * Type - ID * @description The type and the encoded ID of this item. Used for caching. @@ -5995,100 +6881,55 @@ export interface components { * @description The relative URL to access this item. */ url: string; - /** - * UUID - * Format: uuid4 - * @description Universal unique identifier for this dataset. - */ - uuid: string; - /** - * Validated State - * @description The state of the datatype validation for this dataset. - */ - validated_state: components["schemas"]["DatasetValidatedState"]; - /** - * Validated State Message - * @description The message with details about the datatype validation result for this dataset. - */ - validated_state_message?: string | null; /** * Visible * @description Whether this item is visible or hidden to the user by default. */ visible: boolean; }; - /** - * HDAObject - * @description History Dataset Association Object - */ - HDAObject: { - /** Copied From Ldda Id */ - copied_from_ldda_id?: string | null; + /** HDCADetailedWithOutputName */ + HDCADetailedWithOutputName: { /** - * HDA or LDDA - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - * @default hda - */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - /** - * History ID - * @example 0123456789ABCDEF - */ - history_id: string; - /** - * History Dataset Association ID + * Dataset Collection ID * @example 0123456789ABCDEF */ - id: string; + collection_id: string; /** - * Model class - * @description The name of the database model class. - * @constant + * Collection Type + * @description The type of the collection, can be `list`, `paired`, or define subcollections using `:` as separator like `list:paired` or `list:list`. */ - model_class: "HistoryDatasetAssociation"; + collection_type: string; /** - * State - * @description The current state of this dataset. + * Contents URL + * @description The relative URL to access the contents of this History. */ - state: components["schemas"]["DatasetState"]; - /** Tags */ - tags: string[]; - [key: string]: unknown | undefined; - }; - /** - * HDASummary - * @description History Dataset Association summary information. - */ - HDASummary: { - /** Copied From Ldda Id */ - copied_from_ldda_id?: string | null; + contents_url: string; /** * Create Time * @description The time and date this item was created. */ create_time: string | null; - /** - * Dataset ID - * @description The encoded ID of the dataset associated with this item. - * @example 0123456789ABCDEF - */ - dataset_id: string; /** * Deleted * @description Whether this item is marked as deleted. */ deleted: boolean; /** - * Extension - * @description The extension of the dataset. + * Element Count + * @description The number of elements contained in the dataset collection. It may be None or undefined if the collection could not be populated. */ - extension: string | null; + element_count?: number | null; /** - * Genome Build - * @description TODO - * @default ? + * Elements + * @description The summary information of each of the elements inside the dataset collection. + * @default [] */ - genome_build?: string | null; + elements?: components["schemas"]["DCESummary"][]; + /** + * Elements Datatypes + * @description A set containing all the different element datatypes in the collection. + */ + elements_datatypes: string[]; /** * HID * @description The index position of this item in the History. @@ -6096,10 +6937,10 @@ export interface components { hid: number; /** * History Content Type - * @description This is always `dataset` for datasets. + * @description This is always `dataset_collection` for dataset collections. * @constant */ - history_content_type: "dataset"; + history_content_type: "dataset_collection"; /** * History ID * @example 0123456789ABCDEF @@ -6110,27 +6951,65 @@ export interface components { * @example 0123456789ABCDEF */ id: string; + /** + * Implicit Collection Jobs Id + * @description Encoded ID for the ICJ object describing the collection of jobs corresponding to this collection + */ + implicit_collection_jobs_id?: string | null; + /** + * Job Source ID + * @description The encoded ID of the Job that produced this dataset collection. Used to track the state of the job. + */ + job_source_id?: string | null; + /** + * Job Source Type + * @description The type of job (model class) that produced this dataset collection. Used to track the state of the job. + */ + job_source_type?: components["schemas"]["JobSourceType"] | null; + /** + * Job State Summary + * @description Overview of the job states working inside the dataset collection. + */ + job_state_summary?: components["schemas"]["HDCJobStateSummary"] | null; + /** + * Model class + * @description The name of the database model class. + * @constant + */ + model_class: "HistoryDatasetCollectionAssociation"; /** * Name * @description The name of the item. */ name: string | null; /** - * Purged - * @description Whether this dataset has been removed from disk. + * Output Name + * @description The name of the tool output */ - purged: boolean; + output_name: string; /** - * State - * @description The current state of this dataset. + * Populated + * @description Whether the dataset collection elements (and any subcollections elements) were successfully populated. */ - state: components["schemas"]["DatasetState"]; + populated?: boolean; + /** + * Populated State + * @description Indicates the general state of the elements in the dataset collection:- 'new': new dataset collection, unpopulated elements.- 'ok': collection elements populated (HDAs may or may not have errors).- 'failed': some problem populating, won't be populated. + */ + populated_state: components["schemas"]["DatasetCollectionPopulatedState"]; + /** + * Populated State Message + * @description Optional message with further information in case the population of the dataset collection failed. + */ + populated_state_message?: string | null; tags: components["schemas"]["TagCollection"]; /** * Type - * @description The type of this item. + * @description This is always `collection` for dataset collections. + * @default collection + * @constant */ - type: string; + type?: "collection"; /** * Type - ID * @description The type and the encoded ID of this item. Used for caching. @@ -6154,10 +7033,10 @@ export interface components { visible: boolean; }; /** - * HDCADetailed - * @description History Dataset Collection Association detailed information. + * HDCASummary + * @description History Dataset Collection Association summary information. */ - HDCADetailed: { + HDCASummary: { /** * Dataset Collection ID * @example 0123456789ABCDEF @@ -6188,17 +7067,6 @@ export interface components { * @description The number of elements contained in the dataset collection. It may be None or undefined if the collection could not be populated. */ element_count?: number | null; - /** - * Elements - * @description The summary information of each of the elements inside the dataset collection. - * @default [] - */ - elements?: components["schemas"]["DCESummary"][]; - /** - * Elements Datatypes - * @description A set containing all the different element datatypes in the collection. - */ - elements_datatypes: string[]; /** * HID * @description The index position of this item in the History. @@ -6220,11 +7088,6 @@ export interface components { * @example 0123456789ABCDEF */ id: string; - /** - * Implicit Collection Jobs Id - * @description Encoded ID for the ICJ object describing the collection of jobs corresponding to this collection - */ - implicit_collection_jobs_id?: string | null; /** * Job Source ID * @description The encoded ID of the Job that produced this dataset collection. Used to track the state of the job. @@ -6251,11 +7114,6 @@ export interface components { * @description The name of the item. */ name: string | null; - /** - * Populated - * @description Whether the dataset collection elements (and any subcollections elements) were successfully populated. - */ - populated?: boolean; /** * Populated State * @description Indicates the general state of the elements in the dataset collection:- 'new': new dataset collection, unpopulated elements.- 'ok': collection elements populated (HDAs may or may not have errors).- 'failed': some problem populating, won't be populated. @@ -6296,11 +7154,8 @@ export interface components { */ visible: boolean; }; - /** - * HDCASummary - * @description History Dataset Collection Association summary information. - */ - HDCASummary: { + /** HDCASummaryWithOutputName */ + HDCASummaryWithOutputName: { /** * Dataset Collection ID * @example 0123456789ABCDEF @@ -6378,6 +7233,11 @@ export interface components { * @description The name of the item. */ name: string | null; + /** + * Output Name + * @description The name of the tool output + */ + output_name: string; /** * Populated State * @description Indicates the general state of the elements in the dataset collection:- 'new': new dataset collection, unpopulated elements.- 'ok': collection elements populated (HDAs may or may not have errors).- 'failed': some problem populating, won't be populated. @@ -11782,7 +12642,10 @@ export interface components { * @description The implicit dataset collections of the tool. * @default [] */ - implicit_collections?: Record[]; + implicit_collections?: ( + | components["schemas"]["HDCADetailedWithOutputName"] + | components["schemas"]["HDCASummaryWithOutputName"] + )[]; /** * Jobs * @description The jobs of the tool. @@ -11798,13 +12661,20 @@ export interface components { * @description The output dataset collections of the tool. * @default [] */ - output_collections?: Record[]; + output_collections?: ( + | components["schemas"]["HDCADetailedWithOutputName"] + | components["schemas"]["HDCASummaryWithOutputName"] + )[]; /** * Outputs * @description The outputs of the tool. * @default [] */ - outputs?: Record[]; + outputs?: ( + | components["schemas"]["HDACustomWithOutputName"] + | components["schemas"]["HDADetailedWithOutputName"] + | components["schemas"]["HDASummaryWithOutputName"] + )[]; /** * Produces Entry Points * @description Flag indicating whether the creation of the tool produces entry points.