Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[24.1] Fix datatype validation of newly built collection #18738

Merged
merged 2 commits into from
Aug 26, 2024
Merged

[24.1] Fix datatype validation of newly built collection #18738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4edaab3
Fix datatype validation of newly built collection
mvdbeek Aug 26, 2024
37f91f2
Create HDCACustom model
mvdbeek Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 158 additions & 1 deletion client/src/api/schema/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6399,6 +6399,142 @@ export interface components {
*/
visible: boolean;
};
/** HDCACustom */
HDCACustom: {
/**
* 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 | null;
/**
* Contents URL
* @description The relative URL to access the contents of this History.
*/
contents_url?: string | null;
/**
* 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 | null;
/**
* 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.
*/
elements?: components["schemas"]["DCESummary"][] | null;
/**
* Elements Datatypes
* @description A set containing all the different element datatypes in the collection.
*/
elements_datatypes?: string[] | null;
/**
* HID
* @description The index position of this item in the History.
*/
hid?: number | null;
/**
* History Content Type
* @description This is always `dataset_collection` for dataset collections.
*/
history_content_type?: "dataset_collection" | null;
/**
* History ID
* @example 0123456789ABCDEF
*/
history_id?: string;
/**
* Id
* @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;
/**
* Populated
* @description Whether the dataset collection elements (and any subcollections elements) were successfully populated.
*/
populated?: boolean | null;
/**
* 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"] | null;
/**
* 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"] | null;
/**
* Type
* @description This is always `collection` for dataset collections.
*/
type?: "collection" | 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;
/**
* Visible
* @description Whether this item is visible or hidden to the user by default.
*/
visible?: boolean | null;
};
/**
* HDCADetailed
* @description History Dataset Collection Association detailed information.
Expand Down Expand Up @@ -6580,6 +6716,11 @@ 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 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.
Expand Down Expand Up @@ -7199,6 +7340,7 @@ export interface components {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"]
)[];
Expand All @@ -7216,6 +7358,7 @@ export interface components {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"]
)[];
Expand Down Expand Up @@ -13959,7 +14102,10 @@ export interface operations {
/** @description Successful Response */
200: {
content: {
"application/json": components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"];
"application/json":
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"];
};
};
/** @description Validation Error */
Expand Down Expand Up @@ -14160,6 +14306,7 @@ export interface operations {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"]
)[];
Expand Down Expand Up @@ -14283,6 +14430,7 @@ export interface operations {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"];
};
Expand Down Expand Up @@ -17402,13 +17550,15 @@ export interface operations {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"]
| (
| components["schemas"]["HDACustom"]
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"]
)[];
Expand Down Expand Up @@ -17993,6 +18143,7 @@ export interface operations {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"];
};
Expand Down Expand Up @@ -18045,6 +18196,7 @@ export interface operations {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"];
};
Expand Down Expand Up @@ -18278,13 +18430,15 @@ export interface operations {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"]
| (
| components["schemas"]["HDACustom"]
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"]
)[];
Expand Down Expand Up @@ -18336,6 +18490,7 @@ export interface operations {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"];
};
Expand Down Expand Up @@ -18387,6 +18542,7 @@ export interface operations {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"];
};
Expand Down Expand Up @@ -18619,6 +18775,7 @@ export interface operations {
| components["schemas"]["HDADetailed"]
| components["schemas"]["HDASummary"]
| components["schemas"]["HDAInaccessible"]
| components["schemas"]["HDCACustom"]
| components["schemas"]["HDCADetailed"]
| components["schemas"]["HDCASummary"]
)[];
Expand Down
1 change: 1 addition & 0 deletions client/src/stores/collectionElementsStore.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ function mockCollection(id: string, numElements = 10): HDCASummary {
return {
id: id,
element_count: numElements,
elements_datatypes: ["txt"],
collection_type: "list",
populated_state: "ok",
populated_state_message: "",
Expand Down
17 changes: 13 additions & 4 deletions lib/galaxy/schema/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1104,6 +1104,9 @@ class HDCASummary(HDCACommon, WithModelClass):
populated_state: DatasetCollectionPopulatedState = PopulatedStateField
populated_state_message: Optional[str] = PopulatedStateMessageField
element_count: ElementCountField
elements_datatypes: Set[str] = Field(
..., description="A set containing all the different element datatypes in the collection."
)
job_source_id: Optional[EncodedDatabaseIdField] = Field(
None,
title="Job Source ID",
Expand All @@ -1128,9 +1131,6 @@ class HDCADetailed(HDCASummary):

populated: PopulatedField
elements: List[DCESummary] = ElementsField
elements_datatypes: Set[str] = Field(
..., description="A set containing all the different element datatypes in the collection."
)
implicit_collection_jobs_id: Optional[EncodedDatabaseIdField] = Field(
None,
description="Encoded ID for the ICJ object describing the collection of jobs corresponding to this collection",
Expand Down Expand Up @@ -3283,8 +3283,17 @@ class HDACustom(HDADetailed):
model_config = ConfigDict(extra="allow")


@partial_model()
class HDCACustom(HDCADetailed):
"""Can contain any serializable property of an HDCA.

Allows arbitrary custom keys to be specified in the serialization
parameters without a particular view (predefined set of keys).
"""


AnyHDA = Union[HDACustom, HDADetailed, HDASummary, HDAInaccessible]
AnyHDCA = Union[HDCADetailed, HDCASummary]
AnyHDCA = Union[HDCACustom, HDCADetailed, HDCASummary]
AnyHistoryContentItem = Annotated[
Union[
AnyHDA,
Expand Down
Loading