From bcf17d407b633912c85f5b720ca6102c21f9f766 Mon Sep 17 00:00:00 2001 From: Arash Date: Fri, 3 May 2024 16:47:15 +0200 Subject: [PATCH 01/17] Add 400 error response instead of 422 --- lib/galaxy/schema/schema.py | 19 +++++++++++++++++++ lib/galaxy/webapps/base/api.py | 15 ++++++++++++++- lib/galaxy/webapps/galaxy/fast_app.py | 2 ++ 3 files changed, 35 insertions(+), 1 deletion(-) diff --git a/lib/galaxy/schema/schema.py b/lib/galaxy/schema/schema.py index e6e92e79334e..dea933eaa3ea 100644 --- a/lib/galaxy/schema/schema.py +++ b/lib/galaxy/schema/schema.py @@ -3733,3 +3733,22 @@ class PageSummaryList(RootModel): default=[], title="List with summary information of Pages.", ) + + +class DatasetSummary(Model): + id: EncodedDatabaseIdField + create_time: Optional[datetime] = CreateTimeField + update_time: Optional[datetime] = UpdateTimeField + state: DatasetStateField + deleted: bool + purged: bool + purgable: bool + file_size: int + total_size: int + uuid: UuidField + + +class MessageExceptionModel(Model): + err_msg: str + err_code: int + validation_errors: List[Dict[str, str]] diff --git a/lib/galaxy/webapps/base/api.py b/lib/galaxy/webapps/base/api.py index 3da3ba3d3900..e9cd8426a02c 100644 --- a/lib/galaxy/webapps/base/api.py +++ b/lib/galaxy/webapps/base/api.py @@ -36,6 +36,7 @@ Scope, Send, ) +from galaxy.schema.schema import MessageExceptionModel log = getLogger(__name__) @@ -239,4 +240,16 @@ def include_all_package_routers(app: FastAPI, package_name: str): for _, module in walk_controller_modules(package_name): router = getattr(module, "router", None) if router: - app.include_router(router) + responses: dict[int | str, dict[str, typing.Any]] = { + 400: { + "description": "Bad Request", + "model": MessageExceptionModel, + }, + } + app.include_router(router, responses=responses) + + +def remove_422(app: FastAPI): + for _, operations in app.openapi()["paths"].items(): + for _, metadata in operations.items(): + metadata["responses"].pop("422", None) diff --git a/lib/galaxy/webapps/galaxy/fast_app.py b/lib/galaxy/webapps/galaxy/fast_app.py index 02a191efe9a0..9bd8949853ee 100644 --- a/lib/galaxy/webapps/galaxy/fast_app.py +++ b/lib/galaxy/webapps/galaxy/fast_app.py @@ -20,6 +20,7 @@ add_request_id_middleware, GalaxyFileResponse, include_all_package_routers, + remove_422, ) from galaxy.webapps.base.webapp import config_allows_origin from galaxy.webapps.openapi.utils import get_openapi @@ -185,6 +186,7 @@ def initialize_fast_app(gx_wsgi_webapp, gx_app): else: add_request_id_middleware(app) include_all_package_routers(app, "galaxy.webapps.galaxy.api") + remove_422(app) include_legacy_openapi(app, gx_app) wsgi_handler = WSGIMiddleware(gx_wsgi_webapp) gx_app.haltables.append(("WSGI Middleware threadpool", wsgi_handler.executor.shutdown)) From 617cf2c5a78e3adba8a10cbc3dfb2b8e017c049a Mon Sep 17 00:00:00 2001 From: Arash Date: Fri, 3 May 2024 17:25:36 +0200 Subject: [PATCH 02/17] Refactor MessageExceptionModel to include ValidationErrorModel for improved error handling --- client/src/api/schema/schema.ts | 3787 +++++++++++------ lib/galaxy/schema/schema.py | 11 +- .../webapp/frontend/src/schema/schema.ts | 364 +- 3 files changed, 2924 insertions(+), 1238 deletions(-) diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index 87ab03ff8948..e60b1683dbd8 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -8,6 +8,20 @@ export interface paths { /** Returns returns an API key for authenticated user based on BaseAuth headers. */ get: operations["get_api_key_api_authenticate_baseauth_get"]; }; + "/api/cloud/storage/get": { + /** + * Gets given objects from a given cloud-based bucket to a Galaxy history. + * @deprecated + */ + post: operations["get_api_cloud_storage_get_post"]; + }; + "/api/cloud/storage/send": { + /** + * Sends given dataset(s) in a given history to a given cloud-based bucket. + * @deprecated + */ + post: operations["send_api_cloud_storage_send_post"]; + }; "/api/configuration": { /** * Return an object containing exposable configuration settings @@ -304,28 +318,6 @@ export interface paths { /** Download */ get: operations["download_api_drs_download__object_id__get"]; }; - "/api/file_source_instances": { - /** Get a list of persisted file source instances defined by the requesting user. */ - get: operations["file_sources__instances_index"]; - /** Create a user-bound file source. */ - post: operations["file_sources__create_instance"]; - }; - "/api/file_source_instances/test": { - /** Test payload for creating user-bound file source. */ - post: operations["file_sources__test_new_instance_configuration"]; - }; - "/api/file_source_instances/{user_file_source_id}": { - /** Get a persisted user file source instance. */ - get: operations["file_sources__instances_get"]; - /** Update or upgrade user file source instance. */ - put: operations["file_sources__instances_update"]; - /** Purge user file source instance. */ - delete: operations["file_sources__instances_purge"]; - }; - "/api/file_source_templates": { - /** Get a list of file source templates available to build user defined file sources from */ - get: operations["file_sources__templates_index"]; - }; "/api/folders/{folder_id}/contents": { /** * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. @@ -398,8 +390,6 @@ export interface paths { * Displays remote files available to the user. Please use /api/remote_files instead. * @deprecated * @description Lists all remote files available to the user from different sources. - * - * The total count of files and directories is returned in the 'total_matches' header. */ get: operations["index_api_ftp_files_get"]; }; @@ -1255,28 +1245,6 @@ export interface paths { */ delete: operations["delete_user_notification_api_notifications__notification_id__delete"]; }; - "/api/object_store_instances": { - /** Get a list of persisted object store instances defined by the requesting user. */ - get: operations["object_stores__instances_index"]; - /** Create a user-bound object store. */ - post: operations["object_stores__create_instance"]; - }; - "/api/object_store_instances/test": { - /** Test payload for creating user-bound object store. */ - post: operations["object_stores__test_new_instance_configuration"]; - }; - "/api/object_store_instances/{user_object_store_id}": { - /** Get a persisted user object store instance. */ - get: operations["object_stores__instances_get"]; - /** Update or upgrade user object store instance. */ - put: operations["object_stores__instances_update"]; - /** Purge user object store instance. */ - delete: operations["object_stores__instances_purge"]; - }; - "/api/object_store_templates": { - /** Get a list of object store templates available to build user defined object stores from */ - get: operations["object_stores__templates_index"]; - }; "/api/object_stores": { /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ get: operations["index_api_object_stores_get"]; @@ -1441,8 +1409,6 @@ export interface paths { /** * Displays remote files available to the user. * @description Lists all remote files available to the user from different sources. - * - * The total count of files and directories is returned in the 'total_matches' header. */ get: operations["index_api_remote_files_get"]; /** @@ -2486,7 +2452,7 @@ export interface components { | "more_stable" | "less_stable" ) - | ("cloud" | "quota" | "no_quota" | "restricted" | "user_defined"); + | ("cloud" | "quota" | "no_quota" | "restricted"); }; /** BasicRoleModel */ BasicRoleModel: { @@ -2670,7 +2636,7 @@ export interface components { * Documentation * @description Documentation or extended description for this plugin. */ - doc?: string | null; + doc: string; /** * ID * @description The `FilesSource` plugin identifier @@ -2691,15 +2657,6 @@ export interface components { * @description Only users with the roles specified here can access this files source. */ requires_roles?: string | null; - /** - * @description Features supported by this file source. - * @default { - * "pagination": false, - * "search": false, - * "sorting": false - * } - */ - supports?: components["schemas"]["FilesSourceSupports"]; /** * Type * @description The type of the plugin. @@ -2710,16 +2667,12 @@ export interface components { * @description The URI root used by this type of plugin. */ uri_root: string; - /** - * URL - * @description Optional URL that might be provided by some plugins to link to the remote source. - */ - url?: string | null; /** * Writeable * @description Whether this files source plugin allows write access. */ writable: boolean; + [key: string]: unknown | undefined; }; /** BulkOperationItemError */ BulkOperationItemError: { @@ -2796,6 +2749,85 @@ export interface components { /** Item Ids */ item_ids: string[]; }; + /** CloudDatasets */ + CloudDatasets: { + /** + * Authentication ID + * @description The ID of CloudAuthz to be used for authorizing access to the resource provider. You may get a list of the defined authorizations via `/api/cloud/authz`. Also, you can use `/api/cloud/authz/create` to define a new authorization. + * @example 0123456789ABCDEF + */ + authz_id: string; + /** + * Bucket + * @description The name of a bucket to which data should be sent (e.g., a bucket name on AWS S3). + */ + bucket: string; + /** + * Objects + * @description A list of dataset IDs belonging to the specified history that should be sent to the given bucket. If not provided, Galaxy sends all the datasets belonging the specified history. + */ + dataset_ids?: string[] | null; + /** + * History ID + * @description The ID of history from which the object should be downloaded + * @example 0123456789ABCDEF + */ + history_id: string; + /** + * Spaces to tabs + * @description A boolean value. If set to 'True', and an object with same name of the dataset to be sent already exist in the bucket, Galaxy replaces the existing object with the dataset to be sent. If set to 'False', Galaxy appends datetime to the dataset name to prevent overwriting an existing object. + * @default false + */ + overwrite_existing?: boolean | null; + }; + /** CloudDatasetsResponse */ + CloudDatasetsResponse: { + /** + * Bucket + * @description The name of bucket to which the listed datasets are queued to be sent + */ + bucket_name: string; + /** + * Failed datasets + * @description The datasets for which Galaxy failed to create (and queue) send job + */ + failed_dataset_labels: string[]; + /** + * Send datasets + * @description The datasets for which Galaxy succeeded to create (and queue) send job + */ + sent_dataset_labels: string[]; + }; + /** CloudObjects */ + CloudObjects: { + /** + * Authentication ID + * @description The ID of CloudAuthz to be used for authorizing access to the resource provider. You may get a list of the defined authorizations via `/api/cloud/authz`. Also, you can use `/api/cloud/authz/create` to define a new authorization. + * @example 0123456789ABCDEF + */ + authz_id: string; + /** + * Bucket + * @description The name of a bucket from which data should be fetched from (e.g., a bucket name on AWS S3). + */ + bucket: string; + /** + * History ID + * @description The ID of history to which the object should be received to. + * @example 0123456789ABCDEF + */ + history_id: string; + /** + * Input arguments + * @description A summary of the input arguments, which is optional and will default to {}. + */ + input_args?: components["schemas"]["InputArguments"] | null; + /** + * Objects + * @description A list of the names of objects to be fetched. + */ + objects: string[]; + }; /** CollectionElementIdentifier */ CollectionElementIdentifier: { /** @@ -3125,25 +3157,6 @@ export interface components { /** Store Dict */ store_dict?: Record | null; }; - /** CreateInstancePayload */ - CreateInstancePayload: { - /** Description */ - description?: string | null; - /** Name */ - name: string; - /** Secrets */ - secrets: { - [key: string]: string; - }; - /** Template Id */ - template_id: string; - /** Template Version */ - template_version: number; - /** Variables */ - variables: { - [key: string]: string | boolean | number; - }; - }; /** CreateInvocationsFromStorePayload */ CreateInvocationsFromStorePayload: { /** @@ -4112,6 +4125,47 @@ export interface components { */ sources: Record[]; }; + /** DatasetSummary */ + DatasetSummary: { + /** + * Create Time + * @description The time and date this item was created. + */ + create_time: string | null; + /** Deleted */ + deleted: boolean; + /** File Size */ + file_size: number; + /** + * Id + * @example 0123456789ABCDEF + */ + id: string; + /** Purgable */ + purgable: boolean; + /** Purged */ + purged: boolean; + /** + * State + * @description The current state of this dataset. + */ + state: components["schemas"]["DatasetState"]; + /** Total Size */ + total_size: number; + /** + * Update Time + * @description The last time and date this item was updated. + */ + update_time: string | null; + /** + * UUID + * Format: uuid4 + * @description Universal unique identifier for this dataset. + */ + uuid: string; + }; + /** DatasetSummaryList */ + DatasetSummaryList: components["schemas"]["DatasetSummary"][]; /** DatasetTextContentDetails */ DatasetTextContentDetails: { /** @@ -5143,43 +5197,6 @@ export interface components { */ update_time: string; }; - /** FileSourceTemplateSummaries */ - FileSourceTemplateSummaries: components["schemas"]["FileSourceTemplateSummary"][]; - /** FileSourceTemplateSummary */ - FileSourceTemplateSummary: { - /** Description */ - description: string | null; - /** - * Hidden - * @default false - */ - hidden?: boolean; - /** Id */ - id: string; - /** Name */ - name: string | null; - /** Secrets */ - secrets?: components["schemas"]["TemplateSecret"][] | null; - /** - * Type - * @enum {string} - */ - type: "ftp" | "posix" | "s3fs" | "azure"; - /** Variables */ - variables?: - | ( - | components["schemas"]["TemplateVariableString"] - | components["schemas"]["TemplateVariableInteger"] - | components["schemas"]["TemplateVariablePathComponent"] - | components["schemas"]["TemplateVariableBoolean"] - )[] - | null; - /** - * Version - * @default 0 - */ - version?: number; - }; /** FilesSourcePlugin */ FilesSourcePlugin: { /** @@ -5191,7 +5208,7 @@ export interface components { * Documentation * @description Documentation or extended description for this plugin. */ - doc?: string | null; + doc: string; /** * ID * @description The `FilesSource` plugin identifier @@ -5212,25 +5229,11 @@ export interface components { * @description Only users with the roles specified here can access this files source. */ requires_roles?: string | null; - /** - * @description Features supported by this file source. - * @default { - * "pagination": false, - * "search": false, - * "sorting": false - * } - */ - supports?: components["schemas"]["FilesSourceSupports"]; /** * Type * @description The type of the plugin. */ type: string; - /** - * URL - * @description Optional URL that might be provided by some plugins to link to the remote source. - */ - url?: string | null; /** * Writeable * @description Whether this files source plugin allows write access. @@ -5245,27 +5248,6 @@ export interface components { | components["schemas"]["BrowsableFilesSourcePlugin"] | components["schemas"]["FilesSourcePlugin"] )[]; - /** FilesSourceSupports */ - FilesSourceSupports: { - /** - * Pagination - * @description Whether this file source supports server-side pagination. - * @default false - */ - pagination?: boolean; - /** - * Search - * @description Whether this file source supports server-side search. - * @default false - */ - search?: boolean; - /** - * Sorting - * @description Whether this file source supports server-side sorting. - * @default false - */ - sorting?: boolean; - }; /** FillStepDefaultsAction */ FillStepDefaultsAction: { /** @@ -5510,15 +5492,6 @@ export interface components { */ url: string; }; - /** GroupUpdatePayload */ - GroupUpdatePayload: { - /** name of the group */ - name?: string | null; - /** role IDs */ - role_ids?: string[] | null; - /** user IDs */ - user_ids?: string[] | null; - }; /** GroupUserListResponse */ GroupUserListResponse: components["schemas"]["GroupUserResponse"][]; /** GroupUserResponse */ @@ -6038,96 +6011,11 @@ export interface components { */ visible: boolean; }; - /** - * HDAInaccessible - * @description History Dataset Association information when the user can not access it. - */ - HDAInaccessible: { - /** - * Accessible - * @constant - * @enum {boolean} - */ - accessible: false; - /** 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; - /** - * Deleted - * @description Whether this item is marked as deleted. - */ - deleted: boolean; - /** - * HID - * @description The index position of this item in the History. - */ - hid: number; - /** - * History Content Type - * @description This is always `dataset` for datasets. - * @constant - * @enum {string} - */ - 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; - /** - * 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; - }; /** * HDAObject * @description History Dataset Association Object */ HDAObject: { - /** Accessible */ - accessible?: boolean | null; /** Copied From Ldda Id */ copied_from_ldda_id?: string | null; /** @@ -6153,8 +6041,6 @@ export interface components { * @enum {string} */ model_class: "HistoryDatasetAssociation"; - /** Purged */ - purged: boolean; /** * State * @description The current state of this dataset. @@ -7062,7 +6948,6 @@ export interface components { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; @@ -7079,7 +6964,6 @@ export interface components { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; @@ -7382,6 +7266,33 @@ export interface components { */ uri: string; }; + /** InputArguments */ + InputArguments: { + /** + * Database Key + * @description Sets the database key of the objects being fetched to Galaxy. + * @default ? + */ + dbkey?: string | null; + /** + * File Type + * @description Sets the Galaxy datatype (e.g., `bam`) for the objects being fetched to Galaxy. See the following link for a complete list of Galaxy data types: https://galaxyproject.org/learn/datatypes/. + * @default auto + */ + file_type?: string | null; + /** + * Spaces to tabs + * @description A boolean value ('true' or 'false') that sets if spaces should be converted to tab in the objects being fetched to Galaxy. Applicable only if `to_posix_lines` is True + * @default false + */ + space_to_tab?: boolean | null; + /** + * POSIX line endings + * @description A boolean value ('true' or 'false'); if 'Yes', converts universal line endings to POSIX line endings. Set to 'False' if you upload a gzip, bz2 or zip archive containing a binary file. + * @default Yes + */ + to_posix_lines?: "Yes" | boolean | null; + }; /** InputDataCollectionStep */ InputDataCollectionStep: { /** @@ -8403,11 +8314,6 @@ export interface components { * @default false */ use_cached_job?: boolean | null; - /** - * Version - * @description The version of the workflow to invoke. - */ - version?: number | null; }; /** * ItemTagsCreatePayload @@ -9511,6 +9417,15 @@ export interface components { */ source: components["schemas"]["DatasetSourceType"]; }; + /** MessageExceptionModel */ + MessageExceptionModel: { + /** Err Code */ + err_code: number; + /** Err Msg */ + err_msg: string; + /** Validation Errors */ + validation_errors: components["schemas"]["ValidationErrorModel"][]; + }; /** MessageNotificationContent */ MessageNotificationContent: { /** @@ -9971,47 +9886,8 @@ export interface components { */ up_to_date: boolean; }; - /** ObjectStoreTemplateSummaries */ - ObjectStoreTemplateSummaries: components["schemas"]["ObjectStoreTemplateSummary"][]; - /** ObjectStoreTemplateSummary */ - ObjectStoreTemplateSummary: { - /** Badges */ - badges: components["schemas"]["BadgeDict"][]; - /** Description */ - description: string | null; - /** - * Hidden - * @default false - */ - hidden?: boolean; - /** Id */ - id: string; - /** Name */ - name: string | null; - /** Secrets */ - secrets?: components["schemas"]["TemplateSecret"][] | null; - /** - * Type - * @enum {string} - */ - type: "aws_s3" | "azure_blob" | "boto3" | "disk" | "generic_s3"; - /** Variables */ - variables?: - | ( - | components["schemas"]["TemplateVariableString"] - | components["schemas"]["TemplateVariableInteger"] - | components["schemas"]["TemplateVariablePathComponent"] - | components["schemas"]["TemplateVariableBoolean"] - )[] - | null; - /** - * Version - * @default 0 - */ - version?: number; - }; - /** OutputReferenceByLabel */ - OutputReferenceByLabel: { + /** OutputReferenceByLabel */ + OutputReferenceByLabel: { /** * Label * @description The unique label of the step being referenced. @@ -10440,28 +10316,12 @@ export interface components { * @enum {string} */ PersonalNotificationCategory: "message" | "new_shared_item"; - /** PluginAspectStatus */ - PluginAspectStatus: { - /** Message */ - message: string; - /** - * State - * @enum {string} - */ - state: "ok" | "not_ok" | "unknown"; - }; /** * PluginKind * @description Enum to distinguish between different kinds or categories of plugins. * @enum {string} */ PluginKind: "rfs" | "drs" | "rdm" | "stock"; - /** PluginStatus */ - PluginStatus: { - connection?: components["schemas"]["PluginAspectStatus"] | null; - template_definition: components["schemas"]["PluginAspectStatus"]; - template_settings?: components["schemas"]["PluginAspectStatus"] | null; - }; /** Position */ Position: { /** Left */ @@ -11899,92 +11759,6 @@ export interface components { * @enum {string} */ TaskState: "PENDING" | "STARTED" | "RETRY" | "FAILURE" | "SUCCESS"; - /** TemplateSecret */ - TemplateSecret: { - /** Help */ - help: string | null; - /** Label */ - label?: string | null; - /** Name */ - name: string; - }; - /** TemplateVariableBoolean */ - TemplateVariableBoolean: { - /** - * Default - * @default false - */ - default?: boolean; - /** Help */ - help: string | null; - /** Label */ - label?: string | null; - /** Name */ - name: string; - /** - * Type - * @constant - * @enum {string} - */ - type: "boolean"; - }; - /** TemplateVariableInteger */ - TemplateVariableInteger: { - /** - * Default - * @default 0 - */ - default?: number; - /** Help */ - help: string | null; - /** Label */ - label?: string | null; - /** Name */ - name: string; - /** - * Type - * @constant - * @enum {string} - */ - type: "integer"; - }; - /** TemplateVariablePathComponent */ - TemplateVariablePathComponent: { - /** Default */ - default?: string | null; - /** Help */ - help: string | null; - /** Label */ - label?: string | null; - /** Name */ - name: string; - /** - * Type - * @constant - * @enum {string} - */ - type: "path_component"; - }; - /** TemplateVariableString */ - TemplateVariableString: { - /** - * Default - * @default - */ - default?: string; - /** Help */ - help: string | null; - /** Label */ - label?: string | null; - /** Name */ - name: string; - /** - * Type - * @constant - * @enum {string} - */ - type: "string"; - }; /** ToolDataDetails */ ToolDataDetails: { /** @@ -12327,28 +12101,6 @@ export interface components { visible?: boolean | null; [key: string]: unknown; }; - /** UpdateInstancePayload */ - UpdateInstancePayload: { - /** Active */ - active?: boolean | null; - /** Description */ - description?: string | null; - /** Hidden */ - hidden?: boolean | null; - /** Name */ - name?: string | null; - /** Variables */ - variables?: { - [key: string]: string | boolean | number; - } | null; - }; - /** UpdateInstanceSecretPayload */ - UpdateInstanceSecretPayload: { - /** Secret Name */ - secret_name: string; - /** Secret Value */ - secret_value: string; - }; /** UpdateLibraryFolderPayload */ UpdateLibraryFolderPayload: { /** @@ -12530,19 +12282,6 @@ export interface components { */ action_type: "upgrade_all_steps"; }; - /** UpgradeInstancePayload */ - UpgradeInstancePayload: { - /** Secrets */ - secrets: { - [key: string]: string; - }; - /** Template Version */ - template_version: number; - /** Variables */ - variables: { - [key: string]: string | boolean | number; - }; - }; /** UpgradeSubworkflowAction */ UpgradeSubworkflowAction: { /** @@ -12644,45 +12383,6 @@ export interface components { */ enabled: boolean; }; - /** UserConcreteObjectStoreModel */ - UserConcreteObjectStoreModel: { - /** Active */ - active: boolean; - /** Badges */ - badges: components["schemas"]["BadgeDict"][]; - /** Description */ - description?: string | null; - /** Device */ - device?: string | null; - /** Hidden */ - hidden: boolean; - /** Name */ - name?: string | null; - /** Object Store Id */ - object_store_id?: string | null; - /** Private */ - private: boolean; - /** Purged */ - purged: boolean; - quota: components["schemas"]["QuotaModel"]; - /** Secrets */ - secrets: string[]; - /** Template Id */ - template_id: string; - /** Template Version */ - template_version: number; - /** - * Type - * @enum {string} - */ - type: "aws_s3" | "azure_blob" | "boto3" | "disk" | "generic_s3"; - /** Uuid */ - uuid: string; - /** Variables */ - variables: { - [key: string]: string | boolean | number; - } | null; - }; /** UserCreationPayload */ UserCreationPayload: { /** @@ -12705,11 +12405,9 @@ export interface components { UserDeletionPayload: { /** * Purge user - * @deprecated - * @description Purge the user. Deprecated, please use the `purge` query parameter instead. - * @default false + * @description Purge the user */ - purge?: boolean; + purge: boolean; }; /** UserEmail */ UserEmail: { @@ -12725,38 +12423,6 @@ export interface components { */ id: string; }; - /** UserFileSourceModel */ - UserFileSourceModel: { - /** Active */ - active: boolean; - /** Description */ - description: string | null; - /** Hidden */ - hidden: boolean; - /** Name */ - name: string; - /** Purged */ - purged: boolean; - /** Secrets */ - secrets: string[]; - /** Template Id */ - template_id: string; - /** Template Version */ - template_version: number; - /** - * Type - * @enum {string} - */ - type: "ftp" | "posix" | "s3fs" | "azure"; - /** Uri Root */ - uri_root: string; - /** Uuid */ - uuid: string; - /** Variables */ - variables: { - [key: string]: string | boolean | number; - } | null; - }; /** * UserModel * @description User in a transaction context. @@ -12960,6 +12626,17 @@ export interface components { /** Error Type */ type: string; }; + /** ValidationErrorModel */ + ValidationErrorModel: { + /** Input */ + input: Record; + /** Loc */ + loc: (number | string)[]; + /** Msg */ + msg: string; + /** Type */ + type: string; + }; /** Visualization */ Visualization: Record; /** VisualizationSummary */ @@ -13423,18 +13100,100 @@ export interface operations { "application/json": components["schemas"]["APIKeyResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_api_cloud_storage_get_post: { + /** + * Gets given objects from a given cloud-based bucket to a Galaxy history. + * @deprecated + */ + parameters?: { + /** @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; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CloudObjects"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["DatasetSummaryList"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation Error */ + 422: { + content: { + "application/json": components["schemas"]["HTTPValidationError"]; + }; + }; + }; + }; + send_api_cloud_storage_send_post: { + /** + * Sends given dataset(s) in a given history to a given cloud-based bucket. + * @deprecated + */ + parameters?: { + /** @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; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CloudDatasets"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["CloudDatasetsResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation Error */ + 422: { + content: { + "application/json": components["schemas"]["HTTPValidationError"]; + }; + }; }; }; - /** - * Return an object containing exposable configuration settings - * @description Return an object containing exposable configuration settings. - * - * A more complete list is returned if the user is an admin. - * Pass in `view` and a comma-seperated list of keys to control which - * configuration settings are returned. - */ index_api_configuration_get: { - parameters: { + /** + * Return an object containing exposable configuration settings + * @description Return an object containing exposable configuration settings. + * + * A more complete list is returned if the user is an admin. + * Pass in `view` and a comma-seperated list of keys to control which + * 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?: { /** @description View to be passed to the serializer */ view?: string | null; @@ -13453,6 +13212,12 @@ export interface operations { "application/json": Record; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13485,6 +13250,12 @@ export interface operations { }; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13513,6 +13284,12 @@ export interface operations { }[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13545,6 +13322,12 @@ export interface operations { }; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13573,6 +13356,12 @@ export interface operations { }[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13596,7 +13385,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -13626,6 +13421,12 @@ export interface operations { "application/json": components["schemas"]["DCESummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13654,6 +13455,12 @@ export interface operations { "application/json": components["schemas"]["HDCADetailed"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13691,6 +13498,12 @@ export interface operations { "application/json": components["schemas"]["DatasetCollectionContentElements"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13724,6 +13537,12 @@ export interface operations { "application/json": components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13755,6 +13574,12 @@ export interface operations { "application/json": components["schemas"]["DatasetCollectionAttributesResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13782,11 +13607,19 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; - }; - /** @description Validation Error */ - 422: { + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation Error */ + 422: { content: { "application/json": components["schemas"]["HTTPValidationError"]; }; @@ -13811,8 +13644,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -13846,6 +13683,12 @@ export interface operations { "application/json": components["schemas"]["AsyncFile"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13881,6 +13724,12 @@ export interface operations { "application/json": components["schemas"]["SuitableConverters"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13923,12 +13772,17 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -13962,6 +13816,12 @@ export interface operations { "application/json": components["schemas"]["DeleteDatasetBatchResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14001,7 +13861,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -14046,11 +13912,16 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14115,6 +13986,12 @@ export interface operations { "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14140,7 +14017,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -14173,6 +14056,12 @@ export interface operations { "application/json": components["schemas"]["ConvertedDatasetsMap"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14215,8 +14104,13 @@ export interface operations { "application/json": | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"]; + | components["schemas"]["HDASummary"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -14246,6 +14140,12 @@ export interface operations { "application/json": components["schemas"]["DatasetExtraFiles"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14273,6 +14173,12 @@ export interface operations { "application/json": components["schemas"]["DatasetTextContentDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14309,6 +14215,12 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14340,6 +14252,12 @@ export interface operations { "application/json": components["schemas"]["DatasetInheritanceChain"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14374,6 +14292,12 @@ export interface operations { "application/json": (components["schemas"]["JobMetric"] | null)[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14403,7 +14327,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -14443,6 +14373,12 @@ export interface operations { "application/json": components["schemas"]["JobDisplayParametersSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14478,6 +14414,12 @@ export interface operations { "application/json": components["schemas"]["DatasetAssociationRoles"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14509,6 +14451,12 @@ export interface operations { "application/json": components["schemas"]["DatasetStorageDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14548,8 +14496,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -14592,7 +14544,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -14621,8 +14579,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -14652,7 +14614,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -14683,6 +14651,12 @@ export interface operations { "application/json": components["schemas"]["DatatypeDetails"][] | string[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14703,13 +14677,19 @@ export interface operations { "application/json": components["schemas"]["DatatypeConverterList"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** - * Returns a dictionary/map of datatypes and EDAM data - * @description Gets a map of datatypes and their corresponding EDAM data. - */ edam_data_api_datatypes_edam_data_get: { + /** + * Returns a dictionary/map of datatypes and EDAM data + * @description Gets a map of datatypes and their corresponding EDAM data. + */ responses: { /** @description Dictionary/map of datatypes and EDAM data */ 200: { @@ -14719,14 +14699,20 @@ export interface operations { }; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** - * Returns a dictionary of datatypes and EDAM data details - * @description Gets a map of datatypes and their corresponding EDAM data. - * EDAM data contains the EDAM iri, label, and definition. - */ edam_data_detailed_api_datatypes_edam_data_detailed_get: { + /** + * Returns a dictionary of datatypes and EDAM data details + * @description Gets a map of datatypes and their corresponding EDAM data. + * EDAM data contains the EDAM iri, label, and definition. + */ responses: { /** @description Dictionary of EDAM data details containing the EDAM iri, label, and definition */ 200: { @@ -14734,13 +14720,19 @@ export interface operations { "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** - * Returns a dictionary/map of datatypes and EDAM formats - * @description Gets a map of datatypes and their corresponding EDAM formats. - */ edam_formats_api_datatypes_edam_formats_get: { + /** + * Returns a dictionary/map of datatypes and EDAM formats + * @description Gets a map of datatypes and their corresponding EDAM formats. + */ responses: { /** @description Dictionary/map of datatypes and EDAM formats */ 200: { @@ -14750,14 +14742,20 @@ export interface operations { }; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** - * Returns a dictionary of datatypes and EDAM format details - * @description Gets a map of datatypes and their corresponding EDAM formats. - * EDAM formats contain the EDAM iri, label, and definition. - */ edam_formats_detailed_api_datatypes_edam_formats_detailed_get: { + /** + * Returns a dictionary of datatypes and EDAM format details + * @description Gets a map of datatypes and their corresponding EDAM formats. + * EDAM formats contain the EDAM iri, label, and definition. + */ responses: { /** @description Dictionary of EDAM format details containing the EDAM iri, label, and definition */ 200: { @@ -14765,13 +14763,19 @@ export interface operations { "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** - * Returns mappings for data types and their implementing classes - * @description Gets mappings for data types. - */ mapping_api_datatypes_mapping_get: { + /** + * Returns mappings for data types and their implementing classes + * @description Gets mappings for data types. + */ responses: { /** @description Dictionary to map data types with their classes */ 200: { @@ -14779,13 +14783,19 @@ export interface operations { "application/json": components["schemas"]["DatatypesMap"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** - * Returns the list of all installed sniffers - * @description Gets the list of all installed data type sniffers. - */ sniffers_api_datatypes_sniffers_get: { + /** + * Returns the list of all installed sniffers + * @description Gets the list of all installed data type sniffers. + */ responses: { /** @description List of datatype sniffers */ 200: { @@ -14793,16 +14803,24 @@ export interface operations { "application/json": string[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** - * Returns all the data types extensions and their mappings - * @description Combines the datatype information from (/api/datatypes) and the - * mapping information from (/api/datatypes/mapping) into a single - * response. - */ types_and_mapping_api_datatypes_types_and_mapping_get: { - parameters: { + /** + * Returns all the data types extensions and their mappings + * @description Combines the datatype information from (/api/datatypes) and the + * mapping information from (/api/datatypes/mapping) into a single + * response. + */ + parameters?: { + /** @description Whether to return only the datatype's extension rather than the datatype's details */ + /** @description Whether to return only datatypes which can be uploaded */ query?: { /** @description Whether to return only the datatype's extension rather than the datatype's details */ extension_only?: boolean | null; @@ -14817,6 +14835,12 @@ export interface operations { "application/json": components["schemas"]["DatatypesCombinedMap"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14837,14 +14861,21 @@ export interface operations { "application/json": components["schemas"]["DisplayApplication"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** - * Reloads the list of display applications. - * @description Reloads the list of display applications. - */ display_applications_reload_api_display_applications_reload_post: { - parameters: { + /** + * Reloads the list of display applications. + * @description Reloads the list of display applications. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -14864,6 +14895,12 @@ export interface operations { "application/json": components["schemas"]["ReloadFeedback"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -14886,8 +14923,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -14897,19 +14938,56 @@ export interface operations { }; }; }; - /** Get a list of persisted file source instances defined by the requesting user. */ - file_sources__instances_index: { + /** + * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. + * @description Returns a list of a folder's contents (files and sub-folders). + * + * Additional metadata for the folder is provided in the response as a separate object containing data + * for breadcrumb path building, permissions and other folder's details. + * + * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). + * + * **Security note**: + * - Accessing a library folder or sub-folder requires only access to the parent library. + * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. + * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. + */ + index_api_folders__folder_id__contents_get: { parameters: { + query?: { + /** @description Maximum number of contents to return. */ + limit?: number; + /** @description Return contents from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, contents between position 200-299 will be returned. */ + offset?: number; + /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ + search_text?: string | null; + /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ + include_deleted?: boolean | null; + /** @description Sort results by specified field. */ + order_by?: "name" | "description" | "type" | "size" | "update_time"; + /** @description Sort results in descending order. */ + sort_desc?: boolean | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded identifier of the library folder. */ + folder_id: string; + }; }; responses: { - /** @description Successful Response */ + /** @description The contents of the folder that match the query parameters. */ 200: { content: { - "application/json": components["schemas"]["UserFileSourceModel"][]; + "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -14920,24 +14998,34 @@ export interface operations { }; }; }; - /** Create a user-bound file source. */ - file_sources__create_instance: { + /** Creates a new library file from an existing HDA/HDCA. */ + add_history_datasets_to_library_api_folders__folder_id__contents_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded identifier of the library folder. */ + folder_id: string; + }; }; requestBody: { content: { - "application/json": components["schemas"]["CreateInstancePayload"]; + "application/json": components["schemas"]["CreateLibraryFilePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserFileSourceModel"]; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -14948,24 +15036,32 @@ export interface operations { }; }; }; - /** Test payload for creating user-bound file source. */ - file_sources__test_new_instance_configuration: { + /** + * Displays information about a particular library folder. + * @description Returns detailed information about the library folder with the given ID. + */ + show_api_folders__id__get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInstancePayload"]; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["PluginStatus"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -14976,215 +15072,24 @@ export interface operations { }; }; }; - /** Get a persisted user file source instance. */ - file_sources__instances_get: { + /** + * Updates the information of an existing library folder. + * @description Updates the information of an existing library folder. + */ + update_api_folders__id__put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The UUID index for a persisted UserFileSourceStore object. */ - user_file_source_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserFileSourceModel"]; - }; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Update or upgrade user file source instance. */ - file_sources__instances_update: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The UUID index for a persisted UserFileSourceStore object. */ - user_file_source_id: string; + /** @description The encoded identifier of the library folder. */ + id: string; }; }; requestBody: { content: { - "application/json": - | components["schemas"]["UpdateInstanceSecretPayload"] - | components["schemas"]["UpgradeInstancePayload"] - | components["schemas"]["UpdateInstancePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserFileSourceModel"]; - }; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Purge user file source instance. */ - file_sources__instances_purge: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The UUID index for a persisted UserFileSourceStore object. */ - user_file_source_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 204: { - content: never; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Get a list of file source templates available to build user defined file sources from */ - file_sources__templates_index: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description A list of the configured file source templates. */ - 200: { - content: { - "application/json": components["schemas"]["FileSourceTemplateSummaries"]; - }; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** - * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. - * @description Returns a list of a folder's contents (files and sub-folders). - * - * Additional metadata for the folder is provided in the response as a separate object containing data - * for breadcrumb path building, permissions and other folder's details. - * - * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). - * - * **Security note**: - * - Accessing a library folder or sub-folder requires only access to the parent library. - * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. - * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. - */ - index_api_folders__folder_id__contents_get: { - parameters: { - query?: { - /** @description Maximum number of contents to return. */ - limit?: number; - /** @description Return contents from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, contents between position 200-299 will be returned. */ - offset?: number; - /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ - search_text?: string | null; - /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ - include_deleted?: boolean | null; - /** @description Sort results by specified field. */ - order_by?: "name" | "description" | "type" | "size" | "update_time"; - /** @description Sort results in descending order. */ - sort_desc?: boolean | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - folder_id: string; - }; - }; - responses: { - /** @description The contents of the folder that match the query parameters. */ - 200: { - content: { - "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; - }; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Creates a new library file from an existing HDA/HDCA. */ - add_history_datasets_to_library_api_folders__folder_id__contents_post: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - folder_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibraryFilePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": unknown; - }; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** - * Displays information about a particular library folder. - * @description Returns detailed information about the library folder with the given ID. - */ - show_api_folders__id__get: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; + "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; }; }; responses: { @@ -15194,39 +15099,10 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** - * Updates the information of an existing library folder. - * @description Updates the information of an existing library folder. - */ - update_api_folders__id__put: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Bad Request */ + 400: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -15264,6 +15140,12 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15298,6 +15180,12 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15333,6 +15221,12 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15376,6 +15270,12 @@ export interface operations { | components["schemas"]["LibraryAvailablePermissions"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15415,6 +15315,12 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderCurrentPermissions"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15438,7 +15344,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -15464,7 +15376,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -15475,15 +15393,18 @@ export interface operations { }; }; }; - /** - * Displays remote files available to the user. Please use /api/remote_files instead. - * @deprecated - * @description Lists all remote files available to the user from different sources. - * - * The total count of files and directories is returned in the 'total_matches' header. - */ index_api_ftp_files_get: { - parameters: { + /** + * Displays remote files available to the user. Please use /api/remote_files instead. + * @deprecated + * @description Lists all remote files available to the user from different sources. + */ + parameters?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ query?: { /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ target?: string; @@ -15495,14 +15416,6 @@ export interface operations { disable?: components["schemas"]["RemoteFilesDisableMode"] | null; /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ writeable?: boolean | null; - /** @description Maximum number of entries to return. */ - limit?: number | null; - /** @description Number of entries to skip. */ - offset?: number | null; - /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ - query?: string | null; - /** @description Sort the entries by the specified field. */ - sort_by?: string | null; }; header?: { /** @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. */ @@ -15518,6 +15431,12 @@ export interface operations { | components["schemas"]["ListJstreeResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15545,6 +15464,12 @@ export interface operations { "application/json": string[][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15583,7 +15508,13 @@ export interface operations { /** @description Information about genome build */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -15616,7 +15547,13 @@ export interface operations { /** @description Indexes for a genome id for provided type */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -15655,7 +15592,13 @@ export interface operations { /** @description Raw sequence data */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -15681,6 +15624,12 @@ export interface operations { "application/json": components["schemas"]["GroupListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15709,6 +15658,12 @@ export interface operations { "application/json": components["schemas"]["GroupListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15735,6 +15690,12 @@ export interface operations { "application/json": components["schemas"]["GroupResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15756,7 +15717,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["GroupUpdatePayload"]; + "application/json": components["schemas"]["GroupCreatePayload"]; }; }; responses: { @@ -15766,6 +15727,12 @@ export interface operations { "application/json": components["schemas"]["GroupResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15789,7 +15756,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -15815,7 +15788,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -15845,6 +15824,12 @@ export interface operations { "application/json": components["schemas"]["GroupRoleListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15874,6 +15859,12 @@ export interface operations { "application/json": components["schemas"]["GroupRoleResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15903,6 +15894,12 @@ export interface operations { "application/json": components["schemas"]["GroupRoleResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15932,6 +15929,12 @@ export interface operations { "application/json": components["schemas"]["GroupRoleResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -15955,7 +15958,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -15990,6 +15999,12 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16023,6 +16038,12 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16056,6 +16077,12 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16087,6 +16114,12 @@ export interface operations { "application/json": components["schemas"]["GroupUserListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16119,6 +16152,12 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16152,6 +16191,12 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16185,6 +16230,12 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16217,6 +16268,12 @@ export interface operations { "application/json": components["schemas"]["HelpForumSearchResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16310,6 +16367,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16351,6 +16414,12 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16392,7 +16461,17 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown[]; + "application/json": ( + | components["schemas"]["ArchivedHistorySummary"] + | components["schemas"]["ArchivedHistoryDetailed"] + | Record + )[]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -16434,6 +16513,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16472,6 +16557,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16495,6 +16586,12 @@ export interface operations { "application/json": number; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16540,6 +16637,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16576,6 +16679,12 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16613,6 +16722,12 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16641,6 +16756,12 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16673,6 +16794,12 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16716,6 +16843,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16759,6 +16892,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16795,6 +16934,12 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16836,6 +16981,12 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16878,6 +17029,12 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16923,7 +17080,16 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": + | components["schemas"]["ArchivedHistorySummary"] + | components["schemas"]["ArchivedHistoryDetailed"] + | Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -16969,6 +17135,12 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -16993,7 +17165,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown[]; + "application/json": Record[]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -17077,6 +17255,12 @@ export interface operations { "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17121,6 +17305,12 @@ export interface operations { "application/json": components["schemas"]["HistoryContentsResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17166,19 +17356,23 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] | ( | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17224,7 +17418,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -17277,7 +17477,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -17323,6 +17529,12 @@ export interface operations { "application/json": components["schemas"]["HistoryContentBulkOperationResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17351,8 +17563,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -17383,6 +17599,12 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17420,6 +17642,12 @@ export interface operations { "application/json": components["schemas"]["DatasetAssociationRoles"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17460,8 +17688,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -17505,7 +17737,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -17537,6 +17775,12 @@ export interface operations { "application/json": components["schemas"]["DatasetExtraFiles"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17565,8 +17809,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -17595,6 +17843,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17623,6 +17877,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17656,6 +17916,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17689,6 +17955,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17717,6 +17989,12 @@ export interface operations { "application/json": boolean; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17763,11 +18041,16 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17815,11 +18098,16 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17888,6 +18176,12 @@ export interface operations { "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -17920,6 +18214,12 @@ export interface operations { "application/json": Record; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18004,6 +18304,12 @@ export interface operations { | components["schemas"]["HistoryContentsWithStatsResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18048,19 +18354,23 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] | ( | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18106,11 +18416,16 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18157,11 +18472,16 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18230,6 +18550,12 @@ export interface operations { "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18272,6 +18598,12 @@ export interface operations { | components["schemas"]["WorkflowInvocationStateSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18308,6 +18640,12 @@ export interface operations { "application/json": components["schemas"]["AsyncFile"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18344,6 +18682,12 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18389,12 +18733,17 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18422,6 +18771,12 @@ export interface operations { "application/json": components["schemas"]["CustomBuildsMetadataResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18452,6 +18807,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18482,6 +18843,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18521,6 +18888,12 @@ export interface operations { "application/vnd.galaxy.task.export+json": components["schemas"]["ExportTaskListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18571,8 +18944,12 @@ export interface operations { }; }; /** @description The exported archive file is not ready yet. */ - 202: { - content: never; + 202: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -18607,8 +18984,12 @@ export interface operations { }; responses: { /** @description The archive file containing the History. */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -18655,6 +19036,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18687,6 +19074,12 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18719,6 +19112,12 @@ export interface operations { "application/json": components["schemas"]["AsyncFile"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18749,6 +19148,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18784,6 +19189,12 @@ export interface operations { "application/json": components["schemas"]["ShareHistoryWithStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18814,6 +19225,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18844,8 +19261,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -18873,6 +19294,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18900,6 +19327,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18932,6 +19365,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18964,6 +19403,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -18991,6 +19436,12 @@ export interface operations { "application/json": boolean; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19021,6 +19472,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19053,6 +19510,12 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19103,6 +19566,12 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19134,6 +19603,12 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19161,6 +19636,12 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19199,6 +19680,12 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19237,6 +19724,12 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19270,6 +19763,12 @@ export interface operations { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19302,6 +19801,12 @@ export interface operations { "application/json": components["schemas"]["AsyncFile"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19329,6 +19834,12 @@ export interface operations { "application/json": components["schemas"]["InvocationReport"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19351,8 +19862,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -19391,6 +19906,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19423,6 +19944,12 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19457,6 +19984,12 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19489,6 +20022,12 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19515,6 +20054,12 @@ export interface operations { "application/json": components["schemas"]["JobLock"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19546,6 +20091,12 @@ export interface operations { "application/json": components["schemas"]["JobLock"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19642,6 +20193,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19675,6 +20232,12 @@ export interface operations { "application/json": components["schemas"]["EncodedJobDetails"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19708,6 +20271,12 @@ export interface operations { | components["schemas"]["EncodedJobDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19740,6 +20309,12 @@ export interface operations { "application/json": boolean; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19767,6 +20342,12 @@ export interface operations { "application/json": components["schemas"]["JobInputSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19794,6 +20375,12 @@ export interface operations { "application/json": components["schemas"]["JobDestinationParams"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19826,6 +20413,12 @@ export interface operations { "application/json": components["schemas"]["JobErrorSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19853,6 +20446,12 @@ export interface operations { "application/json": components["schemas"]["JobInputAssociation"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19887,6 +20486,12 @@ export interface operations { "application/json": (components["schemas"]["JobMetric"] | null)[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19922,6 +20527,12 @@ export interface operations { "text/plain": string; }; }; + /** @description Bad Request */ + 400: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19949,6 +20560,12 @@ export interface operations { "application/json": components["schemas"]["JobOutputAssociation"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -19988,6 +20605,12 @@ export interface operations { "application/json": components["schemas"]["JobDisplayParametersSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20015,6 +20638,12 @@ export interface operations { "application/json": components["schemas"]["JobOutputAssociation"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20045,6 +20674,12 @@ export interface operations { "application/json": components["schemas"]["LibrarySummaryList"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20076,6 +20711,12 @@ export interface operations { "application/json": components["schemas"]["LibrarySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20102,6 +20743,12 @@ export interface operations { "application/json": components["schemas"]["LibrarySummaryList"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20130,6 +20777,12 @@ export interface operations { "application/json": components["schemas"]["LibrarySummary"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20160,6 +20813,12 @@ export interface operations { "application/json": components["schemas"]["LibrarySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20200,6 +20859,12 @@ export interface operations { "application/json": components["schemas"]["LibrarySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20235,6 +20900,12 @@ export interface operations { "application/json": components["schemas"]["LibrarySummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20280,6 +20951,12 @@ export interface operations { | components["schemas"]["LibraryAvailablePermissions"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20323,6 +21000,12 @@ export interface operations { | components["schemas"]["LibraryCurrentPermissions"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20343,14 +21026,20 @@ export interface operations { "application/json": components["schemas"]["LicenseMetadataModel"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** - * Gets the SPDX license metadata associated with the short identifier - * @description Returns the license metadata associated with the given - * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). - */ get_api_licenses__id__get: { + /** + * Gets the SPDX license metadata associated with the short identifier + * @description Returns the license metadata associated with the given + * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). + */ parameters: { path: { /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ @@ -20364,6 +21053,12 @@ export interface operations { "application/json": components["schemas"]["LicenseMetadataModel"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20392,7 +21087,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -20427,6 +21128,12 @@ export interface operations { "application/json": components["schemas"]["UserNotificationListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20455,6 +21162,12 @@ export interface operations { "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20488,6 +21201,12 @@ export interface operations { | components["schemas"]["AsyncTaskResultSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20516,6 +21235,12 @@ export interface operations { "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20542,6 +21267,12 @@ export interface operations { "application/json": components["schemas"]["BroadcastNotificationListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20584,6 +21315,12 @@ export interface operations { "application/json": components["schemas"]["NotificationCreatedResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20614,6 +21351,12 @@ export interface operations { "application/json": components["schemas"]["BroadcastNotificationResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20644,8 +21387,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -20676,6 +21423,12 @@ export interface operations { "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20710,6 +21463,12 @@ export interface operations { "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20739,6 +21498,12 @@ export interface operations { "application/json": components["schemas"]["NotificationStatusSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20766,6 +21531,12 @@ export interface operations { "application/json": components["schemas"]["UserNotificationResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -20793,8 +21564,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -20824,197 +21599,12 @@ export interface operations { }; }; responses: { - /** @description Successful Response */ - 204: { - content: never; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Get a list of persisted object store instances defined by the requesting user. */ - object_stores__instances_index: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"][]; - }; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Create a user-bound object store. */ - object_stores__create_instance: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInstancePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; - }; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Test payload for creating user-bound object store. */ - object_stores__test_new_instance_configuration: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInstancePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["PluginStatus"]; - }; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Get a persisted user object store instance. */ - object_stores__instances_get: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The UUID used to identify a persisted UserObjectStore object. */ - user_object_store_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; - }; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Update or upgrade user object store instance. */ - object_stores__instances_update: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The UUID used to identify a persisted UserObjectStore object. */ - user_object_store_id: string; - }; - }; - requestBody: { - content: { - "application/json": - | components["schemas"]["UpdateInstanceSecretPayload"] - | components["schemas"]["UpgradeInstancePayload"] - | components["schemas"]["UpdateInstancePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; - }; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Purge user object store instance. */ - object_stores__instances_purge: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The UUID used to identify a persisted UserObjectStore object. */ - user_object_store_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 204: { - content: never; - }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - /** Get a list of object store templates available to build user defined object stores from */ - object_stores__templates_index: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description A list of the configured object store templates. */ - 200: { + /** @description Successful Response */ + 204: never; + /** @description Bad Request */ + 400: { content: { - "application/json": components["schemas"]["ObjectStoreTemplateSummaries"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -21041,10 +21631,13 @@ export interface operations { /** @description A list of the configured object stores. */ 200: { content: { - "application/json": ( - | components["schemas"]["ConcreteObjectStoreModel"] - | components["schemas"]["UserConcreteObjectStoreModel"] - )[]; + "application/json": components["schemas"]["ConcreteObjectStoreModel"][]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -21074,6 +21667,12 @@ export interface operations { "application/json": components["schemas"]["ConcreteObjectStoreModel"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21151,6 +21750,12 @@ export interface operations { "application/json": components["schemas"]["PageSummaryList"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21182,6 +21787,12 @@ export interface operations { "application/json": components["schemas"]["PageSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21212,6 +21823,12 @@ export interface operations { "application/json": components["schemas"]["PageDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21237,8 +21854,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -21272,6 +21893,12 @@ export interface operations { "application/pdf": unknown; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21306,6 +21933,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21336,6 +21969,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21368,6 +22007,12 @@ export interface operations { "application/json": components["schemas"]["AsyncFile"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21402,6 +22047,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21437,6 +22088,12 @@ export interface operations { "application/json": components["schemas"]["ShareWithStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21467,6 +22124,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21497,8 +22160,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -21525,8 +22192,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -21558,6 +22229,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21584,6 +22261,12 @@ export interface operations { "application/json": components["schemas"]["QuotaSummaryList"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21615,6 +22298,12 @@ export interface operations { "application/json": components["schemas"]["CreateQuotaResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21641,6 +22330,12 @@ export interface operations { "application/json": components["schemas"]["QuotaSummaryList"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21671,6 +22366,12 @@ export interface operations { "application/json": components["schemas"]["QuotaDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21701,6 +22402,12 @@ export interface operations { "application/json": string; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21731,6 +22438,12 @@ export interface operations { "application/json": components["schemas"]["QuotaDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21766,6 +22479,12 @@ export interface operations { "application/json": string; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21801,6 +22520,12 @@ export interface operations { "application/json": string; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21828,6 +22553,12 @@ export interface operations { "application/json": string; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21836,14 +22567,17 @@ export interface operations { }; }; }; - /** - * Displays remote files available to the user. - * @description Lists all remote files available to the user from different sources. - * - * The total count of files and directories is returned in the 'total_matches' header. - */ index_api_remote_files_get: { - parameters: { + /** + * Displays remote files available to the user. + * @description Lists all remote files available to the user from different sources. + */ + parameters?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ query?: { /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ target?: string; @@ -21855,14 +22589,6 @@ export interface operations { disable?: components["schemas"]["RemoteFilesDisableMode"] | null; /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ writeable?: boolean | null; - /** @description Maximum number of entries to return. */ - limit?: number | null; - /** @description Number of entries to skip. */ - offset?: number | null; - /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ - query?: string | null; - /** @description Sort the entries by the specified field. */ - sort_by?: string | null; }; header?: { /** @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. */ @@ -21878,6 +22604,12 @@ export interface operations { | components["schemas"]["ListJstreeResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21909,6 +22641,12 @@ export interface operations { "application/json": components["schemas"]["CreatedEntryResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21943,6 +22681,12 @@ export interface operations { "application/json": components["schemas"]["FilesSourcePluginList"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21966,6 +22710,12 @@ export interface operations { "application/json": components["schemas"]["RoleListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -21994,6 +22744,12 @@ export interface operations { "application/json": components["schemas"]["RoleModelResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22020,6 +22776,12 @@ export interface operations { "application/json": components["schemas"]["RoleModelResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22046,6 +22808,12 @@ export interface operations { "application/json": components["schemas"]["RoleModelResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22072,6 +22840,12 @@ export interface operations { "application/json": components["schemas"]["RoleModelResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22098,6 +22872,12 @@ export interface operations { "application/json": components["schemas"]["RoleModelResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22119,8 +22899,12 @@ export interface operations { content: never; }; /** @description Request was cancelled without an exception condition recorded. */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -22144,6 +22928,12 @@ export interface operations { "application/json": boolean; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22175,6 +22965,12 @@ export interface operations { "application/json": components["schemas"]["StorageItemsCleanupResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22206,6 +23002,12 @@ export interface operations { "application/json": components["schemas"]["StoredItem"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22229,6 +23031,12 @@ export interface operations { "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22260,6 +23068,12 @@ export interface operations { "application/json": components["schemas"]["StorageItemsCleanupResult"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22291,6 +23105,12 @@ export interface operations { "application/json": components["schemas"]["StoredItem"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22314,6 +23134,12 @@ export interface operations { "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22345,6 +23171,12 @@ export interface operations { "application/json": components["schemas"]["StoredItem"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22368,6 +23200,12 @@ export interface operations { "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22397,8 +23235,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -22422,6 +23264,12 @@ export interface operations { "application/json": components["schemas"]["TaskState"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22442,11 +23290,17 @@ export interface operations { "application/json": components["schemas"]["ToolDataEntryList"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** Import a data manager bundle */ create_api_tool_data_post: { - parameters: { + /** Import a data manager bundle */ + parameters?: { query?: { tool_data_file_path?: string | null; }; @@ -22467,6 +23321,12 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22497,6 +23357,12 @@ export interface operations { "application/json": components["schemas"]["ToolDataDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22532,6 +23398,12 @@ export interface operations { "application/json": components["schemas"]["ToolDataDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22564,6 +23436,12 @@ export interface operations { "application/json": components["schemas"]["ToolDataField"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22593,8 +23471,12 @@ export interface operations { }; responses: { /** @description Information about a data table field */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -22626,6 +23508,12 @@ export interface operations { "application/json": components["schemas"]["ToolDataDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22657,6 +23545,12 @@ export interface operations { "application/json": components["schemas"]["InstalledToolShedRepository"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22683,6 +23577,12 @@ export interface operations { "application/json": components["schemas"]["CheckForUpdatesResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22706,6 +23606,12 @@ export interface operations { "application/json": components["schemas"]["InstalledToolShedRepository"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22731,7 +23637,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -22754,13 +23666,19 @@ export interface operations { "application/json": components["schemas"]["TourList"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** - * Show - * @description Return a tour definition. - */ show_api_tours__tour_id__get: { + /** + * Show + * @description Return a tour definition. + */ parameters: { path: { tour_id: string; @@ -22773,6 +23691,12 @@ export interface operations { "application/json": components["schemas"]["TourDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22802,6 +23726,12 @@ export interface operations { "application/json": components["schemas"]["TourDetails"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22841,6 +23771,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22871,6 +23807,12 @@ export interface operations { "application/json": components["schemas"]["CreatedUserModel"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22900,8 +23842,12 @@ export interface operations { }; }; /** @description The background task was submitted but there is no status tracking ID available. */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -22940,6 +23886,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22969,6 +23921,12 @@ export interface operations { | components["schemas"]["AnonUserModel"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -22996,6 +23954,12 @@ export interface operations { "application/json": components["schemas"]["DetailedUserModel"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23026,8 +23990,12 @@ export interface operations { }; }; /** @description The background task was submitted but there is no status tracking ID available. */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -23062,6 +24030,12 @@ export interface operations { | components["schemas"]["AnonUserModel"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23098,6 +24072,12 @@ export interface operations { "application/json": components["schemas"]["DetailedUserModel"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23109,10 +24089,7 @@ export interface operations { /** Delete a user. Only admins can delete others or purge users. */ delete_user_api_users__user_id__delete: { parameters: { - query?: { - /** @description Whether to definitely remove this user. Only deleted users can be purged. */ - purge?: 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?: { /** @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. */ "run-as"?: string | null; @@ -23134,6 +24111,12 @@ export interface operations { "application/json": components["schemas"]["DetailedUserModel"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23161,6 +24144,12 @@ export interface operations { "application/json": string; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23188,6 +24177,12 @@ export interface operations { "application/json": string; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23210,8 +24205,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -23241,8 +24240,12 @@ export interface operations { }; }; /** @description The user doesn't have an API key. */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -23274,6 +24277,12 @@ export interface operations { "application/json": components["schemas"]["UserBeaconSetting"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23309,6 +24318,12 @@ export interface operations { "application/json": components["schemas"]["UserBeaconSetting"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23336,6 +24351,12 @@ export interface operations { "application/json": components["schemas"]["CustomBuildsCollection"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23367,7 +24388,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -23399,6 +24426,12 @@ export interface operations { "application/json": components["schemas"]["DeletedCustomBuild"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23433,6 +24466,12 @@ export interface operations { "application/json": components["schemas"]["FavoriteObjectsSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23464,6 +24503,12 @@ export interface operations { "application/json": components["schemas"]["FavoriteObjectsSummary"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23491,6 +24536,12 @@ export interface operations { "application/json": components["schemas"]["UserObjectstoreUsage"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23519,8 +24570,12 @@ export interface operations { }; }; /** @description The background task was submitted but there is no status tracking ID available. */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -23546,7 +24601,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -23578,6 +24639,12 @@ export interface operations { "application/json": string; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23605,6 +24672,12 @@ export interface operations { "application/json": components["schemas"]["UserQuotaUsage"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23634,6 +24707,12 @@ export interface operations { "application/json": components["schemas"]["UserQuotaUsage"] | null; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23654,62 +24733,68 @@ export interface operations { "application/json": Record; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - /** Returns visualizations for the current user. */ index_api_visualizations_get: { - parameters: { + /** Returns visualizations for the current user. */ + parameters?: { + /** @description Whether to include deleted visualizations in the result. */ + /** @description The maximum number of items to return. */ + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + /** @description Sort visualization index by this specified attribute on the visualization model */ + /** @description Sort in descending order? */ + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `title` + * : The visualization's title. + * + * `slug` + * : The visualization's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The visualization's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `user` + * : The visualization's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Visualizations: `title`, `slug`, `tag`, `type`. + */ query?: { - /** @description Whether to include deleted visualizations in the result. */ deleted?: boolean; - /** @description The maximum number of items to return. */ limit?: number | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ offset?: number | null; user_id?: string | null; show_own?: boolean; show_published?: boolean; show_shared?: boolean; - /** @description Sort visualization index by this specified attribute on the visualization model */ sort_by?: "create_time" | "title" | "update_time" | "username"; - /** @description Sort in descending order? */ sort_desc?: boolean; - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `title` - * : The visualization's title. - * - * `slug` - * : The visualization's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The visualization's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `user` - * : The visualization's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Visualizations: `title`, `slug`, `tag`, `type`. - */ search?: string | null; }; header?: { @@ -23724,6 +24809,12 @@ export interface operations { "application/json": components["schemas"]["VisualizationSummaryList"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23754,6 +24845,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23784,6 +24881,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23814,6 +24917,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23849,6 +24958,12 @@ export interface operations { "application/json": components["schemas"]["ShareWithStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23879,6 +24994,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23909,8 +25030,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -23942,6 +25067,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -23968,6 +25099,12 @@ export interface operations { "application/json": components["schemas"]["UserModel"] | null; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24052,6 +25189,12 @@ export interface operations { "application/json": Record[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24082,7 +25225,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -24119,6 +25268,12 @@ export interface operations { "application/json": components["schemas"]["StoredWorkflowDetailed"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24143,7 +25298,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -24177,6 +25338,12 @@ export interface operations { "application/json": components["schemas"]["RootModel_Dict_str__int__"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24207,6 +25374,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24237,6 +25410,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24288,6 +25467,12 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24322,6 +25507,12 @@ export interface operations { | components["schemas"]["WorkflowInvocationResponse"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24365,6 +25556,12 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24408,6 +25605,12 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24440,6 +25643,12 @@ export interface operations { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24472,6 +25681,12 @@ export interface operations { "application/json": components["schemas"]["InvocationReport"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24499,8 +25714,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -24538,6 +25757,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24572,6 +25797,12 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24611,6 +25842,12 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24641,6 +25878,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24676,6 +25919,12 @@ export interface operations { "application/json": components["schemas"]["RefactorResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24711,6 +25960,12 @@ export interface operations { "application/json": components["schemas"]["ShareWithStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24741,6 +25996,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24771,8 +26032,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 204: { - content: never; + 204: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -24800,6 +26065,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24827,6 +26098,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24859,6 +26136,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24891,6 +26174,12 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24918,6 +26207,12 @@ export interface operations { "application/json": boolean; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -24942,7 +26237,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -24975,6 +26276,12 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25029,6 +26336,12 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25066,6 +26379,12 @@ export interface operations { | components["schemas"]["WorkflowInvocationResponse"][]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25110,6 +26429,12 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25154,6 +26479,12 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25187,6 +26518,12 @@ export interface operations { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25220,6 +26557,12 @@ export interface operations { "application/json": components["schemas"]["InvocationReport"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25248,8 +26591,12 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { - content: never; + 200: never; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; /** @description Validation Error */ 422: { @@ -25288,6 +26635,12 @@ export interface operations { )[]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25323,6 +26676,12 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25363,6 +26722,12 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25390,7 +26755,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -25420,6 +26791,12 @@ export interface operations { "application/json": components["schemas"]["DrsObject"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25447,6 +26824,12 @@ export interface operations { "application/json": components["schemas"]["DrsObject"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Validation Error */ 422: { content: { @@ -25473,7 +26856,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -25502,7 +26891,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown; + "application/json": Record; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation Error */ @@ -25522,6 +26917,12 @@ export interface operations { "application/json": components["schemas"]["Service"]; }; }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; } diff --git a/lib/galaxy/schema/schema.py b/lib/galaxy/schema/schema.py index dea933eaa3ea..edfc3bd68cd3 100644 --- a/lib/galaxy/schema/schema.py +++ b/lib/galaxy/schema/schema.py @@ -3748,7 +3748,14 @@ class DatasetSummary(Model): uuid: UuidField -class MessageExceptionModel(Model): +class ValidationErrorModel(BaseModel): + type: str + loc: tuple[int | str, ...] + msg: str + input: Any + + +class MessageExceptionModel(BaseModel): err_msg: str err_code: int - validation_errors: List[Dict[str, str]] + validation_errors: List[ValidationErrorModel] diff --git a/lib/tool_shed/webapp/frontend/src/schema/schema.ts b/lib/tool_shed/webapp/frontend/src/schema/schema.ts index 7ecc1ae87879..8d12a61e82c4 100644 --- a/lib/tool_shed/webapp/frontend/src/schema/schema.ts +++ b/lib/tool_shed/webapp/frontend/src/schema/schema.ts @@ -424,6 +424,15 @@ export interface components { metadata_info?: components["schemas"]["RepositoryMetadataInstallInfo"] | null repo_info?: components["schemas"]["RepositoryExtraInstallInfo"] | null } + /** MessageExceptionModel */ + MessageExceptionModel: { + /** Err Code */ + err_code: number + /** Err Msg */ + err_msg: string + /** Validation Errors */ + validation_errors: components["schemas"]["ValidationErrorModel"][] + } /** Organization */ Organization: { /** @@ -1018,6 +1027,17 @@ export interface components { /** Error Type */ type: string } + /** ValidationErrorModel */ + ValidationErrorModel: { + /** Input */ + input: Record + /** Loc */ + loc: (number | string)[] + /** Msg */ + msg: string + /** Type */ + type: string + } /** Version */ Version: { /** @@ -1052,13 +1072,19 @@ export interface operations { "application/json": components["schemas"]["APIKeyResponse"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** - * Index - * @description index category - */ categories__index: { + /** + * Index + * @description index category + */ responses: { /** @description Successful Response */ 200: { @@ -1066,13 +1092,19 @@ export interface operations { "application/json": components["schemas"]["Category"][] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** - * Create - * @description create a category - */ categories__create: { + /** + * Create + * @description create a category + */ requestBody: { content: { "application/json": components["schemas"]["CreateCategoryRequest"] @@ -1085,6 +1117,12 @@ export interface operations { "application/json": components["schemas"]["Category"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1111,6 +1149,12 @@ export interface operations { "application/json": components["schemas"]["Category"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1143,6 +1187,12 @@ export interface operations { "application/json": components["schemas"]["RepositoriesByCategory"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1160,10 +1210,16 @@ export interface operations { "application/json": components["schemas"]["Service"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** Tool Classes */ tools__trs_tool_classes: { + /** Tool Classes */ responses: { /** @description Successful Response */ 200: { @@ -1171,10 +1227,16 @@ export interface operations { "application/json": components["schemas"]["ToolClass"][] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** Trs Index */ tools__trs_index: { + /** Trs Index */ responses: { /** @description Successful Response */ 200: { @@ -1182,10 +1244,16 @@ export interface operations { "application/json": unknown } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** Trs Get */ tools__trs_get: { + /** Trs Get */ parameters: { path: { /** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */ @@ -1199,6 +1267,12 @@ export interface operations { "application/json": components["schemas"]["Tool"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1222,6 +1296,12 @@ export interface operations { "application/json": components["schemas"]["ToolVersion"][] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1254,6 +1334,12 @@ export interface operations { | components["schemas"]["Repository"][] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1279,6 +1365,12 @@ export interface operations { "application/json": components["schemas"]["Repository"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1306,6 +1398,12 @@ export interface operations { "application/json": string[] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1333,7 +1431,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown[] + "application/json": Record[] + } + } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] } } /** @description Validation Error */ @@ -1366,6 +1470,12 @@ export interface operations { "application/json": components["schemas"]["InstallInfo"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1386,10 +1496,16 @@ export interface operations { "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** Updates */ repositories__update: { + /** Updates */ parameters: { query: { owner?: string | null @@ -1402,7 +1518,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown + "application/json": Record + } + } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] } } /** @description Validation Error */ @@ -1428,6 +1550,12 @@ export interface operations { "application/json": components["schemas"]["DetailedRepository"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1451,6 +1579,12 @@ export interface operations { "application/json": string[] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1476,6 +1610,12 @@ export interface operations { "application/json": string[] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1501,6 +1641,12 @@ export interface operations { "application/json": string[] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1536,6 +1682,12 @@ export interface operations { "application/json": components["schemas"]["RepositoryUpdate"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1554,8 +1706,12 @@ export interface operations { } responses: { /** @description Successful Response */ - 204: { - content: never + 204: never + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } /** @description Validation Error */ 422: { @@ -1575,8 +1731,12 @@ export interface operations { } responses: { /** @description Successful Response */ - 204: { - content: never + 204: never + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } /** @description Validation Error */ 422: { @@ -1608,6 +1768,12 @@ export interface operations { "application/json": Record } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1631,6 +1797,12 @@ export interface operations { "application/json": components["schemas"]["RepositoryPermissions"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1657,6 +1829,12 @@ export interface operations { "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1677,8 +1855,12 @@ export interface operations { } responses: { /** @description Successful Response */ - 204: { - content: never + 204: never + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } /** @description Validation Error */ 422: { @@ -1700,8 +1882,12 @@ export interface operations { } responses: { /** @description Successful Response */ - 204: { - content: never + 204: never + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } /** @description Validation Error */ 422: { @@ -1731,6 +1917,12 @@ export interface operations { "application/json": components["schemas"]["RepositoryRevisionReadmes"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1752,7 +1944,13 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": unknown + "application/json": Record + } + } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] } } /** @description Validation Error */ @@ -1776,13 +1974,19 @@ export interface operations { "application/json": components["schemas"]["BuildSearchIndexResponse"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** - * Index - * @description index users - */ users__index: { + /** + * Index + * @description index users + */ responses: { /** @description Successful Response */ 200: { @@ -1790,13 +1994,19 @@ export interface operations { "application/json": components["schemas"]["UserV2"][] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** - * Create - * @description create a user - */ users__create: { + /** + * Create + * @description create a user + */ requestBody: { content: { "application/json": components["schemas"]["CreateUserRequest"] @@ -1809,6 +2019,12 @@ export interface operations { "application/json": components["schemas"]["UserV2"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1829,13 +2045,19 @@ export interface operations { "application/json": components["schemas"]["UserV2"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** - * Show - * @description show a user - */ users__show: { + /** + * Show + * @description show a user + */ parameters: { path: { /** @description The encoded database identifier of the user. */ @@ -1849,6 +2071,12 @@ export interface operations { "application/json": components["schemas"]["UserV2"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1872,6 +2100,12 @@ export interface operations { "application/json": string } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1895,6 +2129,12 @@ export interface operations { "application/json": string } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -1913,8 +2153,12 @@ export interface operations { } responses: { /** @description Successful Response */ - 204: { - content: never + 204: never + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } /** @description Validation Error */ 422: { @@ -1933,13 +2177,19 @@ export interface operations { "application/json": components["schemas"]["Version"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** - * Change Password - * @description reset a user - */ users__internal_change_password: { + /** + * Change Password + * @description reset a user + */ requestBody: { content: { "application/json": components["schemas"]["UiChangePasswordRequest"] @@ -1947,8 +2197,12 @@ export interface operations { } responses: { /** @description Successful Response */ - 204: { - content: never + 204: never + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } /** @description Validation Error */ 422: { @@ -1975,6 +2229,12 @@ export interface operations { "application/json": components["schemas"]["UiLoginResponse"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -2000,6 +2260,12 @@ export interface operations { "application/json": components["schemas"]["UiLogoutResponse"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -2025,6 +2291,12 @@ export interface operations { "application/json": components["schemas"]["UiRegisterResponse"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { @@ -2055,6 +2327,12 @@ export interface operations { "application/json": components["schemas"]["RepositoryMetadata"] } } + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Validation Error */ 422: { content: { From 21b5853ddbb53a09a3d1531d2c446f1255db5f7c Mon Sep 17 00:00:00 2001 From: Arash Date: Fri, 3 May 2024 17:29:42 +0200 Subject: [PATCH 03/17] sort imports --- lib/galaxy/webapps/base/api.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/galaxy/webapps/base/api.py b/lib/galaxy/webapps/base/api.py index e9cd8426a02c..ba400a53d80d 100644 --- a/lib/galaxy/webapps/base/api.py +++ b/lib/galaxy/webapps/base/api.py @@ -36,8 +36,8 @@ Scope, Send, ) -from galaxy.schema.schema import MessageExceptionModel +from galaxy.schema.schema import MessageExceptionModel log = getLogger(__name__) From 33cb722c329339b955791bd7ada7fabc8bb652a4 Mon Sep 17 00:00:00 2001 From: Arash Date: Mon, 6 May 2024 18:22:02 +0200 Subject: [PATCH 04/17] Fix type annotation in ValidationErrorModel --- lib/galaxy/schema/schema.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/galaxy/schema/schema.py b/lib/galaxy/schema/schema.py index edfc3bd68cd3..9a3cca2919f7 100644 --- a/lib/galaxy/schema/schema.py +++ b/lib/galaxy/schema/schema.py @@ -3750,7 +3750,7 @@ class DatasetSummary(Model): class ValidationErrorModel(BaseModel): type: str - loc: tuple[int | str, ...] + loc: tuple[Union[int, str], ...] msg: str input: Any From 54e256041f8bc0eb098f55f875f73ad1cea5e511 Mon Sep 17 00:00:00 2001 From: Arash Date: Tue, 7 May 2024 11:49:33 +0200 Subject: [PATCH 05/17] Fix type annotation in ValidationErrorModel --- client/src/api/schema/schema.ts | 2 +- lib/galaxy/schema/schema.py | 2 +- lib/tool_shed/webapp/frontend/src/schema/schema.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index e60b1683dbd8..f5bae03e5160 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -12631,7 +12631,7 @@ export interface components { /** Input */ input: Record; /** Loc */ - loc: (number | string)[]; + loc: number[]; /** Msg */ msg: string; /** Type */ diff --git a/lib/galaxy/schema/schema.py b/lib/galaxy/schema/schema.py index 9a3cca2919f7..e26fa87efc1d 100644 --- a/lib/galaxy/schema/schema.py +++ b/lib/galaxy/schema/schema.py @@ -3750,7 +3750,7 @@ class DatasetSummary(Model): class ValidationErrorModel(BaseModel): type: str - loc: tuple[Union[int, str], ...] + loc: tuple[int, ...] msg: str input: Any diff --git a/lib/tool_shed/webapp/frontend/src/schema/schema.ts b/lib/tool_shed/webapp/frontend/src/schema/schema.ts index 8d12a61e82c4..97cf0929ca39 100644 --- a/lib/tool_shed/webapp/frontend/src/schema/schema.ts +++ b/lib/tool_shed/webapp/frontend/src/schema/schema.ts @@ -1032,7 +1032,7 @@ export interface components { /** Input */ input: Record /** Loc */ - loc: (number | string)[] + loc: number[] /** Msg */ msg: string /** Type */ From 760f518586f7ad8757c6b75e36bbd09fedae49c0 Mon Sep 17 00:00:00 2001 From: Arash Date: Tue, 7 May 2024 14:39:28 +0200 Subject: [PATCH 06/17] Fix type annotation in ValidationErrorModel --- lib/galaxy/schema/schema.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/galaxy/schema/schema.py b/lib/galaxy/schema/schema.py index e26fa87efc1d..d0383b70cba6 100644 --- a/lib/galaxy/schema/schema.py +++ b/lib/galaxy/schema/schema.py @@ -3750,7 +3750,7 @@ class DatasetSummary(Model): class ValidationErrorModel(BaseModel): type: str - loc: tuple[int, ...] + loc: List[int] msg: str input: Any From 6f4f08b56314de00cc09e48fc666433be417e668 Mon Sep 17 00:00:00 2001 From: Arash Date: Tue, 7 May 2024 14:54:55 +0200 Subject: [PATCH 07/17] Refactor API responses type annotations --- lib/galaxy/webapps/base/api.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/galaxy/webapps/base/api.py b/lib/galaxy/webapps/base/api.py index ba400a53d80d..c6891f32ef37 100644 --- a/lib/galaxy/webapps/base/api.py +++ b/lib/galaxy/webapps/base/api.py @@ -240,7 +240,7 @@ def include_all_package_routers(app: FastAPI, package_name: str): for _, module in walk_controller_modules(package_name): router = getattr(module, "router", None) if router: - responses: dict[int | str, dict[str, typing.Any]] = { + responses: typing.Dict[int, typing.Dict[str, typing.Any]] = { 400: { "description": "Bad Request", "model": MessageExceptionModel, From 9d18fc8b840fcb42634b22bb80f27963c1fd200f Mon Sep 17 00:00:00 2001 From: Arash Date: Tue, 7 May 2024 15:19:28 +0200 Subject: [PATCH 08/17] Refactor API responses type annotations --- lib/galaxy/webapps/base/api.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/galaxy/webapps/base/api.py b/lib/galaxy/webapps/base/api.py index c6891f32ef37..825ea5abfbc5 100644 --- a/lib/galaxy/webapps/base/api.py +++ b/lib/galaxy/webapps/base/api.py @@ -240,7 +240,7 @@ def include_all_package_routers(app: FastAPI, package_name: str): for _, module in walk_controller_modules(package_name): router = getattr(module, "router", None) if router: - responses: typing.Dict[int, typing.Dict[str, typing.Any]] = { + responses: typing.Optional[typing.Dict[typing.Union[int, str], typing.Dict[str, typing.Any]]] = { 400: { "description": "Bad Request", "model": MessageExceptionModel, From 177c00b57cde4f78f92be266070ab9f1eb9afb2e Mon Sep 17 00:00:00 2001 From: Arash Date: Sat, 29 Jun 2024 12:13:23 +0200 Subject: [PATCH 09/17] Using 422 as a model error instead of 400 --- client/src/api/schema/schema.ts | 5483 ++++++----------- lib/galaxy/schema/schema.py | 8 - lib/galaxy/webapps/base/api.py | 19 +- lib/galaxy/webapps/galaxy/fast_app.py | 2 - .../webapp/frontend/src/schema/schema.ts | 327 +- 5 files changed, 1840 insertions(+), 3999 deletions(-) diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index f5bae03e5160..80dceb43cef7 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -6510,11 +6510,6 @@ export interface components { */ waiting?: number; }; - /** HTTPValidationError */ - HTTPValidationError: { - /** Detail */ - detail?: components["schemas"]["ValidationError"][]; - }; /** * HashFunctionNameEnum * @description Particular pieces of information that can be requested for a dataset. @@ -9423,8 +9418,6 @@ export interface components { err_code: number; /** Err Msg */ err_msg: string; - /** Validation Errors */ - validation_errors: components["schemas"]["ValidationErrorModel"][]; }; /** MessageNotificationContent */ MessageNotificationContent: { @@ -12617,26 +12610,6 @@ export interface components { /** Total Disk Usage */ total_disk_usage: number; }; - /** ValidationError */ - ValidationError: { - /** Location */ - loc: (string | number)[]; - /** Message */ - msg: string; - /** Error Type */ - type: string; - }; - /** ValidationErrorModel */ - ValidationErrorModel: { - /** Input */ - input: Record; - /** Loc */ - loc: number[]; - /** Msg */ - msg: string; - /** Type */ - type: string; - }; /** Visualization */ Visualization: Record; /** VisualizationSummary */ @@ -13101,7 +13074,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -13132,15 +13105,9 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; @@ -13169,15 +13136,9 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; @@ -13213,24 +13174,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Decode a given id - * @description Decode a given id. - */ decode_id_api_configuration_decode__encoded_id__get: { + /** + * Decode a given id + * @description Decode a given id. + */ parameters: { header?: { /** @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. */ @@ -13251,25 +13206,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return dynamic tool configuration files - * @description Return dynamic tool configuration files. - */ dynamic_tool_confs_api_configuration_dynamic_tool_confs_get: { - parameters: { + /** + * Return dynamic tool configuration files + * @description Return dynamic tool configuration files. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -13285,24 +13235,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Encode a given id - * @description Decode a given id. - */ encode_id_api_configuration_encode__decoded_id__get: { + /** + * Encode a given id + * @description Decode a given id. + */ parameters: { header?: { /** @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. */ @@ -13323,25 +13267,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return tool lineages for tools that have them - * @description Return tool lineages for tools that have them. - */ tool_lineages_api_configuration_tool_lineages_get: { - parameters: { + /** + * Return tool lineages for tools that have them + * @description Return tool lineages for tools that have them. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -13357,25 +13296,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Reload the Galaxy toolbox (but not individual tools) - * @description Reload the Galaxy toolbox (but not individual tools). - */ reload_toolbox_api_configuration_toolbox_put: { - parameters: { + /** + * Reload the Galaxy toolbox (but not individual tools) + * @description Reload the Galaxy toolbox (but not individual tools). + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -13389,21 +13323,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Content */ content_api_dataset_collection_element__dce_id__get: { + /** Content */ parameters: { header?: { /** @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. */ @@ -13422,22 +13350,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create a new dataset collection instance. */ create_api_dataset_collections_post: { - parameters: { + /** Create a new dataset collection instance. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -13456,21 +13379,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns direct child contents of indicated dataset collection parent ID. */ contents_dataset_collection_api_dataset_collections__hdca_id__contents__parent_id__get: { + /** Returns direct child contents of indicated dataset collection parent ID. */ parameters: { query?: { /** @description The type of collection instance. Either `history` (default) or `library`. */ @@ -13499,21 +13416,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns detailed information about the given collection. */ show_api_dataset_collections__id__get: { + /** Returns detailed information about the given collection. */ parameters: { query?: { /** @description The type of collection instance. Either `history` (default) or `library`. */ @@ -13538,21 +13449,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns `dbkey`/`extension` attributes for all the collection elements. */ attributes_api_dataset_collections__id__attributes_get: { + /** Returns `dbkey`/`extension` attributes for all the collection elements. */ parameters: { query?: { /** @description The type of collection instance. Either `history` (default) or `library`. */ @@ -13575,21 +13480,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Copy the given collection datasets to a new collection using a new `dbkey` attribute. */ copy_api_dataset_collections__id__copy_post: { + /** Copy the given collection datasets to a new collection using a new `dbkey` attribute. */ parameters: { header?: { /** @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. */ @@ -13613,25 +13512,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Download the content of a dataset collection as a `zip` archive. - * @description Download the content of a history dataset collection as a `zip` archive - * while maintaining approximate collection structure. - */ dataset_collections__download: { + /** + * Download the content of a dataset collection as a `zip` archive. + * @description Download the content of a history dataset collection as a `zip` archive + * while maintaining approximate collection structure. + */ parameters: { header?: { /** @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. */ @@ -13646,26 +13539,20 @@ export interface operations { /** @description Successful Response */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Prepare an short term storage object that the collection will be downloaded to. - * @description The history dataset collection will be written as a `zip` archive to the - * returned short term storage object. Progress tracking this file's creation - * can be tracked with the short_term_storage API. - */ prepare_collection_download_api_dataset_collections__id__prepare_download_post: { + /** + * Prepare an short term storage object that the collection will be downloaded to. + * @description The history dataset collection will be written as a `zip` archive to the + * returned short term storage object. Progress tracking this file's creation + * can be tracked with the short_term_storage API. + */ parameters: { header?: { /** @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. */ @@ -13684,15 +13571,9 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Required asynchronous tasks required for this operation not available. */ @@ -13725,22 +13606,24 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Search datasets or collections using a query system. */ index_api_datasets_get: { - parameters: { + /** 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. */ + /** @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. */ query?: { /** @description Optional identifier of a History. Use it to restrict the search within a particular History. */ history_id?: string | null; @@ -13778,27 +13661,22 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Deletes or purges a batch of datasets. - * @description Deletes or purges a batch of datasets. - * **Warning**: only the ownership of the datasets (and upload state for HDAs) is checked, - * no other checks or restrictions are made. - */ delete_batch_api_datasets_delete: { - parameters: { + /** + * Deletes or purges a batch of datasets. + * @description Deletes or purges a batch of datasets. + * **Warning**: only the ownership of the datasets (and upload state for HDAs) is checked, + * no other checks or restrictions are made. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -13817,26 +13695,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays information about and/or content of a dataset. - * @description **Note**: Due to the multipurpose nature of this endpoint, which can receive a wild variety of parameters - * and return different kinds of responses, the documentation here will be limited. - * To get more information please check the source code. - */ show_api_datasets__dataset_id__get: { + /** + * Displays information about and/or content of a dataset. + * @description **Note**: Due to the multipurpose nature of this endpoint, which can receive a wild variety of parameters + * and return different kinds of responses, the documentation here will be limited. + * To get more information please check the source code. + */ parameters: { query?: { /** @description The type of information about the dataset to be requested. */ @@ -13865,24 +13737,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the values for the history dataset (HDA) item with the given ``ID``. - * @description Updates the values for the history content item with the given ``ID``. - */ datasets__update_dataset: { + /** + * Updates the values for the history dataset (HDA) item with the given ``ID``. + * @description Updates the values for the history content item with the given ``ID``. + */ parameters: { query?: { /** @description View to be passed to the serializer */ @@ -13917,26 +13783,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Delete the history dataset content with the given ``ID``. - * @description Delete the history content with the given ``ID`` and path specified type. - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. - */ datasets__delete: { + /** + * Delete the history dataset content with the given ``ID``. + * @description Delete the history content with the given ``ID`` and path specified type. + * + * **Note**: Currently does not stop any active jobs for which this dataset is an output. + */ parameters: { query?: { /** @@ -13987,21 +13847,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Retrieve information about the content of a dataset. */ get_structured_content_api_datasets__dataset_id__content__content_type__get: { + /** Retrieve information about the content of a dataset. */ parameters: { header?: { /** @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. */ @@ -14021,24 +13875,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return a a map with all the existing converted datasets associated with this instance. - * @description Return a map of ` : ` containing all the *existing* converted datasets. - */ converted_api_datasets__dataset_id__converted_get: { + /** + * Return a a map with all the existing converted datasets associated with this instance. + * @description Return a map of ` : ` containing all the *existing* converted datasets. + */ parameters: { header?: { /** @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. */ @@ -14057,28 +13905,22 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return information about datasets made by converting this dataset to a new format. - * @description Return information about datasets made by converting this dataset to a new format. - * - * If there is no existing converted dataset for the format in `ext`, one will be created. - * - * **Note**: `view` and `keys` are also available to control the serialization of the dataset. - */ converted_ext_api_datasets__dataset_id__converted__ext__get: { + /** + * Return information about datasets made by converting this dataset to a new format. + * @description Return information about datasets made by converting this dataset to a new format. + * + * If there is no existing converted dataset for the format in `ext`, one will be created. + * + * **Note**: `view` and `keys` are also available to control the serialization of the dataset. + */ parameters: { query?: { /** @description View to be passed to the serializer */ @@ -14108,21 +13950,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get the list of extra files/directories associated with a dataset. */ extra_files_api_datasets__dataset_id__extra_files_get: { + /** Get the list of extra files/directories associated with a dataset. */ parameters: { header?: { /** @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. */ @@ -14141,21 +13977,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; }; }; - /** Returns dataset content as Text. */ get_content_as_text_api_datasets__dataset_id__get_content_as_text_get: { + /** Returns dataset content as Text. */ parameters: { header?: { /** @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. */ @@ -14174,21 +14004,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Compute dataset hash for dataset and update model */ compute_hash_api_datasets__dataset_id__hash_put: { + /** Compute dataset hash for dataset and update model */ parameters: { query?: { /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ @@ -14216,21 +14040,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** For internal use, this endpoint may change without warning. */ show_inheritance_chain_api_datasets__dataset_id__inheritance_chain_get: { + /** For internal use, this endpoint may change without warning. */ parameters: { query?: { /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ @@ -14253,24 +14071,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return job metrics for specified job. - * @deprecated - */ get_metrics_api_datasets__dataset_id__metrics_get: { + /** + * Return job metrics for specified job. + * @deprecated + */ parameters: { query?: { /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ @@ -14293,21 +14105,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update an object store ID for a dataset you own. */ datasets__update_object_store_id: { + /** Update an object store ID for a dataset you own. */ parameters: { header?: { /** @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. */ @@ -14331,27 +14137,21 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Resolve parameters as a list for nested display. - * @deprecated - * @description Resolve parameters as a list for nested display. - * This API endpoint is unstable and tied heavily to Galaxy's JS client code, - * this endpoint will change frequently. - */ resolve_parameters_display_api_datasets__dataset_id__parameters_display_get: { + /** + * Resolve parameters as a list for nested display. + * @deprecated + * @description Resolve parameters as a list for nested display. + * This API endpoint is unstable and tied heavily to Galaxy's JS client code, + * this endpoint will change frequently. + */ parameters: { query?: { /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ @@ -14374,24 +14174,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set permissions of the given history dataset to the given role ids. - * @description Set permissions of the given history dataset to the given role ids. - */ update_permissions_api_datasets__dataset_id__permissions_put: { + /** + * Set permissions of the given history dataset to the given role ids. + * @description Set permissions of the given history dataset to the given role ids. + */ parameters: { header?: { /** @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. */ @@ -14415,21 +14209,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Display user-facing storage details related to the objectstore a dataset resides in. */ show_storage_api_datasets__dataset_id__storage_get: { + /** Display user-facing storage details related to the objectstore a dataset resides in. */ parameters: { query?: { /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ @@ -14452,24 +14240,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays (preview) or downloads dataset content. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ display_api_datasets__history_content_id__display_get: { + /** + * Displays (preview) or downloads dataset content. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. + */ parameters: { query?: { /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ @@ -14498,24 +14280,18 @@ export interface operations { /** @description Successful Response */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Check if dataset content can be previewed or downloaded. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ display_api_datasets__history_content_id__display_head: { + /** + * Check if dataset content can be previewed or downloaded. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. + */ parameters: { query?: { /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ @@ -14548,21 +14324,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns the metadata file associated with this history item. */ datasets__get_metadata_file: { + /** Returns the metadata file associated with this history item. */ parameters: { query: { /** @description The name of the metadata file to retrieve. */ @@ -14581,21 +14351,15 @@ export interface operations { /** @description Successful Response */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Check if metadata file can be downloaded. */ get_metadata_file_datasets_api_datasets__history_content_id__metadata_file_head: { + /** Check if metadata file can be downloaded. */ parameters: { query: { /** @description The name of the metadata file to retrieve. */ @@ -14618,25 +14382,21 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Lists all available data types - * @description Gets the list of all available data types. - */ index_api_datatypes_get: { - parameters: { + /** + * Lists all available data types + * @description Gets the list of all available data types. + */ + parameters?: { + /** @description Whether to return only the datatype's extension rather than the datatype's details */ + /** @description Whether to return only datatypes which can be uploaded */ query?: { /** @description Whether to return only the datatype's extension rather than the datatype's details */ extension_only?: boolean | null; @@ -14652,24 +14412,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the list of all installed converters - * @description Gets the list of all installed converters. - */ converters_api_datatypes_converters_get: { + /** + * Returns the list of all installed converters + * @description Gets the list of all installed converters. + */ responses: { /** @description List of all datatype converters */ 200: { @@ -14678,7 +14432,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -14700,7 +14454,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -14721,7 +14475,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -14743,7 +14497,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -14764,7 +14518,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -14784,7 +14538,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -14804,7 +14558,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -14836,24 +14590,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the list of display applications. - * @description Returns the list of display applications. - */ display_applications_index_api_display_applications_get: { + /** + * Returns the list of display applications. + * @description Returns the list of display applications. + */ responses: { /** @description Successful Response */ 200: { @@ -14862,7 +14610,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -14896,21 +14644,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Download */ download_api_drs_download__object_id__get: { + /** Download */ parameters: { header?: { /** @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. */ @@ -14925,34 +14667,28 @@ export interface operations { /** @description Successful Response */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. - * @description Returns a list of a folder's contents (files and sub-folders). - * - * Additional metadata for the folder is provided in the response as a separate object containing data - * for breadcrumb path building, permissions and other folder's details. - * - * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). - * - * **Security note**: - * - Accessing a library folder or sub-folder requires only access to the parent library. - * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. - * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. - */ index_api_folders__folder_id__contents_get: { + /** + * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. + * @description Returns a list of a folder's contents (files and sub-folders). + * + * Additional metadata for the folder is provided in the response as a separate object containing data + * for breadcrumb path building, permissions and other folder's details. + * + * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). + * + * **Security note**: + * - Accessing a library folder or sub-folder requires only access to the parent library. + * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. + * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. + */ parameters: { query?: { /** @description Maximum number of contents to return. */ @@ -14985,21 +14721,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Creates a new library file from an existing HDA/HDCA. */ add_history_datasets_to_library_api_folders__folder_id__contents_post: { + /** Creates a new library file from an existing HDA/HDCA. */ parameters: { header?: { /** @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. */ @@ -15023,24 +14753,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays information about a particular library folder. - * @description Returns detailed information about the library folder with the given ID. - */ show_api_folders__id__get: { + /** + * Displays information about a particular library folder. + * @description Returns detailed information about the library folder with the given ID. + */ parameters: { header?: { /** @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. */ @@ -15059,24 +14783,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the information of an existing library folder. - * @description Updates the information of an existing library folder. - */ update_api_folders__id__put: { + /** + * Updates the information of an existing library folder. + * @description Updates the information of an existing library folder. + */ parameters: { header?: { /** @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. */ @@ -15100,24 +14818,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create a new library folder underneath the one specified by the ID. - * @description Returns detailed information about the newly created library folder. - */ create_api_folders__id__post: { + /** + * Create a new library folder underneath the one specified by the ID. + * @description Returns detailed information about the newly created library folder. + */ parameters: { header?: { /** @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. */ @@ -15141,24 +14853,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Marks the specified library folder as deleted (or undeleted). - * @description Marks the specified library folder as deleted (or undeleted). - */ delete_api_folders__id__delete: { + /** + * Marks the specified library folder as deleted (or undeleted). + * @description Marks the specified library folder as deleted (or undeleted). + */ parameters: { query?: { /** @description Whether to restore a deleted library folder. */ @@ -15181,24 +14887,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Update - * @description Updates the information of an existing library folder. - */ update_api_folders__id__patch: { + /** + * Update + * @description Updates the information of an existing library folder. + */ parameters: { header?: { /** @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. */ @@ -15222,25 +14922,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Gets the current or available permissions of a particular library folder. - * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. - */ get_permissions_api_folders__id__permissions_get: { + /** + * Gets the current or available permissions of a particular library folder. + * @description Gets the current or available permissions of a particular library. + * The results can be paginated and additionally filtered by a query. + */ parameters: { query?: { /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ @@ -15271,24 +14965,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Sets the permissions to manage a library folder. - * @description Sets the permissions to manage a library folder. - */ set_permissions_api_folders__id__permissions_post: { + /** + * Sets the permissions to manage a library folder. + * @description Sets the permissions to manage a library folder. + */ parameters: { query?: { /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ @@ -15316,21 +15004,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation Error */ - 422: { - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; }; }; - /** Delete */ delete_api_forms__id__delete: { + /** Delete */ parameters: { header?: { /** @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. */ @@ -15348,21 +15030,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Undelete */ undelete_api_forms__id__undelete_post: { + /** Undelete */ parameters: { header?: { /** @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. */ @@ -15380,15 +15056,9 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; @@ -15432,22 +15102,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return a list of installed genomes */ index_api_genomes_get: { - parameters: { + /** Return a list of installed genomes */ + parameters?: { + /** @description If true, return genome keys with chromosome lengths */ query?: { /** @description If true, return genome keys with chromosome lengths */ chrom_info?: boolean; @@ -15465,21 +15130,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return information about build */ show_api_genomes__id__get: { + /** Return information about build */ parameters: { query?: { /** @description If true, return reference data */ @@ -15512,21 +15171,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return all available indexes for a genome id for provided type */ indexes_api_genomes__id__indexes_get: { + /** Return all available indexes for a genome id for provided type */ parameters: { query?: { /** @description Index type */ @@ -15551,21 +15204,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return raw sequence data */ sequences_api_genomes__id__sequences_get: { + /** Return raw sequence data */ parameters: { query?: { /** @description If true, return reference data */ @@ -15596,22 +15243,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays a collection (list) of groups. */ index_api_groups_get: { - parameters: { + /** Displays a collection (list) of groups. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -15625,22 +15267,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Creates a new group. */ create_api_groups_post: { - parameters: { + /** Creates a new group. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -15659,21 +15296,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays information about a group. */ show_group_api_groups__group_id__get: { + /** Displays information about a group. */ parameters: { header?: { /** @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. */ @@ -15691,21 +15322,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Modifies a group. */ update_api_groups__group_id__put: { + /** Modifies a group. */ parameters: { header?: { /** @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. */ @@ -15728,21 +15353,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete */ delete_api_groups__group_id__delete: { + /** Delete */ parameters: { header?: { /** @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. */ @@ -15760,21 +15379,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Purge */ purge_api_groups__group_id__purge_post: { + /** Purge */ parameters: { header?: { /** @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. */ @@ -15792,21 +15405,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays a collection (list) of groups. */ group_roles_api_groups__group_id__roles_get: { + /** Displays a collection (list) of groups. */ parameters: { header?: { /** @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. */ @@ -15825,21 +15432,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays information about a group role. */ group_role_api_groups__group_id__roles__role_id__get: { + /** Displays information about a group role. */ parameters: { header?: { /** @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. */ @@ -15860,21 +15461,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Adds a role to a group */ update_api_groups__group_id__roles__role_id__put: { + /** Adds a role to a group */ parameters: { header?: { /** @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. */ @@ -15895,21 +15490,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Removes a role from a group */ delete_api_groups__group_id__roles__role_id__delete: { + /** Removes a role from a group */ parameters: { header?: { /** @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. */ @@ -15930,21 +15519,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Undelete */ undelete_api_groups__group_id__undelete_post: { + /** Undelete */ parameters: { header?: { /** @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. */ @@ -15962,24 +15545,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays information about a group user. - * @description Displays information about a group user. - */ group_user_api_groups__group_id__user__user_id__get: { + /** + * Displays information about a group user. + * @description Displays information about a group user. + */ parameters: { header?: { /** @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. */ @@ -16000,25 +15577,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Adds a user to a group - * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group - */ update_api_groups__group_id__user__user_id__put: { + /** + * Adds a user to a group + * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Adds a user to a group + */ parameters: { header?: { /** @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. */ @@ -16039,25 +15610,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes a user from a group - * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group - */ delete_api_groups__group_id__user__user_id__delete: { + /** + * Removes a user from a group + * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Removes a user from a group + */ parameters: { header?: { /** @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. */ @@ -16078,25 +15643,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays a collection (list) of groups. - * @description GET /api/groups/{encoded_group_id}/users - * Displays a collection (list) of groups. - */ group_users_api_groups__group_id__users_get: { + /** + * Displays a collection (list) of groups. + * @description GET /api/groups/{encoded_group_id}/users + * Displays a collection (list) of groups. + */ parameters: { header?: { /** @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. */ @@ -16115,24 +15674,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays information about a group user. - * @description Displays information about a group user. - */ group_user_api_groups__group_id__users__user_id__get: { + /** + * Displays information about a group user. + * @description Displays information about a group user. + */ parameters: { header?: { /** @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. */ @@ -16153,25 +15706,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Adds a user to a group - * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group - */ update_api_groups__group_id__users__user_id__put: { + /** + * Adds a user to a group + * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Adds a user to a group + */ parameters: { header?: { /** @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. */ @@ -16192,25 +15739,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes a user from a group - * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group - */ delete_api_groups__group_id__users__user_id__delete: { + /** + * Removes a user from a group + * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Removes a user from a group + */ parameters: { header?: { /** @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. */ @@ -16231,26 +15772,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Search the Galaxy Help forum. - * @description Search the Galaxy Help forum using the Discourse API. - * - * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. - */ search_forum_api_help_forum_search_get: { + /** + * Search the Galaxy Help forum. + * @description Search the Galaxy Help forum using the Discourse API. + * + * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. + */ parameters: { query: { /** @description Search query to use for searching the Galaxy Help forum. */ @@ -16269,76 +15804,75 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns histories available to the current user. */ index_api_histories_get: { - parameters: { + /** Returns histories available to the current user. */ + parameters?: { + /** @description The maximum number of items to return. */ + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + /** @description Whether to include archived histories. */ + /** @description Sort index by this specified attribute */ + /** @description Sort in descending order? */ + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `name` + * : The history's name. + * + * `annotation` + * : The history's annotation. (The tag `a` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The history's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Historys: `title`, `description`, `slug`, `tag`. + */ + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + /** + * @deprecated + * @description Whether to return only deleted items. + */ + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { - /** @description The maximum number of items to return. */ limit?: number | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ offset?: number | null; show_own?: boolean; show_published?: boolean; show_shared?: boolean; - /** @description Whether to include archived histories. */ show_archived?: boolean | null; - /** @description Sort index by this specified attribute */ sort_by?: "create_time" | "name" | "update_time" | "username"; - /** @description Sort in descending order? */ sort_desc?: boolean; - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `name` - * : The history's name. - * - * `annotation` - * : The history's annotation. (The tag `a` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The history's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Historys: `title`, `description`, `slug`, `tag`. - */ search?: string | null; - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ all?: boolean | null; - /** - * @deprecated - * @description Whether to return only deleted items. - */ deleted?: boolean | null; /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ q?: string[] | null; @@ -16368,25 +15902,21 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Creates a new history. - * @description The new history can also be copied form a existing history or imported from an archive or URL. - */ create_api_histories_post: { - parameters: { + /** + * Creates a new history. + * @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?: { /** @description View to be passed to the serializer */ view?: string | null; @@ -16415,27 +15945,28 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get a list of all archived histories for the current user. - * @description Get a list of all archived histories for the current user. - * - * Archived histories are histories are not part of the active histories of the user but they can be accessed using this endpoint. - */ get_archived_histories_api_histories_archived_get: { - parameters: { + /** + * Get a list of all archived histories for the current user. + * @description Get a list of all archived histories for the current user. + * + * 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. */ + /** @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. */ query?: { /** @description View to be passed to the serializer */ view?: string | null; @@ -16469,22 +16000,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Marks several histories with the given IDs as deleted. */ batch_delete_api_histories_batch_delete_put: { - parameters: { + /** Marks several histories with the given IDs 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; /** @description View to be passed to the serializer */ @@ -16514,22 +16041,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Marks several histories with the given IDs as undeleted. */ batch_undelete_api_histories_batch_undelete_put: { - parameters: { + /** Marks several histories with the given IDs as undeleted. */ + parameters?: { + /** @description View to be passed to the serializer */ + /** @description Comma-separated list of keys to be passed to the serializer */ query?: { /** @description View to be passed to the serializer */ view?: string | null; @@ -16558,22 +16081,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns number of histories for the current user. */ count_api_histories_count_get: { - parameters: { + /** Returns number of histories for the current user. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -16587,22 +16105,24 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns deleted histories for the current user. */ index_deleted_api_histories_deleted_get: { - parameters: { + /** Returns deleted histories for the current user. */ + parameters?: { + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ all?: boolean | null; @@ -16638,21 +16158,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Restores a deleted history with the given ID (that hasn't been purged). */ undelete_api_histories_deleted__history_id__undelete_post: { + /** Restores a deleted history with the given ID (that hasn't been purged). */ parameters: { query?: { /** @description View to be passed to the serializer */ @@ -16680,22 +16194,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create histories from a model store. */ create_from_store_api_histories_from_store_post: { - parameters: { + /** 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?: { /** @description View to be passed to the serializer */ view?: string | null; @@ -16723,22 +16233,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Launch a task to create histories from a model store. */ create_from_store_async_api_histories_from_store_async_post: { - parameters: { + /** Launch a task to create histories from a model store. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -16757,22 +16262,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns the most recently used history of the user. */ show_recent_api_histories_most_recently_used_get: { - parameters: { + /** 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?: { /** @description View to be passed to the serializer */ view?: string | null; @@ -16795,22 +16296,23 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return all histories that are published. */ published_api_histories_published_get: { - parameters: { + /** Return all histories that are published. */ + parameters?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ q?: string[] | null; @@ -16844,22 +16346,23 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return all histories that are shared with the current user. */ shared_with_me_api_histories_shared_with_me_get: { - parameters: { + /** Return all histories that are shared with the current user. */ + parameters?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ q?: string[] | null; @@ -16893,21 +16396,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns the history with the given ID. */ history_api_histories__history_id__get: { + /** Returns the history with the given ID. */ parameters: { query?: { /** @description View to be passed to the serializer */ @@ -16935,21 +16432,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Updates the values for the history with the given ID. */ update_api_histories__history_id__put: { + /** Updates the values for the history with the given ID. */ parameters: { query?: { /** @description View to be passed to the serializer */ @@ -16982,21 +16473,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Marks the history with the given ID as deleted. */ delete_api_histories__history_id__delete: { + /** Marks the history with the given ID as deleted. */ parameters: { query?: { purge?: boolean; @@ -17030,37 +16515,31 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Archive a history. - * @description Marks the given history as 'archived' and returns the history. - * - * Archiving a history will remove it from the list of active histories of the user but it will still be - * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. - * - * Associating an export record: - * - * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the - * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and - * must be in the ready state. - * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. - * - * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. - * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. - */ archive_history_api_histories__history_id__archive_post: { + /** + * Archive a history. + * @description Marks the given history as 'archived' and returns the history. + * + * Archiving a history will remove it from the list of active histories of the user but it will still be + * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. + * + * Associating an export record: + * + * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the + * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and + * must be in the ready state. + * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. + * + * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. + * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. + */ parameters: { header?: { /** @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. */ @@ -17087,30 +16566,24 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Restore an archived history. - * @description Restores an archived history and returns it. - * - * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). - * - * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them - * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export - * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. - */ restore_archived_history_api_histories__history_id__archive_restore_put: { + /** + * Restore an archived history. + * @description Restores an archived history and returns it. + * + * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). + * + * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them + * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export + * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. + */ parameters: { query?: { /** @description If true, the history will be un-archived even if it has an associated archive export record and was purged. */ @@ -17136,21 +16609,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return all the citations for the tools used to produce the datasets in the history. */ citations_api_histories__history_id__citations_get: { + /** Return all the citations for the tools used to produce the datasets in the history. */ parameters: { header?: { /** @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. */ @@ -17169,29 +16636,23 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the contents of the given history. - * @description Return a list of `HDA`/`HDCA` data for the history with the given ``ID``. - * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ history_contents__index: { + /** + * Returns the contents of the given history. + * @description Return a list of `HDA`/`HDCA` data for the history with the given ``ID``. + * + * - The contents can be filtered and queried using the appropriate parameters. + * - The amount of information returned for each item can be customized. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ parameters: { query?: { /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ @@ -17256,27 +16717,21 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Batch update specific properties of a set items contained in the given History. - * @description Batch update specific properties of a set items contained in the given History. - * - * If you provide an invalid/unknown property key the request will not fail, but no changes - * will be made to the items. - */ update_batch_api_histories__history_id__contents_put: { + /** + * Batch update specific properties of a set items contained in the given History. + * @description Batch update specific properties of a set items contained in the given History. + * + * If you provide an invalid/unknown property key the request will not fail, but no changes + * will be made to the items. + */ parameters: { query?: { /** @description View to be passed to the serializer */ @@ -17306,25 +16761,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create a new `HDA` or `HDCA` in the given History. - * @deprecated - * @description Create a new `HDA` or `HDCA` in the given History. - */ history_contents__create: { + /** + * Create a new `HDA` or `HDCA` in the given History. + * @deprecated + * @description Create a new `HDA` or `HDCA` in the given History. + */ parameters: { query?: { /** @description The type of the target history element. */ @@ -17368,29 +16817,23 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Build and return a compressed archive of the selected history contents. - * @description Build and return a compressed archive of the selected history contents. - * - * **Note**: this is a volatile endpoint and settings and behavior may change. - */ history_contents__archive: { - parameters: { - query?: { - /** @description The name that the Archive will have (defaults to history name). */ + /** + * Build and return a compressed archive of the selected history contents. + * @description Build and return a compressed archive of the selected history contents. + * + * **Note**: this is a volatile endpoint and settings and behavior may change. + */ + parameters: { + query?: { + /** @description The name that the Archive will have (defaults to history name). */ filename?: string | null; /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ dry_run?: boolean | null; @@ -17422,26 +16865,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Build and return a compressed archive of the selected history contents. - * @description Build and return a compressed archive of the selected history contents. - * - * **Note**: this is a volatile endpoint and settings and behavior may change. - */ history_contents__archive_named: { + /** + * Build and return a compressed archive of the selected history contents. + * @description Build and return a compressed archive of the selected history contents. + * + * **Note**: this is a volatile endpoint and settings and behavior may change. + */ parameters: { query?: { /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ @@ -17481,26 +16918,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Executes an operation on a set of items contained in the given History. - * @description Executes an operation on a set of items contained in the given History. - * - * The items to be processed can be explicitly set or determined by a dynamic query. - */ bulk_operation_api_histories__history_id__contents_bulk_put: { + /** + * Executes an operation on a set of items contained in the given History. + * @description Executes an operation on a set of items contained in the given History. + * + * The items to be processed can be explicitly set or determined by a dynamic query. + */ parameters: { query?: { /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ @@ -17530,25 +16961,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Download the content of a dataset collection as a `zip` archive. - * @description Download the content of a history dataset collection as a `zip` archive - * while maintaining approximate collection structure. - */ history_contents__download_collection: { + /** + * Download the content of a dataset collection as a `zip` archive. + * @description Download the content of a history dataset collection as a `zip` archive + * while maintaining approximate collection structure. + */ parameters: { header?: { /** @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. */ @@ -17565,21 +16990,15 @@ export interface operations { /** @description Successful Response */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Materialize a deferred dataset into real, usable dataset. */ materialize_dataset_api_histories__history_id__contents_datasets__id__materialize_post: { + /** Materialize a deferred dataset into real, usable dataset. */ parameters: { header?: { /** @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. */ @@ -17600,24 +17019,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set permissions of the given history dataset to the given role ids. - * @description Set permissions of the given history dataset to the given role ids. - */ update_permissions_api_histories__history_id__contents__dataset_id__permissions_put: { + /** + * Set permissions of the given history dataset to the given role ids. + * @description Set permissions of the given history dataset to the given role ids. + */ parameters: { header?: { /** @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. */ @@ -17643,24 +17056,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays (preview) or downloads dataset content. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ history_contents_display_api_histories__history_id__contents__history_content_id__display_get: { + /** + * Displays (preview) or downloads dataset content. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. + */ parameters: { query?: { /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ @@ -17690,24 +17097,18 @@ export interface operations { /** @description Successful Response */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Check if dataset content can be previewed or downloaded. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ history_contents_display_api_histories__history_id__contents__history_content_id__display_head: { + /** + * Check if dataset content can be previewed or downloaded. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. + */ parameters: { query?: { /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ @@ -17741,21 +17142,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get the list of extra files/directories associated with a dataset. */ extra_files_history_api_histories__history_id__contents__history_content_id__extra_files_get: { + /** Get the list of extra files/directories associated with a dataset. */ parameters: { header?: { /** @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. */ @@ -17776,21 +17171,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns the metadata file associated with this history item. */ history_contents__get_metadata_file: { + /** Returns the metadata file associated with this history item. */ parameters: { query: { /** @description The name of the metadata file to retrieve. */ @@ -17811,21 +17200,15 @@ export interface operations { /** @description Successful Response */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tags based on history_content_id */ index_api_histories__history_id__contents__history_content_id__tags_get: { + /** Show tags based on history_content_id */ parameters: { header?: { /** @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. */ @@ -17844,21 +17227,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tag based on history_content_id */ show_api_histories__history_id__contents__history_content_id__tags__tag_name__get: { + /** Show tag based on history_content_id */ parameters: { header?: { /** @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. */ @@ -17878,21 +17255,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update tag based on history_content_id */ update_api_histories__history_id__contents__history_content_id__tags__tag_name__put: { + /** Update tag based on history_content_id */ parameters: { header?: { /** @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. */ @@ -17917,21 +17288,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create tag based on history_content_id */ create_api_histories__history_id__contents__history_content_id__tags__tag_name__post: { + /** Create tag based on history_content_id */ parameters: { header?: { /** @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. */ @@ -17956,21 +17321,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete tag based on history_content_id */ delete_api_histories__history_id__contents__history_content_id__tags__tag_name__delete: { + /** Delete tag based on history_content_id */ parameters: { header?: { /** @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. */ @@ -17990,27 +17349,21 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return detailed information about an HDA within a history. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. - * @deprecated - * @description Return detailed information about an `HDA` or `HDCA` within a history. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ history_contents__show_legacy: { + /** + * Return detailed information about an HDA within a history. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. + * @deprecated + * @description Return detailed information about an `HDA` or `HDCA` within a history. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ parameters: { query?: { /** @description The type of the target history element. */ @@ -18046,25 +17399,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the values for the history content item with the given ``ID`` and query specified type. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. - * @deprecated - * @description Updates the values for the history content item with the given ``ID``. - */ history_contents__update_legacy: { + /** + * Updates the values for the history content item with the given ``ID`` and query specified type. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. + * @deprecated + * @description Updates the values for the history content item with the given ``ID``. + */ parameters: { query?: { /** @description The type of the target history element. */ @@ -18103,26 +17450,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Delete the history dataset with the given ``ID``. - * @description Delete the history content with the given ``ID`` and query specified type (defaults to dataset). - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. - */ history_contents__delete_legacy: { + /** + * Delete the history dataset with the given ``ID``. + * @description Delete the history content with the given ``ID`` and query specified type (defaults to dataset). + * + * **Note**: Currently does not stop any active jobs for which this dataset is an output. + */ parameters: { query?: { /** @description The type of the target history element. */ @@ -18177,24 +17518,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Validates the metadata associated with a dataset within a History. - * @description Validates the metadata associated with a dataset within a History. - */ validate_api_histories__history_id__contents__id__validate_put: { + /** + * Validates the metadata associated with a dataset within a History. + * @description Validates the metadata associated with a dataset within a History. + */ parameters: { header?: { /** @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. */ @@ -18215,29 +17550,23 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the contents of the given history filtered by type. - * @description Return a list of either `HDA`/`HDCA` data for the history with the given ``ID``. - * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ history_contents__index_typed: { + /** + * Returns the contents of the given history filtered by type. + * @description Return a list of either `HDA`/`HDCA` data for the history with the given ``ID``. + * + * - The contents can be filtered and queried using the appropriate parameters. + * - The amount of information returned for each item can be customized. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ parameters: { query?: { /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ @@ -18305,24 +17634,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create a new `HDA` or `HDCA` in the given History. - * @description Create a new `HDA` or `HDCA` in the given History. - */ history_contents__create_typed: { + /** + * Create a new `HDA` or `HDCA` in the given History. + * @description Create a new `HDA` or `HDCA` in the given History. + */ parameters: { query?: { /** @description View to be passed to the serializer */ @@ -18366,26 +17689,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return detailed information about a specific HDA or HDCA with the given `ID` within a history. - * @description Return detailed information about an `HDA` or `HDCA` within a history. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ history_contents__show: { + /** + * Return detailed information about a specific HDA or HDCA with the given `ID` within a history. + * @description Return detailed information about an `HDA` or `HDCA` within a history. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ parameters: { query?: { /** @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. */ @@ -18421,24 +17738,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the values for the history content item with the given ``ID`` and path specified type. - * @description Updates the values for the history content item with the given ``ID``. - */ history_contents__update_typed: { + /** + * Updates the values for the history content item with the given ``ID`` and path specified type. + * @description Updates the values for the history content item with the given ``ID``. + */ parameters: { query?: { /** @description View to be passed to the serializer */ @@ -18477,26 +17788,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Delete the history content with the given ``ID`` and path specified type. - * @description Delete the history content with the given ``ID`` and path specified type. - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. - */ history_contents__delete_typed: { + /** + * Delete the history content with the given ``ID`` and path specified type. + * @description Delete the history content with the given ``ID`` and path specified type. + * + * **Note**: Currently does not stop any active jobs for which this dataset is an output. + */ parameters: { query?: { /** @@ -18551,36 +17856,30 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return detailed information about an `HDA` or `HDCAs` jobs. - * @description Return detailed information about an `HDA` or `HDCAs` jobs. - * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ show_jobs_summary_api_histories__history_id__contents__type_s__id__jobs_summary_get: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ + /** + * Return detailed information about an `HDA` or `HDCAs` jobs. + * @description Return detailed information about an `HDA` or `HDCAs` jobs. + * + * **Warning**: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ history_id: string; /** @description The ID of the item (`HDA`/`HDCA`) */ id: string; @@ -18599,21 +17898,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Prepare a dataset or dataset collection for export-style download. */ prepare_store_download_api_histories__history_id__contents__type_s__id__prepare_store_download_post: { + /** Prepare a dataset or dataset collection for export-style download. */ parameters: { header?: { /** @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. */ @@ -18641,21 +17934,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Prepare a dataset or dataset collection for export-style download and write to supplied URI. */ write_store_api_histories__history_id__contents__type_s__id__write_store_post: { + /** Prepare a dataset or dataset collection for export-style download and write to supplied URI. */ parameters: { header?: { /** @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. */ @@ -18683,27 +17970,21 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create contents from store. - * @description Create history contents from model store. - * Input can be a tarfile created with build_objects script distributed - * with galaxy-data, from an exported history with files stripped out, - * or hand-crafted JSON dictionary. - */ create_from_store_api_histories__history_id__contents_from_store_post: { + /** + * Create contents from store. + * @description Create history contents from model store. + * Input can be a tarfile created with build_objects script distributed + * with galaxy-data, from an exported history with files stripped out, + * or hand-crafted JSON dictionary. + */ parameters: { query?: { /** @description View to be passed to the serializer */ @@ -18739,21 +18020,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns meta data for custom builds. */ get_custom_builds_metadata_api_histories__history_id__custom_builds_metadata_get: { + /** Returns meta data for custom builds. */ parameters: { header?: { /** @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. */ @@ -18772,24 +18047,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ disable_link_access_api_histories__history_id__disable_link_access_put: { + /** + * Makes this item inaccessible by a URL link. + * @description Makes this item inaccessible by a URL link and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -18808,24 +18077,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ enable_link_access_api_histories__history_id__enable_link_access_put: { + /** + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -18844,26 +18107,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get previous history exports. - * @description By default the legacy job-based history exports (jeha) are returned. - * - * Change the `accept` content type header to return the new task-based history exports. - */ get_history_exports_api_histories__history_id__exports_get: { + /** + * Get previous history exports. + * @description By default the legacy job-based history exports (jeha) are returned. + * + * Change the `accept` content type header to return the new task-based history exports. + */ parameters: { query?: { /** @description The maximum number of items to return. */ @@ -18889,36 +18146,30 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Start job (if needed) to create history export for corresponding history. - * @deprecated - * @description This will start a job to create a history export archive. - * - * Calling this endpoint multiple times will return the 202 status code until the archive - * has been completely generated and is ready to download. When ready, it will return - * the 200 status code along with the download link information. - * - * If the history will be exported to a `directory_uri`, instead of returning the download - * link information, the Job ID will be returned so it can be queried to determine when - * the file has been written. - * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. - */ archive_export_api_histories__history_id__exports_put: { + /** + * Start job (if needed) to create history export for corresponding history. + * @deprecated + * @description This will start a job to create a history export archive. + * + * Calling this endpoint multiple times will return the 202 status code until the archive + * has been completely generated and is ready to download. When ready, it will return + * the 200 status code along with the download link information. + * + * If the history will be exported to a `directory_uri`, instead of returning the download + * link information, the Job ID will be returned so it can be queried to determine when + * the file has been written. + * + * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or + * `/api/histories/{id}/write_store` instead. + */ parameters: { header?: { /** @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. */ @@ -18946,30 +18197,24 @@ export interface operations { /** @description The exported archive file is not ready yet. */ 202: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * If ready and available, return raw contents of exported history as a downloadable archive. - * @deprecated - * @description See ``PUT /api/histories/{id}/exports`` to initiate the creation - * of the history export - when ready, that route will return 200 status - * code (instead of 202) and this route can be used to download the archive. - * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. - */ history_archive_download_api_histories__history_id__exports__jeha_id__get: { + /** + * If ready and available, return raw contents of exported history as a downloadable archive. + * @deprecated + * @description See ``PUT /api/histories/{id}/exports`` to initiate the creation + * of the history export - when ready, that route will return 200 status + * code (instead of 202) and this route can be used to download the archive. + * + * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or + * `/api/histories/{id}/write_store` instead. + */ parameters: { header?: { /** @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. */ @@ -18986,29 +18231,23 @@ export interface operations { /** @description The archive file containing the History. */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. - * @description Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. - * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ index_jobs_summary_api_histories__history_id__jobs_summary_get: { + /** + * Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. + * @description Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. + * + * **Warning**: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ parameters: { query?: { /** @description A comma-separated list of encoded ids of job summary objects to return - if `ids` is specified types must also be specified and have same length. */ @@ -19037,21 +18276,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Materialize a deferred library or HDA dataset into real, usable dataset in specified history. */ materialize_to_history_api_histories__history_id__materialize_post: { + /** Materialize a deferred library or HDA dataset into real, usable dataset in specified history. */ parameters: { header?: { /** @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. */ @@ -19075,21 +18308,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return a short term storage token to monitor download of the history. */ prepare_store_download_api_histories__history_id__prepare_store_download_post: { + /** Return a short term storage token to monitor download of the history. */ parameters: { header?: { /** @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. */ @@ -19113,24 +18340,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ publish_api_histories__history_id__publish_put: { + /** + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -19149,24 +18370,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ share_with_users_api_histories__history_id__share_with_users_put: { + /** + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -19190,24 +18405,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get the current sharing status of the given item. - * @description Return the sharing status of the item. - */ sharing_api_histories__history_id__sharing_get: { + /** + * Get the current sharing status of the given item. + * @description Return the sharing status of the item. + */ parameters: { header?: { /** @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. */ @@ -19226,24 +18435,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ set_slug_api_histories__history_id__slug_put: { + /** + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. + */ parameters: { header?: { /** @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. */ @@ -19263,21 +18466,15 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tags based on history_id */ index_api_histories__history_id__tags_get: { + /** Show tags based on history_id */ parameters: { header?: { /** @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. */ @@ -19295,21 +18492,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tag based on history_id */ show_api_histories__history_id__tags__tag_name__get: { + /** Show tag based on history_id */ parameters: { header?: { /** @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. */ @@ -19328,21 +18519,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update tag based on history_id */ update_api_histories__history_id__tags__tag_name__put: { + /** Update tag based on history_id */ parameters: { header?: { /** @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. */ @@ -19366,21 +18551,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create tag based on history_id */ create_api_histories__history_id__tags__tag_name__post: { + /** Create tag based on history_id */ parameters: { header?: { /** @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. */ @@ -19404,21 +18583,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete tag based on history_id */ delete_api_histories__history_id__tags__tag_name__delete: { + /** Delete tag based on history_id */ parameters: { header?: { /** @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. */ @@ -19437,24 +18610,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ unpublish_api_histories__history_id__unpublish_put: { + /** + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -19473,21 +18640,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Prepare history for export-style download and write to supplied URI. */ write_store_api_histories__history_id__write_store_post: { + /** Prepare history for export-style download and write to supplied URI. */ parameters: { header?: { /** @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. */ @@ -19511,22 +18672,28 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get the list of a user's workflow invocations. */ index_invocations_api_invocations_get: { - parameters: { + /** Get the list of a user's workflow invocations. */ + 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?: { /** @description Return only invocations for this Workflow ID */ workflow_id?: string | null; @@ -19567,25 +18734,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create Invocations From Store - * @description Create invocation(s) from a supplied model store. - */ create_invocations_from_store_api_invocations_from_store_post: { - parameters: { + /** + * Create Invocations From Store + * @description Create invocation(s) from a supplied model store. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -19604,21 +18766,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show details of workflow invocation step. */ step_api_invocations_steps__step_id__get: { + /** Show details of workflow invocation step. */ parameters: { header?: { /** @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. */ @@ -19637,21 +18793,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get detailed description of a workflow invocation. */ show_invocation_api_invocations__invocation_id__get: { + /** Get detailed description of a workflow invocation. */ parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ @@ -19681,21 +18831,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Cancel the specified workflow invocation. */ cancel_invocation_api_invocations__invocation_id__delete: { + /** Cancel the specified workflow invocation. */ parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ @@ -19725,27 +18869,21 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ invocation_jobs_summary_api_invocations__invocation_id__jobs_summary_get: { + /** + * Get job state summary info aggregated across all current jobs of the workflow invocation. + * @description Warning: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ parameters: { header?: { /** @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. */ @@ -19764,21 +18902,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Prepare a workflow invocation export-style download. */ prepare_store_download_api_invocations__invocation_id__prepare_store_download_post: { + /** Prepare a workflow invocation export-style download. */ parameters: { header?: { /** @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. */ @@ -19802,21 +18934,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get JSON summarizing invocation for reporting. */ show_invocation_report_api_invocations__invocation_id__report_get: { + /** Get JSON summarizing invocation for reporting. */ parameters: { header?: { /** @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. */ @@ -19835,21 +18961,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get PDF summarizing invocation for reporting. */ show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get: { + /** Get PDF summarizing invocation for reporting. */ parameters: { header?: { /** @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. */ @@ -19864,27 +18984,21 @@ export interface operations { /** @description Successful Response */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ invocation_step_jobs_summary_api_invocations__invocation_id__step_jobs_summary_get: { + /** + * Get job state summary info aggregated per step of the workflow invocation. + * @description Warning: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ parameters: { header?: { /** @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. */ @@ -19907,24 +19021,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Show details of workflow invocation step. - * @description An alias for `GET /api/invocations/steps/{step_id}`. `invocation_id` is ignored. - */ invocation_step_api_invocations__invocation_id__steps__step_id__get: { + /** + * Show details of workflow invocation step. + * @description An alias for `GET /api/invocations/steps/{step_id}`. `invocation_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -19945,21 +19053,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update state of running workflow step invocation - still very nebulous but this would be for stuff like confirming paused steps can proceed etc. */ update_invocation_step_api_invocations__invocation_id__steps__step_id__put: { + /** Update state of running workflow step invocation - still very nebulous but this would be for stuff like confirming paused steps can proceed etc. */ parameters: { header?: { /** @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. */ @@ -19985,21 +19087,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Prepare a workflow invocation export-style download and write to supplied URI. */ write_store_api_invocations__invocation_id__write_store_post: { + /** Prepare a workflow invocation export-style download and write to supplied URI. */ parameters: { header?: { /** @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. */ @@ -20023,25 +19119,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Job Lock Status - * @description Get job lock status. - */ job_lock_status_api_job_lock_get: { - parameters: { + /** + * Job Lock Status + * @description Get job lock status. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -20055,25 +19146,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Update Job Lock - * @description Set job lock status. - */ update_job_lock_api_job_lock_put: { - parameters: { + /** + * Update Job Lock + * @description Set job lock status. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -20092,79 +19178,78 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Index */ index_api_jobs_get: { - parameters: { + /** Index */ + parameters?: { + /** @description If true, and requester is an admin, will return external job id and user email. This is only available to admins. */ + /** @description an encoded user id to restrict query to, must be own id if not admin user */ + /** @description Determines columns to return. Defaults to 'collection'. */ + /** @description Limit listing of jobs to those that are updated after specified date (e.g. '2014-01-01') */ + /** @description Limit listing of jobs to those that are updated before specified date (e.g. '2014-01-01') */ + /** @description Limit listing of jobs to those that match the history_id. If none, jobs from any history may be returned. */ + /** @description Limit listing of jobs to those that match the specified workflow ID. If none, jobs from any workflow (or from no workflows) may be returned. */ + /** @description Limit listing of jobs to those that match the specified workflow invocation ID. If none, jobs from any workflow invocation (or from no workflows) may be returned. */ + /** @description Limit listing of jobs to those that match the specified implicit collection job ID. If none, jobs from any implicit collection execution (or from no implicit collection execution) may be returned. */ + /** @description Sort results by specified field. */ + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `user` + * : The user email of the user that executed the Job. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tool_id` + * : The tool ID corresponding to the job. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `runner` + * : The job runner name used to execute the job. (The tag `r` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. + * + * `handler` + * : The job handler name used to execute the job. (The tag `h` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Jobs: `user`, `tool`, `handler`, `runner`. + */ + /** @description Maximum number of jobs to return. */ + /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ + /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ + /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ + /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ query?: { - /** @description If true, and requester is an admin, will return external job id and user email. This is only available to admins. */ user_details?: boolean; - /** @description an encoded user id to restrict query to, must be own id if not admin user */ user_id?: string | null; - /** @description Determines columns to return. Defaults to 'collection'. */ view?: components["schemas"]["JobIndexViewEnum"]; - /** @description Limit listing of jobs to those that are updated after specified date (e.g. '2014-01-01') */ - date_range_min?: string | null; - /** @description Limit listing of jobs to those that are updated before specified date (e.g. '2014-01-01') */ - date_range_max?: string | null; - /** @description Limit listing of jobs to those that match the history_id. If none, jobs from any history may be returned. */ + date_range_min?: string | string | null; + date_range_max?: string | string | null; history_id?: string | null; - /** @description Limit listing of jobs to those that match the specified workflow ID. If none, jobs from any workflow (or from no workflows) may be returned. */ workflow_id?: string | null; - /** @description Limit listing of jobs to those that match the specified workflow invocation ID. If none, jobs from any workflow invocation (or from no workflows) may be returned. */ invocation_id?: string | null; - /** @description Limit listing of jobs to those that match the specified implicit collection job ID. If none, jobs from any implicit collection execution (or from no implicit collection execution) may be returned. */ implicit_collection_jobs_id?: string | null; - /** @description Sort results by specified field. */ order_by?: components["schemas"]["JobIndexSortByEnum"]; - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `user` - * : The user email of the user that executed the Job. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tool_id` - * : The tool ID corresponding to the job. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `runner` - * : The job runner name used to execute the job. (The tag `r` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. - * - * `handler` - * : The job handler name used to execute the job. (The tag `h` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Jobs: `user`, `tool`, `handler`, `runner`. - */ search?: string | null; /** @description Maximum number of jobs to return. */ limit?: number; @@ -20194,27 +19279,22 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return jobs for current user - * @description This method is designed to scan the list of previously run jobs and find records of jobs that had - * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply - * recycle the old results. - */ search_jobs_api_jobs_search_post: { - parameters: { + /** + * Return jobs for current user + * @description This method is designed to scan the list of previously run jobs and find records of jobs that had + * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply + * recycle the old results. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -20233,21 +19313,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return dictionary containing description of job data. */ show_job_api_jobs__job_id__get: { + /** Return dictionary containing description of job data. */ parameters: { query?: { /** @description Show extra information. */ @@ -20272,21 +19346,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Cancels specified job */ cancel_job_api_jobs__job_id__delete: { + /** Cancels specified job */ parameters: { header?: { /** @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. */ @@ -20310,21 +19378,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Check inputs and job for common potential problems to aid in error reporting */ check_common_problems_api_jobs__job_id__common_problems_get: { + /** Check inputs and job for common potential problems to aid in error reporting */ parameters: { header?: { /** @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. */ @@ -20343,21 +19405,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return destination parameters for specified job. */ destination_params_job_api_jobs__job_id__destination_params_get: { + /** Return destination parameters for specified job. */ parameters: { header?: { /** @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. */ @@ -20376,21 +19432,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Submits a bug report via the API. */ report_error_api_jobs__job_id__error_post: { + /** Submits a bug report via the API. */ parameters: { header?: { /** @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. */ @@ -20414,21 +19464,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns input datasets created by a job. */ get_inputs_api_jobs__job_id__inputs_get: { + /** Returns input datasets created by a job. */ parameters: { header?: { /** @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. */ @@ -20447,21 +19491,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return job metrics for specified job. */ get_metrics_api_jobs__job_id__metrics_get: { + /** Return job metrics for specified job. */ parameters: { query?: { /** @@ -20487,24 +19525,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get a fresh OIDC token - * @description Allows remote job running mechanisms to get a fresh OIDC token that can be used on remote side to authorize user. It is not meant to represent part of Galaxy's stable, user facing API - */ get_token_api_jobs__job_id__oidc_tokens_get: { + /** + * Get a fresh OIDC token + * @description Allows remote job running mechanisms to get a fresh OIDC token that can be used on remote side to authorize user. It is not meant to represent part of Galaxy's stable, user facing API + */ parameters: { query: { /** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job */ @@ -20528,21 +19560,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns output datasets created by a job. */ get_outputs_api_jobs__job_id__outputs_get: { + /** Returns output datasets created by a job. */ parameters: { header?: { /** @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. */ @@ -20561,26 +19587,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Resolve parameters as a list for nested display. - * @description Resolve parameters as a list for nested display. - * This API endpoint is unstable and tied heavily to Galaxy's JS client code, - * this endpoint will change frequently. - */ resolve_parameters_display_api_jobs__job_id__parameters_display_get: { + /** + * Resolve parameters as a list for nested display. + * @description Resolve parameters as a list for nested display. + * This API endpoint is unstable and tied heavily to Galaxy's JS client code, + * this endpoint will change frequently. + */ parameters: { query?: { /** @@ -20606,21 +19626,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Resumes a paused job. */ resume_paused_job_api_jobs__job_id__resume_put: { + /** Resumes a paused job. */ parameters: { header?: { /** @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. */ @@ -20639,25 +19653,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns a list of summary data for all libraries. - * @description Returns a list of summary data for all libraries. - */ index_api_libraries_get: { - parameters: { + /** + * Returns a list of summary data for all libraries. + * @description Returns a list of summary data for all libraries. + */ + parameters?: { + /** @description Whether to include deleted libraries in the result. */ query?: { /** @description Whether to include deleted libraries in the result. */ deleted?: boolean | null; @@ -20675,25 +19684,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Creates a new library and returns its summary information. - * @description Creates a new library and returns its summary information. Currently, only admin users can create libraries. - */ create_api_libraries_post: { - parameters: { + /** + * Creates a new library and returns its summary information. + * @description Creates a new library and returns its summary information. Currently, only admin users can create libraries. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -20712,25 +19716,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns a list of summary data for all libraries marked as deleted. - * @description Returns a list of summary data for all libraries marked as deleted. - */ index_deleted_api_libraries_deleted_get: { - parameters: { + /** + * Returns a list of summary data for all libraries marked as deleted. + * @description Returns a list of summary data for all libraries marked as deleted. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -20744,22 +19743,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create libraries from a model store. */ create_from_store_api_libraries_from_store_post: { - parameters: { + /** Create libraries from a model store. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -20778,24 +19772,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns summary information about a particular library. - * @description Returns summary information about a particular library. - */ show_api_libraries__id__get: { + /** + * Returns summary information about a particular library. + * @description Returns summary information about a particular library. + */ parameters: { header?: { /** @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. */ @@ -20814,25 +19802,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Marks the specified library as deleted (or undeleted). - * @description Marks the specified library as deleted (or undeleted). - * Currently, only admin users can delete or restore libraries. - */ delete_api_libraries__id__delete: { + /** + * Marks the specified library as deleted (or undeleted). + * @description Marks the specified library as deleted (or undeleted). + * Currently, only admin users can delete or restore libraries. + */ parameters: { query?: { /** @description Whether to restore a deleted library. */ @@ -20860,24 +19842,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the information of an existing library. - * @description Updates the information of an existing library. - */ update_api_libraries__id__patch: { + /** + * Updates the information of an existing library. + * @description Updates the information of an existing library. + */ parameters: { header?: { /** @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. */ @@ -20901,25 +19877,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Gets the current or available permissions of a particular library. - * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. - */ get_permissions_api_libraries__id__permissions_get: { + /** + * Gets the current or available permissions of a particular library. + * @description Gets the current or available permissions of a particular library. + * The results can be paginated and additionally filtered by a query. + */ parameters: { query?: { /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ @@ -20952,24 +19922,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Sets the permissions to access and manipulate a library. - * @description Sets the permissions to access and manipulate a library. - */ set_permissions_api_libraries__id__permissions_post: { + /** + * Sets the permissions to access and manipulate a library. + * @description Sets the permissions to access and manipulate a library. + */ parameters: { query?: { /** @description Indicates what action should be performed on the Library. */ @@ -21001,24 +19965,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Lists all available SPDX licenses - * @description Returns an index with all the available [SPDX licenses](https://spdx.org/licenses/). - */ index_api_licenses_get: { + /** + * Lists all available SPDX licenses + * @description Returns an index with all the available [SPDX licenses](https://spdx.org/licenses/). + */ responses: { /** @description List of SPDX licenses */ 200: { @@ -21027,7 +19985,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -21054,25 +20012,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Records a collection of metrics. - * @description Record any metrics sent and return some status object. - */ create_api_metrics_post: { - parameters: { + /** + * Records a collection of metrics. + * @description Record any metrics sent and return some status object. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -21091,27 +20044,21 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the list of notifications associated with the user. - * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. - * - * You can use the `limit` and `offset` parameters to paginate through the notifications. - */ get_user_notifications_api_notifications_get: { - parameters: { + /** + * Returns the list of notifications associated with the user. + * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. + * + * You can use the `limit` and `offset` parameters to paginate through the notifications. + */ + parameters?: { query?: { limit?: number | null; offset?: number | null; @@ -21129,22 +20076,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Updates a list of notifications with the requested values in a single request. */ update_user_notifications_api_notifications_put: { - parameters: { + /** Updates a list of notifications with the requested values in a single request. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -21163,25 +20105,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Sends a notification to a list of recipients (users, groups or roles). - * @description Sends a notification to a list of recipients (users, groups or roles). - */ send_notification_api_notifications_post: { - parameters: { + /** + * Sends a notification to a list of recipients (users, groups or roles). + * @description Sends a notification to a list of recipients (users, groups or roles). + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -21202,22 +20139,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Deletes a list of notifications received by the user in a single request. */ delete_user_notifications_api_notifications_delete: { - parameters: { + /** Deletes a list of notifications received by the user in a single request. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -21236,25 +20168,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns all currently active broadcasted notifications. - * @description Only Admin users can access inactive notifications (scheduled or recently expired). - */ get_all_broadcasted_api_notifications_broadcast_get: { - parameters: { + /** + * Returns all currently active broadcasted notifications. + * @description Only Admin users can access inactive notifications (scheduled or recently expired). + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -21268,36 +20195,31 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Broadcasts a notification to every user in the system. - * @description Broadcasted notifications are a special kind of notification that are always accessible to all users, including anonymous users. - * They are typically used to display important information such as maintenance windows or new features. - * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. - * - * Broadcasted notifications can include action links that are displayed as buttons. - * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. - * - * Some key features of broadcasted notifications include: - * - They are not associated with a specific user, so they cannot be deleted or marked as read. - * - They can be scheduled to be displayed in the future or to expire after a certain time. - * - By default, broadcasted notifications are published immediately and expire six months after publication. - * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. - */ broadcast_notification_api_notifications_broadcast_post: { - parameters: { + /** + * Broadcasts a notification to every user in the system. + * @description Broadcasted notifications are a special kind of notification that are always accessible to all users, including anonymous users. + * They are typically used to display important information such as maintenance windows or new features. + * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. + * + * Broadcasted notifications can include action links that are displayed as buttons. + * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. + * + * Some key features of broadcasted notifications include: + * - They are not associated with a specific user, so they cannot be deleted or marked as read. + * - They can be scheduled to be displayed in the future or to expire after a certain time. + * - By default, broadcasted notifications are published immediately and expire six months after publication. + * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -21316,24 +20238,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the information of a specific broadcasted notification. - * @description Only Admin users can access inactive notifications (scheduled or recently expired). - */ get_broadcasted_api_notifications_broadcast__notification_id__get: { + /** + * Returns the information of a specific broadcasted notification. + * @description Only Admin users can access inactive notifications (scheduled or recently expired). + */ parameters: { header?: { /** @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. */ @@ -21352,24 +20268,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the state of a broadcasted notification. - * @description Only Admins can update broadcasted notifications. This is useful to reschedule, edit or expire broadcasted notifications. - */ update_broadcasted_notification_api_notifications_broadcast__notification_id__put: { + /** + * Updates the state of a broadcasted notification. + * @description Only Admins can update broadcasted notifications. This is useful to reschedule, edit or expire broadcasted notifications. + */ parameters: { header?: { /** @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. */ @@ -21389,28 +20299,23 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the current user's preferences for notifications. - * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. - * - * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. - * The supported channels are returned in the `supported-channels` header. - */ get_notification_preferences_api_notifications_preferences_get: { - parameters: { + /** + * Returns the current user's preferences for notifications. + * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. + * + * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. + * The supported channels are returned in the `supported-channels` header. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -21424,28 +20329,23 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the user's preferences for notifications. - * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. - * - * - Can be used to completely enable/disable notifications for a particular type (category) - * or to enable/disable a particular channel on each category. - */ update_notification_preferences_api_notifications_preferences_put: { - parameters: { + /** + * Updates the user's preferences for notifications. + * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. + * + * - Can be used to completely enable/disable notifications for a particular type (category) + * or to enable/disable a particular channel on each category. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -21464,24 +20364,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the current status summary of the user's notifications since a particular date. - * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. - */ get_notifications_status_api_notifications_status_get: { + /** + * Returns the current status summary of the user's notifications since a particular date. + * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. + */ parameters: { query: { since: string; @@ -21499,21 +20393,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays information about a notification received by the user. */ show_notification_api_notifications__notification_id__get: { + /** Displays information about a notification received by the user. */ parameters: { header?: { /** @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. */ @@ -21532,21 +20420,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Updates the state of a notification received by the user. */ update_user_notification_api_notifications__notification_id__put: { + /** Updates the state of a notification received by the user. */ parameters: { header?: { /** @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. */ @@ -21566,28 +20448,22 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Deletes a notification received by the user. - * @description When a notification is deleted, it is not immediately removed from the database, but marked as deleted. - * - * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. - * - It will be eventually removed from the database by a background task after the expiration time. - * - Deleted notifications will be permanently deleted when the expiration time is reached. - */ delete_user_notification_api_notifications__notification_id__delete: { + /** + * Deletes a notification received by the user. + * @description When a notification is deleted, it is not immediately removed from the database, but marked as deleted. + * + * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. + * - It will be eventually removed from the database by a background task after the expiration time. + * - Deleted notifications will be permanently deleted when the expiration time is reached. + */ parameters: { header?: { /** @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. */ @@ -21602,22 +20478,17 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ index_api_object_stores_get: { - parameters: { + /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ + parameters?: { + /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ query?: { /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ selectable?: boolean; @@ -21635,21 +20506,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get information about a concrete object store configured with Galaxy. */ show_info_api_object_stores__object_store_id__get: { + /** Get information about a concrete object store configured with Galaxy. */ parameters: { header?: { /** @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. */ @@ -21668,66 +20533,62 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Lists all Pages viewable by the user. - * @description Get a list with summary information of all Pages available to the user. - */ index_api_pages_get: { - parameters: { + /** + * Lists all Pages viewable by the user. + * @description Get a list with summary information of all Pages available to the user. + */ + parameters?: { + /** @description Whether to include deleted pages in the result. */ + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `title` + * : The page's title. + * + * `slug` + * : The page's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The page's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `user` + * : The page's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Pages: `title`, `slug`, `tag`, `user`. + */ + /** @description Sort page index by this specified attribute on the page model */ + /** @description Sort in descending order? */ query?: { - /** @description Whether to include deleted pages in the result. */ deleted?: boolean; limit?: number; offset?: number; - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `title` - * : The page's title. - * - * `slug` - * : The page's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The page's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `user` - * : The page's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Pages: `title`, `slug`, `tag`, `user`. - */ search?: string | null; show_own?: boolean; show_published?: boolean; @@ -21751,25 +20612,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create a page and return summary information. - * @description Get a list with details of all Pages available to the user. - */ create_api_pages_post: { - parameters: { + /** + * Create a page and return summary information. + * @description Get a list with details of all Pages available to the user. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -21788,24 +20644,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return a page summary and the content of the last revision. - * @description Return summary information about a specific Page and the content of the last revision. - */ show_api_pages__id__get: { + /** + * Return a page summary and the content of the last revision. + * @description Return summary information about a specific Page and the content of the last revision. + */ parameters: { header?: { /** @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. */ @@ -21824,24 +20674,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Marks the specific Page as deleted. - * @description Marks the Page with the given ID as deleted. - */ delete_api_pages__id__delete: { + /** + * Marks the specific Page as deleted. + * @description Marks the Page with the given ID as deleted. + */ parameters: { header?: { /** @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. */ @@ -21856,26 +20700,20 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return a PDF document of the last revision of the Page. - * @description Return a PDF document of the last revision of the Page. - * - * This feature may not be available in this Galaxy. - */ show_pdf_api_pages__id__pdf_get: { + /** + * Return a PDF document of the last revision of the Page. + * @description Return a PDF document of the last revision of the Page. + * + * This feature may not be available in this Galaxy. + */ parameters: { header?: { /** @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. */ @@ -21894,15 +20732,9 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description PDF conversion service not available. */ @@ -21934,24 +20766,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ enable_link_access_api_pages__id__enable_link_access_put: { + /** + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -21970,26 +20796,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return a PDF document of the last revision of the Page. - * @description Return a STS download link for this page to be downloaded as a PDF. - * - * This feature may not be available in this Galaxy. - */ prepare_pdf_api_pages__id__prepare_download_post: { + /** + * Return a PDF document of the last revision of the Page. + * @description Return a STS download link for this page to be downloaded as a PDF. + * + * This feature may not be available in this Galaxy. + */ parameters: { header?: { /** @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. */ @@ -22008,15 +20828,9 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description PDF conversion service not available. */ @@ -22048,24 +20862,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ share_with_users_api_pages__id__share_with_users_put: { + /** + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -22089,24 +20897,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get the current sharing status of the given Page. - * @description Return the sharing status of the item. - */ sharing_api_pages__id__sharing_get: { + /** + * Get the current sharing status of the given Page. + * @description Return the sharing status of the item. + */ parameters: { header?: { /** @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. */ @@ -22125,24 +20927,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ set_slug_api_pages__id__slug_put: { + /** + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. + */ parameters: { header?: { /** @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. */ @@ -22162,24 +20958,18 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Undelete the specific Page. - * @description Marks the Page with the given ID as undeleted. - */ undelete_api_pages__id__undelete_put: { + /** + * Undelete the specific Page. + * @description Marks the Page with the given ID as undeleted. + */ parameters: { header?: { /** @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. */ @@ -22194,24 +20984,18 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ unpublish_api_pages__id__unpublish_put: { + /** + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -22230,25 +21014,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays a list with information of quotas that are currently active. - * @description Displays a list with information of quotas that are currently active. - */ index_api_quotas_get: { - parameters: { + /** + * Displays a list with information of quotas that are currently active. + * @description Displays a list with information of quotas that are currently active. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -22262,25 +21041,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Creates a new quota. - * @description Creates a new quota. - */ create_api_quotas_post: { - parameters: { + /** + * Creates a new quota. + * @description Creates a new quota. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -22299,25 +21073,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays a list with information of quotas that have been deleted. - * @description Displays a list with information of quotas that have been deleted. - */ index_deleted_api_quotas_deleted_get: { - parameters: { + /** + * Displays a list with information of quotas that have been deleted. + * @description Displays a list with information of quotas that have been deleted. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -22331,24 +21100,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays details on a particular quota that has been deleted. - * @description Displays details on a particular quota that has been deleted. - */ deleted_quota_api_quotas_deleted__id__get: { + /** + * Displays details on a particular quota that has been deleted. + * @description Displays details on a particular quota that has been deleted. + */ parameters: { header?: { /** @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. */ @@ -22367,24 +21130,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Restores a previously deleted quota. - * @description Restores a previously deleted quota. - */ undelete_api_quotas_deleted__id__undelete_post: { + /** + * Restores a previously deleted quota. + * @description Restores a previously deleted quota. + */ parameters: { header?: { /** @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. */ @@ -22403,24 +21160,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays details on a particular active quota. - * @description Displays details on a particular active quota. - */ quota_api_quotas__id__get: { + /** + * Displays details on a particular active quota. + * @description Displays details on a particular active quota. + */ parameters: { header?: { /** @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. */ @@ -22439,24 +21190,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates an existing quota. - * @description Updates an existing quota. - */ update_api_quotas__id__put: { + /** + * Updates an existing quota. + * @description Updates an existing quota. + */ parameters: { header?: { /** @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. */ @@ -22480,24 +21225,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Deletes an existing quota. - * @description Deletes an existing quota. - */ delete_api_quotas__id__delete: { + /** + * Deletes an existing quota. + * @description Deletes an existing quota. + */ parameters: { header?: { /** @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. */ @@ -22521,21 +21260,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Purges a previously deleted quota. */ purge_api_quotas__id__purge_post: { + /** Purges a previously deleted quota. */ parameters: { header?: { /** @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. */ @@ -22554,15 +21287,9 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; @@ -22605,25 +21332,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Creates a new entry (directory/record) on the remote files source. - * @description Creates a new entry on the remote files source. - */ create_entry_api_remote_files_post: { - parameters: { + /** + * Creates a new entry (directory/record) on the remote files source. + * @description Creates a new entry on the remote files source. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -22642,25 +21364,22 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Display plugin information for each of the gxfiles:// URI targets available. - * @description Display plugin information for each of the gxfiles:// URI targets available. - */ plugins_api_remote_files_plugins_get: { - parameters: { + /** + * Display plugin information for each of the gxfiles:// URI targets available. + * @description Display plugin information for each of the gxfiles:// URI targets available. + */ + parameters?: { + /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ + /** @description Whether to return **only** filesources of the specified kind. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ + /** @description Whether to exclude filesources of the specified kind from the list. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ query?: { /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ browsable_only?: boolean | null; @@ -22682,22 +21401,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Index */ index_api_roles_get: { - parameters: { + /** Index */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -22711,22 +21425,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create */ create_api_roles_post: { - parameters: { + /** Create */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -22745,21 +21454,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show */ show_api_roles__id__get: { + /** Show */ parameters: { header?: { /** @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. */ @@ -22777,21 +21480,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete */ delete_api_roles__id__delete: { + /** Delete */ parameters: { header?: { /** @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. */ @@ -22805,25 +21502,19 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["RoleModelResponse"]; - }; - }; - /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Validation Error */ + /** @description Bad Request */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Purge */ purge_api_roles__id__purge_post: { + /** Purge */ parameters: { header?: { /** @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. */ @@ -22841,21 +21532,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Undelete */ undelete_api_roles__id__undelete_post: { + /** Undelete */ parameters: { header?: { /** @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. */ @@ -22873,21 +21558,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Serve the staged download specified by request ID. */ serve_api_short_term_storage__storage_request_id__get: { + /** Serve the staged download specified by request ID. */ parameters: { path: { storage_request_id: string; @@ -22901,21 +21580,15 @@ export interface operations { /** @description Request was cancelled without an exception condition recorded. */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Determine if specified storage request ID is ready for download. */ is_ready_api_short_term_storage__storage_request_id__ready_get: { + /** Determine if specified storage request ID is ready for download. */ parameters: { path: { storage_request_id: string; @@ -22929,25 +21602,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Purges a set of datasets by ID from disk. The datasets must be owned by the user. - * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. - */ cleanup_datasets_api_storage_datasets_delete: { - parameters: { + /** + * Purges a set of datasets by ID from disk. The datasets must be owned by the user. + * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -22966,22 +21634,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns discarded datasets owned by the given user. The results can be paginated. */ discarded_datasets_api_storage_datasets_discarded_get: { - parameters: { + /** Returns discarded datasets owned by the given user. The results can be paginated. */ + parameters?: { + /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ query?: { /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ offset?: number | null; @@ -23003,22 +21668,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns information with the total storage space taken by discarded datasets owned by the given user. */ discarded_datasets_summary_api_storage_datasets_discarded_summary_get: { - parameters: { + /** Returns information with the total storage space taken by discarded datasets owned by the given user. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -23032,25 +21692,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Purges a set of histories by ID. The histories must be owned by the user. - * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. - */ cleanup_histories_api_storage_histories_delete: { - parameters: { + /** + * Purges a set of histories by ID. The histories must be owned by the user. + * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -23069,22 +21724,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns archived histories owned by the given user that are not purged. The results can be paginated. */ archived_histories_api_storage_histories_archived_get: { - parameters: { + /** Returns archived histories owned by the given user that are not purged. The results can be paginated. */ + parameters?: { + /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ query?: { /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ offset?: number | null; @@ -23106,22 +21758,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns information with the total storage space taken by non-purged archived histories associated with the given user. */ archived_histories_summary_api_storage_histories_archived_summary_get: { - parameters: { + /** Returns information with the total storage space taken by non-purged archived histories associated with the given user. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -23135,22 +21782,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns all discarded histories associated with the given user. */ discarded_histories_api_storage_histories_discarded_get: { - parameters: { + /** Returns all discarded histories associated with the given user. */ + parameters?: { + /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ query?: { /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ offset?: number | null; @@ -23172,22 +21816,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns information with the total storage space taken by discarded histories associated with the given user. */ discarded_histories_summary_api_storage_histories_discarded_summary_get: { - parameters: { + /** Returns information with the total storage space taken by discarded histories associated with the given user. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -23201,28 +21840,23 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Apply a new set of tags to an item. - * @description Replaces the tags associated with an item with the new ones specified in the payload. - * - * - The previous tags will be __deleted__. - * - If no tags are provided in the request body, the currently associated tags will also be __deleted__. - */ update_api_tags_put: { - parameters: { + /** + * Apply a new set of tags to an item. + * @description Replaces the tags associated with an item with the new ones specified in the payload. + * + * - The previous tags will be __deleted__. + * - If no tags are provided in the request body, the currently associated tags will also be __deleted__. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -23237,21 +21871,15 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Determine state of task ID */ state_api_tasks__task_id__state_get: { + /** Determine state of task ID */ parameters: { path: { task_id: string; @@ -23265,24 +21893,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Lists all available data tables - * @description Get the list of all available data tables. - */ index_api_tool_data_get: { + /** + * Lists all available data tables + * @description Get the list of all available data tables. + */ responses: { /** @description A list with details on individual data tables. */ 200: { @@ -23291,7 +21913,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -23322,24 +21944,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get details of a given data table - * @description Get details of a given tool data table. - */ show_api_tool_data__table_name__get: { + /** + * Get details of a given data table + * @description Get details of a given tool data table. + */ parameters: { header?: { /** @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. */ @@ -23358,24 +21974,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes an item from a data table - * @description Removes an item from a data table and reloads it to return its updated details. - */ delete_api_tool_data__table_name__delete: { + /** + * Removes an item from a data table + * @description Removes an item from a data table and reloads it to return its updated details. + */ parameters: { header?: { /** @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. */ @@ -23399,24 +22009,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get information about a particular field in a tool data table - * @description Reloads a data table and return its details. - */ show_field_api_tool_data__table_name__fields__field_name__get: { + /** + * Get information about a particular field in a tool data table + * @description Reloads a data table and return its details. + */ parameters: { header?: { /** @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. */ @@ -23437,24 +22041,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get information about a particular field in a tool data table - * @description Download a file associated with the data table field. - */ download_field_file_api_tool_data__table_name__fields__field_name__files__file_name__get: { + /** + * Get information about a particular field in a tool data table + * @description Download a file associated with the data table field. + */ parameters: { header?: { /** @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. */ @@ -23473,24 +22071,18 @@ export interface operations { /** @description Information about a data table field */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Reloads a tool data table - * @description Reloads a data table and return its details. - */ reload_api_tool_data__table_name__reload_get: { + /** + * Reloads a tool data table + * @description Reloads a data table and return its details. + */ parameters: { header?: { /** @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. */ @@ -23509,22 +22101,21 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Lists installed tool shed repositories. */ index_api_tool_shed_repositories_get: { - parameters: { + /** Lists installed tool shed repositories. */ + parameters?: { + /** @description Filter by repository name. */ + /** @description Filter by repository owner. */ + /** @description Filter by changeset revision. */ + /** @description Filter by whether the repository has been deleted. */ + /** @description Filter by whether the repository has been uninstalled. */ query?: { /** @description Filter by repository name. */ name?: string | null; @@ -23546,22 +22137,16 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Check for updates to the specified repository, or all installed repositories. */ check_for_updates_api_tool_shed_repositories_check_for_updates_get: { - parameters: { + /** Check for updates to the specified repository, or all installed repositories. */ + parameters?: { query?: { id?: string | null; }; @@ -23578,21 +22163,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show installed tool shed repository. */ show_api_tool_shed_repositories__id__get: { + /** Show installed tool shed repository. */ parameters: { path: { /** @description The encoded database identifier of the installed Tool Shed Repository. */ @@ -23607,22 +22186,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Upload files to Galaxy */ fetch_form_api_tools_fetch_post: { - parameters: { + /** Upload files to Galaxy */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -23641,24 +22215,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Index - * @description Return list of available tours. - */ index_api_tours_get: { + /** + * Index + * @description Return list of available tours. + */ responses: { /** @description Successful Response */ 200: { @@ -23667,7 +22235,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -23692,24 +22260,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Update Tour - * @description Return a tour definition. - */ update_tour_api_tours__tour_id__post: { + /** + * Update Tour + * @description Return a tour definition. + */ parameters: { header?: { /** @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. */ @@ -23726,26 +22288,24 @@ export interface operations { "application/json": components["schemas"]["TourDetails"]; }; }; - /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ + /** @description Bad Request */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get Users - * @description Return a collection of users. Filters will only work if enabled in config or user is admin. - */ get_users_api_users_get: { - parameters: { + /** + * Get Users + * @description Return a collection of users. Filters will only work if enabled in config or user is admin. + */ + parameters?: { + /** @description Indicates if the collection will be about deleted users */ + /** @description An email address to filter on */ + /** @description An username address to filter on */ + /** @description Filter on username OR email */ query?: { /** @description Indicates if the collection will be about deleted users */ deleted?: boolean; @@ -23772,22 +22332,17 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create a new Galaxy user. Only admins can create users for now. */ create_user_api_users_post: { - parameters: { + /** Create a new Galaxy user. Only admins can create users for now. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -23808,27 +22363,22 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Triggers a recalculation of the current user disk usage. - * @description This route will be removed in a future version. - * - * Please use `/api/users/current/recalculate_disk_usage` instead. - */ recalculate_disk_usage_api_users_current_recalculate_disk_usage_put: { - parameters: { + /** + * Triggers a recalculation of the current user disk usage. + * @description This route will be removed in a future version. + * + * Please use `/api/users/current/recalculate_disk_usage` instead. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -23844,25 +22394,22 @@ export interface operations { /** @description The background task was submitted but there is no status tracking ID available. */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get Deleted Users - * @description Return a collection of deleted users. Only admins can see deleted users. - */ get_deleted_users_api_users_deleted_get: { - parameters: { + /** + * Get Deleted Users + * @description Return a collection of deleted users. Only admins can see deleted users. + */ + parameters?: { + /** @description An email address to filter on */ + /** @description An username address to filter on */ + /** @description Filter on username OR email */ query?: { /** @description An email address to filter on */ f_email?: string | null; @@ -23887,21 +22434,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return information about a deleted user. Only admins can see deleted users. */ get_deleted_user_api_users_deleted__user_id__get: { + /** Return information about a deleted user. Only admins can see deleted users. */ parameters: { header?: { /** @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. */ @@ -23922,21 +22463,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Restore a deleted user. Only admins can restore users. */ undelete_user_api_users_deleted__user_id__undelete_post: { + /** Restore a deleted user. Only admins can restore users. */ parameters: { header?: { /** @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. */ @@ -23955,28 +22490,23 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Triggers a recalculation of the current user disk usage. - * @deprecated - * @description This route will be removed in a future version. - * - * Please use `/api/users/current/recalculate_disk_usage` instead. - */ recalculate_disk_usage_api_users_recalculate_disk_usage_put: { - parameters: { + /** + * Triggers a recalculation of the current user disk usage. + * @deprecated + * @description This route will be removed in a future version. + * + * Please use `/api/users/current/recalculate_disk_usage` instead. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -23992,21 +22522,15 @@ export interface operations { /** @description The background task was submitted but there is no status tracking ID available. */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return information about a specified or the current user. Only admin can see deleted or other users */ get_user_api_users__user_id__get: { + /** Return information about a specified or the current user. Only admin can see deleted or other users */ parameters: { query?: { /** @description Indicates if the user is deleted */ @@ -24031,21 +22555,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update the values of a user. Only admin can update others. */ update_user_api_users__user_id__put: { + /** Update the values of a user. Only admin can update others. */ parameters: { query?: { /** @description Indicates if the user is deleted */ @@ -24073,21 +22591,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete a user. Only admins can delete others or purge users. */ delete_user_api_users__user_id__delete: { + /** Delete a user. Only admins can delete others or purge users. */ parameters: { /** @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?: { @@ -24112,21 +22624,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return the user's API key */ get_or_create_api_key_api_users__user_id__api_key_get: { + /** Return the user's API key */ parameters: { header?: { /** @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. */ @@ -24145,21 +22651,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create a new API key for the user */ create_api_key_api_users__user_id__api_key_post: { + /** Create a new API key for the user */ parameters: { header?: { /** @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. */ @@ -24178,21 +22678,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete the current API key of the user */ delete_api_key_api_users__user_id__api_key_delete: { + /** Delete the current API key of the user */ parameters: { header?: { /** @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. */ @@ -24207,21 +22701,15 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return the user's API key with extra information. */ get_api_key_detailed_api_users__user_id__api_key_detailed_get: { + /** Return the user's API key with extra information. */ parameters: { header?: { /** @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. */ @@ -24242,24 +22730,18 @@ export interface operations { /** @description The user doesn't have an API key. */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return information about beacon share settings - * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. - */ get_beacon_settings_api_users__user_id__beacon_get: { + /** + * Return information about beacon share settings + * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. + */ parameters: { header?: { /** @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. */ @@ -24278,24 +22760,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Change beacon setting - * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. - */ set_beacon_settings_api_users__user_id__beacon_post: { + /** + * Change beacon setting + * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. + */ parameters: { header?: { /** @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. */ @@ -24319,21 +22795,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns collection of custom builds. */ get_custom_builds_api_users__user_id__custom_builds_get: { + /** Returns collection of custom builds. */ parameters: { header?: { /** @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. */ @@ -24352,21 +22822,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Add new custom build. */ add_custom_builds_api_users__user_id__custom_builds__key__put: { + /** Add new custom build. */ parameters: { header?: { /** @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. */ @@ -24392,21 +22856,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete a custom build */ delete_custom_build_api_users__user_id__custom_builds__key__delete: { + /** Delete a custom build */ parameters: { header?: { /** @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. */ @@ -24427,21 +22885,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Add the object to user's favorites */ set_favorite_api_users__user_id__favorites__object_type__put: { + /** Add the object to user's favorites */ parameters: { header?: { /** @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. */ @@ -24467,21 +22919,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Remove the object from user's favorites */ remove_favorite_api_users__user_id__favorites__object_type___object_id__delete: { + /** Remove the object from user's favorites */ parameters: { header?: { /** @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. */ @@ -24504,21 +22950,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return the user's object store usage summary broken down by object store ID */ get_user_objectstore_usage_api_users__user_id__objectstore_usage_get: { + /** Return the user's object store usage summary broken down by object store ID */ parameters: { header?: { /** @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. */ @@ -24537,21 +22977,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Triggers a recalculation of the current user disk usage. */ recalculate_disk_usage_by_user_id_api_users__user_id__recalculate_disk_usage_put: { + /** Triggers a recalculation of the current user disk usage. */ parameters: { header?: { /** @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. */ @@ -24572,21 +23006,15 @@ export interface operations { /** @description The background task was submitted but there is no status tracking ID available. */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Sends activation email to user. */ send_activation_email_api_users__user_id__send_activation_email_post: { + /** Sends activation email to user. */ parameters: { header?: { /** @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. */ @@ -24605,21 +23033,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Set the user's theme choice */ set_theme_api_users__user_id__theme__theme__put: { + /** Set the user's theme choice */ parameters: { header?: { /** @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. */ @@ -24640,21 +23062,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return the user's quota usage summary broken down by quota source */ get_user_usage_api_users__user_id__usage_get: { + /** Return the user's quota usage summary broken down by quota source */ parameters: { header?: { /** @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. */ @@ -24673,21 +23089,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return the user's quota usage summary for a given quota source label */ get_user_usage_for_label_api_users__user_id__usage__label__get: { + /** Return the user's quota usage summary for a given quota source label */ parameters: { header?: { /** @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. */ @@ -24708,24 +23118,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return Galaxy version information: major/minor version, optional extra info - * @description Return Galaxy version information: major/minor version, optional extra info. - */ version_api_version_get: { + /** + * Return Galaxy version information: major/minor version, optional extra info + * @description Return Galaxy version information: major/minor version, optional extra info. + */ responses: { /** @description Galaxy version information: major/minor version, optional extra info */ 200: { @@ -24734,7 +23138,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -24810,24 +23214,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ disable_link_access_api_visualizations__id__disable_link_access_put: { + /** + * Makes this item inaccessible by a URL link. + * @description Makes this item inaccessible by a URL link and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -24846,24 +23244,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ enable_link_access_api_visualizations__id__enable_link_access_put: { + /** + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -24882,24 +23274,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ publish_api_visualizations__id__publish_put: { + /** + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -24918,24 +23304,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ share_with_users_api_visualizations__id__share_with_users_put: { + /** + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -24959,24 +23339,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get the current sharing status of the given Visualization. - * @description Return the sharing status of the item. - */ sharing_api_visualizations__id__sharing_get: { + /** + * Get the current sharing status of the given Visualization. + * @description Return the sharing status of the item. + */ parameters: { header?: { /** @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. */ @@ -24995,24 +23369,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ set_slug_api_visualizations__id__slug_put: { + /** + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. + */ parameters: { header?: { /** @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. */ @@ -25032,24 +23400,18 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ unpublish_api_visualizations__id__unpublish_put: { + /** + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -25068,25 +23430,20 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return information about the current authenticated user - * @description Return information about the current authenticated user. - */ whoami_api_whoami_get: { - parameters: { + /** + * Return information about the current authenticated user + * @description Return information about the current authenticated user. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -25100,79 +23457,74 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Lists stored workflows viewable by the user. - * @description Lists stored workflows viewable by the user. - */ index_api_workflows_get: { - parameters: { + /** + * Lists stored workflows viewable by the user. + * @description Lists stored workflows viewable by the user. + */ + parameters?: { + /** @description Whether to restrict result to deleted workflows. */ + /** @description Whether to restrict result to hidden workflows. */ + /** @description Whether to include a list of missing tools per workflow entry */ + /** @description In unspecified, default ordering depends on other parameters but generally the user's own workflows appear first based on update time */ + /** @description Sort in descending order? */ + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `name` + * : The stored workflow's name. (The tag `n` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The workflow's tag, if the tag contains a colon an approach will be made to match the key and value of the tag separately. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `user` + * : The stored workflow's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * `is:published` + * : Include only published workflows in the final result. Be sure the query parameter `show_published` is set to `true` if to include all published workflows and not just the requesting user's. + * + * `is:share_with_me` + * : Include only workflows shared with the requesting user. Be sure the query parameter `show_shared` is set to `true` if to include shared workflows. + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Stored Workflows: `name`, `tag`, `user`. + */ + /** @description Set this to true to skip joining workflow step counts and optimize the resulting index query. Response objects will not contain step counts. */ query?: { - /** @description Whether to restrict result to deleted workflows. */ show_deleted?: boolean; - /** @description Whether to restrict result to hidden workflows. */ show_hidden?: boolean; - /** @description Whether to include a list of missing tools per workflow entry */ missing_tools?: boolean; show_published?: boolean | null; show_shared?: boolean | null; - /** @description In unspecified, default ordering depends on other parameters but generally the user's own workflows appear first based on update time */ sort_by?: ("create_time" | "update_time" | "name") | null; - /** @description Sort in descending order? */ sort_desc?: boolean | null; limit?: number | null; offset?: number | null; - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `name` - * : The stored workflow's name. (The tag `n` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The workflow's tag, if the tag contains a colon an approach will be made to match the key and value of the tag separately. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `user` - * : The stored workflow's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * `is:published` - * : Include only published workflows in the final result. Be sure the query parameter `show_published` is set to `true` if to include all published workflows and not just the requesting user's. - * - * `is:share_with_me` - * : Include only workflows shared with the requesting user. Be sure the query parameter `show_shared` is set to `true` if to include shared workflows. - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Stored Workflows: `name`, `tag`, `user`. - */ search?: string | null; /** @description Set this to true to skip joining workflow step counts and optimize the resulting index query. Response objects will not contain step counts. */ skip_step_counts?: boolean; @@ -25190,22 +23542,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get workflows present in the tools panel. */ get_workflow_menu_api_workflows_menu_get: { - parameters: { + /** Get workflows present in the tools panel. */ + parameters?: { + /** @description Whether to restrict result to deleted workflows. */ + /** @description Whether to restrict result to hidden workflows. */ + /** @description Whether to include a list of missing tools per workflow entry */ query?: { /** @description Whether to restrict result to deleted workflows. */ show_deleted?: boolean | null; @@ -25229,21 +23578,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays information needed to run a workflow. */ show_workflow_api_workflows__workflow_id__get: { + /** Displays information needed to run a workflow. */ parameters: { query?: { instance?: boolean | null; @@ -25269,21 +23612,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Add the deleted flag to a workflow. */ delete_workflow_api_workflows__workflow_id__delete: { + /** Add the deleted flag to a workflow. */ parameters: { header?: { /** @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. */ @@ -25302,21 +23639,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get state counts for accessible workflow. */ workflows__invocation_counts: { + /** Get state counts for accessible workflow. */ parameters: { query?: { /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ @@ -25339,24 +23670,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ disable_link_access_api_workflows__workflow_id__disable_link_access_put: { + /** + * Makes this item inaccessible by a URL link. + * @description Makes this item inaccessible by a URL link and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -25375,24 +23700,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ enable_link_access_api_workflows__workflow_id__enable_link_access_put: { + /** + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -25411,21 +23730,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get the list of a user's workflow invocations. */ index_invocations_api_workflows__workflow_id__invocations_get: { + /** Get the list of a user's workflow invocations. */ parameters: { query?: { /** @description Return only invocations for this History ID */ @@ -25468,21 +23781,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Schedule the workflow specified by `workflow_id` to run. */ Invoke_workflow_api_workflows__workflow_id__invocations_post: { + /** Schedule the workflow specified by `workflow_id` to run. */ parameters: { header?: { /** @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. */ @@ -25508,24 +23815,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get detailed description of a workflow invocation. - * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ show_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__get: { + /** + * Get detailed description of a workflow invocation. + * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. + */ parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ @@ -25557,24 +23858,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Cancel the specified workflow invocation. - * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ cancel_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__delete: { + /** + * Cancel the specified workflow invocation. + * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. + */ parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ @@ -25606,24 +23901,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. - */ workflow_invocation_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__jobs_summary_get: { + /** + * Get job state summary info aggregated across all current jobs of the workflow invocation. + * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -25644,24 +23933,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get JSON summarizing invocation for reporting. - * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. - */ show_workflow_invocation_report_api_workflows__workflow_id__invocations__invocation_id__report_get: { + /** + * Get JSON summarizing invocation for reporting. + * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -25682,24 +23965,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get PDF summarizing invocation for reporting. - * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. - */ show_workflow_invocation_report_pdf_api_workflows__workflow_id__invocations__invocation_id__report_pdf_get: { + /** + * Get PDF summarizing invocation for reporting. + * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -25716,24 +23993,18 @@ export interface operations { /** @description Successful Response */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. - */ workflow_invocation_step_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__step_jobs_summary_get: { + /** + * Get job state summary info aggregated per step of the workflow invocation. + * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -25758,24 +24029,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Show details of workflow invocation step. - * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. - */ workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__get: { + /** + * Show details of workflow invocation step. + * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. + */ parameters: { header?: { /** @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. */ @@ -25798,24 +24063,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Update state of running workflow step invocation. - * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. - */ update_workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__put: { + /** + * Update state of running workflow step invocation. + * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -25843,24 +24102,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ publish_api_workflows__workflow_id__publish_put: { + /** + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -25879,21 +24132,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Updates the workflow stored with the given ID. */ refactor_api_workflows__workflow_id__refactor_put: { + /** Updates the workflow stored with the given ID. */ parameters: { query?: { instance?: boolean | null; @@ -25920,24 +24167,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ share_with_users_api_workflows__workflow_id__share_with_users_put: { + /** + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -25961,24 +24202,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get the current sharing status of the given item. - * @description Return the sharing status of the item. - */ sharing_api_workflows__workflow_id__sharing_get: { + /** + * Get the current sharing status of the given item. + * @description Return the sharing status of the item. + */ parameters: { header?: { /** @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. */ @@ -25997,24 +24232,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ set_slug_api_workflows__workflow_id__slug_put: { + /** + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. + */ parameters: { header?: { /** @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. */ @@ -26034,21 +24263,15 @@ export interface operations { /** @description Successful Response */ 204: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tags based on workflow_id */ index_api_workflows__workflow_id__tags_get: { + /** Show tags based on workflow_id */ parameters: { header?: { /** @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. */ @@ -26066,21 +24289,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tag based on workflow_id */ show_api_workflows__workflow_id__tags__tag_name__get: { + /** Show tag based on workflow_id */ parameters: { header?: { /** @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. */ @@ -26099,21 +24316,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update tag based on workflow_id */ update_api_workflows__workflow_id__tags__tag_name__put: { + /** Update tag based on workflow_id */ parameters: { header?: { /** @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. */ @@ -26137,21 +24348,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create tag based on workflow_id */ create_api_workflows__workflow_id__tags__tag_name__post: { + /** Create tag based on workflow_id */ parameters: { header?: { /** @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. */ @@ -26175,21 +24380,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete tag based on workflow_id */ delete_api_workflows__workflow_id__tags__tag_name__delete: { + /** Delete tag based on workflow_id */ parameters: { header?: { /** @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. */ @@ -26208,21 +24407,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Remove the deleted flag from a workflow. */ undelete_workflow_api_workflows__workflow_id__undelete_post: { + /** Remove the deleted flag from a workflow. */ parameters: { header?: { /** @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. */ @@ -26241,24 +24434,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ unpublish_api_workflows__workflow_id__unpublish_put: { + /** + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. + */ parameters: { header?: { /** @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. */ @@ -26277,24 +24464,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get the list of a user's workflow invocations. - * @deprecated - */ index_invocations_api_workflows__workflow_id__usage_get: { + /** + * Get the list of a user's workflow invocations. + * @deprecated + */ parameters: { query?: { /** @description Return only invocations for this History ID */ @@ -26337,24 +24518,18 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Schedule the workflow specified by `workflow_id` to run. - * @deprecated - */ Invoke_workflow_api_workflows__workflow_id__usage_post: { + /** + * Schedule the workflow specified by `workflow_id` to run. + * @deprecated + */ parameters: { header?: { /** @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. */ @@ -26380,25 +24555,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get detailed description of a workflow invocation. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ show_workflow_invocation_api_workflows__workflow_id__usage__invocation_id__get: { + /** + * Get detailed description of a workflow invocation. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. + */ parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ @@ -26430,25 +24599,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Cancel the specified workflow invocation. - * @deprecated - * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ cancel_workflow_invocation_api_workflows__workflow_id__usage__invocation_id__delete: { + /** + * Cancel the specified workflow invocation. + * @deprecated + * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. + */ parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ @@ -26480,25 +24643,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. - */ workflow_invocation_jobs_summary_api_workflows__workflow_id__usage__invocation_id__jobs_summary_get: { + /** + * Get job state summary info aggregated across all current jobs of the workflow invocation. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -26519,25 +24676,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get JSON summarizing invocation for reporting. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. - */ show_workflow_invocation_report_api_workflows__workflow_id__usage__invocation_id__report_get: { + /** + * Get JSON summarizing invocation for reporting. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -26558,25 +24709,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get PDF summarizing invocation for reporting. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. - */ show_workflow_invocation_report_pdf_api_workflows__workflow_id__usage__invocation_id__report_pdf_get: { + /** + * Get PDF summarizing invocation for reporting. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -26593,25 +24738,19 @@ export interface operations { /** @description Successful Response */ 200: never; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. - */ workflow_invocation_step_jobs_summary_api_workflows__workflow_id__usage__invocation_id__step_jobs_summary_get: { + /** + * Get job state summary info aggregated per step of the workflow invocation. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -26636,25 +24775,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Show details of workflow invocation step. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. - */ workflow_invocation_step_api_workflows__workflow_id__usage__invocation_id__steps__step_id__get: { + /** + * Show details of workflow invocation step. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. + */ parameters: { header?: { /** @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. */ @@ -26677,25 +24810,19 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Update state of running workflow step invocation. - * @deprecated - * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. - */ update_workflow_invocation_step_api_workflows__workflow_id__usage__invocation_id__steps__step_id__put: { + /** + * Update state of running workflow step invocation. + * @deprecated + * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. + */ parameters: { header?: { /** @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. */ @@ -26723,21 +24850,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** List all versions of a workflow. */ show_versions_api_workflows__workflow_id__versions_get: { + /** List all versions of a workflow. */ parameters: { query?: { instance?: boolean | null; @@ -26759,21 +24880,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get Object */ get_object_ga4gh_drs_v1_objects__object_id__get: { + /** Get Object */ parameters: { header?: { /** @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. */ @@ -26792,21 +24907,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get Object */ get_object_ga4gh_drs_v1_objects__object_id__post: { + /** Get Object */ parameters: { header?: { /** @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. */ @@ -26825,21 +24934,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get Access Url */ get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__get: { + /** Get Access Url */ parameters: { header?: { /** @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. */ @@ -26860,21 +24963,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get Access Url */ get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__post: { + /** Get Access Url */ parameters: { header?: { /** @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. */ @@ -26895,21 +24992,15 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Service Info */ service_info_ga4gh_drs_v1_service_info_get: { + /** Service Info */ responses: { /** @description Successful Response */ 200: { @@ -26918,7 +25009,7 @@ export interface operations { }; }; /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; diff --git a/lib/galaxy/schema/schema.py b/lib/galaxy/schema/schema.py index d0383b70cba6..2ba9ff2ce065 100644 --- a/lib/galaxy/schema/schema.py +++ b/lib/galaxy/schema/schema.py @@ -3748,14 +3748,6 @@ class DatasetSummary(Model): uuid: UuidField -class ValidationErrorModel(BaseModel): - type: str - loc: List[int] - msg: str - input: Any - - class MessageExceptionModel(BaseModel): err_msg: str err_code: int - validation_errors: List[ValidationErrorModel] diff --git a/lib/galaxy/webapps/base/api.py b/lib/galaxy/webapps/base/api.py index 825ea5abfbc5..a5c2119a6202 100644 --- a/lib/galaxy/webapps/base/api.py +++ b/lib/galaxy/webapps/base/api.py @@ -240,16 +240,13 @@ def include_all_package_routers(app: FastAPI, package_name: str): for _, module in walk_controller_modules(package_name): router = getattr(module, "router", None) if router: - responses: typing.Optional[typing.Dict[typing.Union[int, str], typing.Dict[str, typing.Any]]] = { - 400: { - "description": "Bad Request", - "model": MessageExceptionModel, + app.include_router( + router, + responses={ + 422: { + "description": "Bad Request", + "model": MessageExceptionModel, + }, }, - } - app.include_router(router, responses=responses) - + ) -def remove_422(app: FastAPI): - for _, operations in app.openapi()["paths"].items(): - for _, metadata in operations.items(): - metadata["responses"].pop("422", None) diff --git a/lib/galaxy/webapps/galaxy/fast_app.py b/lib/galaxy/webapps/galaxy/fast_app.py index 9bd8949853ee..02a191efe9a0 100644 --- a/lib/galaxy/webapps/galaxy/fast_app.py +++ b/lib/galaxy/webapps/galaxy/fast_app.py @@ -20,7 +20,6 @@ add_request_id_middleware, GalaxyFileResponse, include_all_package_routers, - remove_422, ) from galaxy.webapps.base.webapp import config_allows_origin from galaxy.webapps.openapi.utils import get_openapi @@ -186,7 +185,6 @@ def initialize_fast_app(gx_wsgi_webapp, gx_app): else: add_request_id_middleware(app) include_all_package_routers(app, "galaxy.webapps.galaxy.api") - remove_422(app) include_legacy_openapi(app, gx_app) wsgi_handler = WSGIMiddleware(gx_wsgi_webapp) gx_app.haltables.append(("WSGI Middleware threadpool", wsgi_handler.executor.shutdown)) diff --git a/lib/tool_shed/webapp/frontend/src/schema/schema.ts b/lib/tool_shed/webapp/frontend/src/schema/schema.ts index 97cf0929ca39..382a1760171e 100644 --- a/lib/tool_shed/webapp/frontend/src/schema/schema.ts +++ b/lib/tool_shed/webapp/frontend/src/schema/schema.ts @@ -380,11 +380,6 @@ export interface components { /** Err Msg */ err_msg: string } - /** HTTPValidationError */ - HTTPValidationError: { - /** Detail */ - detail?: components["schemas"]["ValidationError"][] - } /** ImageData */ ImageData: { /** @@ -430,8 +425,6 @@ export interface components { err_code: number /** Err Msg */ err_msg: string - /** Validation Errors */ - validation_errors: components["schemas"]["ValidationErrorModel"][] } /** Organization */ Organization: { @@ -1018,26 +1011,6 @@ export interface components { /** Version String Cmd */ version_string_cmd?: string | null } - /** ValidationError */ - ValidationError: { - /** Location */ - loc: (string | number)[] - /** Message */ - msg: string - /** Error Type */ - type: string - } - /** ValidationErrorModel */ - ValidationErrorModel: { - /** Input */ - input: Record - /** Loc */ - loc: number[] - /** Msg */ - msg: string - /** Type */ - type: string - } /** Version */ Version: { /** @@ -1073,7 +1046,7 @@ export interface operations { } } /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -1093,7 +1066,7 @@ export interface operations { } } /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -1118,15 +1091,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1150,15 +1117,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1188,15 +1149,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1211,7 +1166,7 @@ export interface operations { } } /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -1228,7 +1183,7 @@ export interface operations { } } /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -1245,7 +1200,7 @@ export interface operations { } } /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -1268,15 +1223,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1297,15 +1246,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1335,15 +1278,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1366,15 +1303,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1399,15 +1330,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1435,15 +1360,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1471,15 +1390,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1497,7 +1410,7 @@ export interface operations { } } /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -1522,15 +1435,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1551,15 +1458,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1580,15 +1481,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1611,15 +1506,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1642,15 +1531,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1683,15 +1566,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1708,15 +1585,9 @@ export interface operations { /** @description Successful Response */ 204: never /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1733,15 +1604,9 @@ export interface operations { /** @description Successful Response */ 204: never /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1769,15 +1634,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1798,15 +1657,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1830,15 +1683,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1857,15 +1704,9 @@ export interface operations { /** @description Successful Response */ 204: never /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1884,15 +1725,9 @@ export interface operations { /** @description Successful Response */ 204: never /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1918,15 +1753,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1948,15 +1777,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -1975,7 +1798,7 @@ export interface operations { } } /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -1995,7 +1818,7 @@ export interface operations { } } /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -2020,15 +1843,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -2046,7 +1863,7 @@ export interface operations { } } /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -2072,15 +1889,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -2101,15 +1912,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -2130,15 +1935,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -2155,15 +1954,9 @@ export interface operations { /** @description Successful Response */ 204: never /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -2178,7 +1971,7 @@ export interface operations { } } /** @description Bad Request */ - 400: { + 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -2199,15 +1992,9 @@ export interface operations { /** @description Successful Response */ 204: never /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -2230,15 +2017,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -2261,15 +2042,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -2292,15 +2067,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } @@ -2328,15 +2097,9 @@ export interface operations { } } /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation Error */ 422: { content: { - "application/json": components["schemas"]["HTTPValidationError"] + "application/json": components["schemas"]["MessageExceptionModel"] } } } From 94db945fd7bf1dd6be4aae4cdb862a92903aa334 Mon Sep 17 00:00:00 2001 From: Arash Date: Sat, 29 Jun 2024 16:38:36 +0200 Subject: [PATCH 10/17] Add all errors --- client/src/api/schema/schema.ts | 30178 +++++++++++++--- lib/galaxy/webapps/base/api.py | 27 +- .../webapp/frontend/src/schema/schema.ts | 3440 +- 3 files changed, 27523 insertions(+), 6122 deletions(-) diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index 80dceb43cef7..02f1d97ded14 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -13073,12 +13073,66 @@ export interface operations { "application/json": components["schemas"]["APIKeyResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_api_cloud_storage_get_post: { @@ -13104,12 +13158,66 @@ export interface operations { "application/json": components["schemas"]["DatasetSummaryList"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; send_api_cloud_storage_send_post: { @@ -13135,12 +13243,66 @@ export interface operations { "application/json": components["schemas"]["CloudDatasetsResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; index_api_configuration_get: { @@ -13173,12 +13335,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; decode_id_api_configuration_decode__encoded_id__get: { @@ -13205,12 +13421,66 @@ export interface operations { }; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; dynamic_tool_confs_api_configuration_dynamic_tool_confs_get: { @@ -13234,12 +13504,66 @@ export interface operations { }[]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; encode_id_api_configuration_encode__decoded_id__get: { @@ -13266,43 +13590,151 @@ export interface operations { }; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - tool_lineages_api_configuration_tool_lineages_get: { - /** - * Return tool lineages for tools that have them - * @description Return tool lineages for tools that have them. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Tool lineages for tools that have them */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": { - [key: string]: Record; - }[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + tool_lineages_api_configuration_tool_lineages_get: { + /** + * Return tool lineages for tools that have them + * @description Return tool lineages for tools that have them. + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Tool lineages for tools that have them */ + 200: { + content: { + "application/json": { + [key: string]: Record; + }[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; reload_toolbox_api_configuration_toolbox_put: { /** * Reload the Galaxy toolbox (but not individual tools) @@ -13322,12 +13754,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; content_api_dataset_collection_element__dce_id__get: { @@ -13349,12 +13835,66 @@ export interface operations { "application/json": components["schemas"]["DCESummary"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; create_api_dataset_collections_post: { @@ -13378,12 +13918,66 @@ export interface operations { "application/json": components["schemas"]["HDCADetailed"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; contents_dataset_collection_api_dataset_collections__hdca_id__contents__parent_id__get: { @@ -13415,12 +14009,66 @@ export interface operations { "application/json": components["schemas"]["DatasetCollectionContentElements"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_api_dataset_collections__id__get: { @@ -13448,20 +14096,74 @@ export interface operations { "application/json": components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - attributes_api_dataset_collections__id__attributes_get: { - /** Returns `dbkey`/`extension` attributes for all the collection elements. */ - parameters: { - query?: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ - instance_type?: "history" | "library"; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + attributes_api_dataset_collections__id__attributes_get: { + /** Returns `dbkey`/`extension` attributes for all the collection elements. */ + parameters: { + query?: { + /** @description The type of collection instance. Either `history` (default) or `library`. */ + instance_type?: "history" | "library"; }; header?: { /** @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. */ @@ -13479,12 +14181,66 @@ export interface operations { "application/json": components["schemas"]["DatasetCollectionAttributesResult"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; copy_api_dataset_collections__id__copy_post: { @@ -13511,12 +14267,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; dataset_collections__download: { @@ -13538,12 +14348,66 @@ export interface operations { responses: { /** @description Successful Response */ 200: never; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; prepare_collection_download_api_dataset_collections__id__prepare_download_post: { @@ -13570,12 +14434,60 @@ export interface operations { "application/json": components["schemas"]["AsyncFile"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Required asynchronous tasks required for this operation not available. */ 501: { content: never; @@ -13605,12 +14517,66 @@ export interface operations { "application/json": components["schemas"]["SuitableConverters"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; index_api_datasets_get: { @@ -13660,33 +14626,87 @@ export interface operations { )[]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_batch_api_datasets_delete: { - /** - * Deletes or purges a batch of datasets. - * @description Deletes or purges a batch of datasets. - * **Warning**: only the ownership of the datasets (and upload state for HDAs) is checked, - * no other checks or restrictions are made. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["DeleteDatasetBatchPayload"]; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_batch_api_datasets_delete: { + /** + * Deletes or purges a batch of datasets. + * @description Deletes or purges a batch of datasets. + * **Warning**: only the ownership of the datasets (and upload state for HDAs) is checked, + * no other checks or restrictions are made. + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["DeleteDatasetBatchPayload"]; + }; + }; responses: { /** @description Successful Response */ 200: { @@ -13694,12 +14714,66 @@ export interface operations { "application/json": components["schemas"]["DeleteDatasetBatchResult"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_api_datasets__dataset_id__get: { @@ -13736,12 +14810,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; datasets__update_dataset: { @@ -13782,12 +14910,66 @@ export interface operations { | components["schemas"]["HDCASummary"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; datasets__delete: { @@ -13846,12 +15028,60 @@ export interface operations { "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description Bad Request */ + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_structured_content_api_datasets__dataset_id__content__content_type__get: { @@ -13874,12 +15104,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; converted_api_datasets__dataset_id__converted_get: { @@ -13904,26 +15188,80 @@ export interface operations { "application/json": components["schemas"]["ConvertedDatasetsMap"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - converted_ext_api_datasets__dataset_id__converted__ext__get: { - /** - * Return information about datasets made by converting this dataset to a new format. - * @description Return information about datasets made by converting this dataset to a new format. - * - * If there is no existing converted dataset for the format in `ext`, one will be created. - * - * **Note**: `view` and `keys` are also available to control the serialization of the dataset. - */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + converted_ext_api_datasets__dataset_id__converted__ext__get: { + /** + * Return information about datasets made by converting this dataset to a new format. + * @description Return information about datasets made by converting this dataset to a new format. + * + * If there is no existing converted dataset for the format in `ext`, one will be created. + * + * **Note**: `view` and `keys` are also available to control the serialization of the dataset. + */ + parameters: { + query?: { + /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ keys?: string | null; @@ -13949,12 +15287,66 @@ export interface operations { | components["schemas"]["HDASummary"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; extra_files_api_datasets__dataset_id__extra_files_get: { @@ -13976,12 +15368,66 @@ export interface operations { "application/json": components["schemas"]["DatasetExtraFiles"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_content_as_text_api_datasets__dataset_id__get_content_as_text_get: { @@ -14003,12 +15449,66 @@ export interface operations { "application/json": components["schemas"]["DatasetTextContentDetails"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; compute_hash_api_datasets__dataset_id__hash_put: { @@ -14039,12 +15539,66 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_inheritance_chain_api_datasets__dataset_id__inheritance_chain_get: { @@ -14070,12 +15624,66 @@ export interface operations { "application/json": components["schemas"]["DatasetInheritanceChain"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_metrics_api_datasets__dataset_id__metrics_get: { @@ -14104,22 +15712,76 @@ export interface operations { "application/json": (components["schemas"]["JobMetric"] | null)[]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - datasets__update_object_store_id: { - /** Update an object store ID for a dataset you own. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + datasets__update_object_store_id: { + /** Update an object store ID for a dataset you own. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { /** @description The ID of the History Dataset. */ dataset_id: string; }; @@ -14136,12 +15798,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; resolve_parameters_display_api_datasets__dataset_id__parameters_display_get: { @@ -14173,12 +15889,66 @@ export interface operations { "application/json": components["schemas"]["JobDisplayParametersSummary"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; update_permissions_api_datasets__dataset_id__permissions_put: { @@ -14208,12 +15978,66 @@ export interface operations { "application/json": components["schemas"]["DatasetAssociationRoles"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_storage_api_datasets__dataset_id__storage_get: { @@ -14239,12 +16063,66 @@ export interface operations { "application/json": components["schemas"]["DatasetStorageDetails"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; display_api_datasets__history_content_id__display_get: { @@ -14279,12 +16157,66 @@ export interface operations { responses: { /** @description Successful Response */ 200: never; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; display_api_datasets__history_content_id__display_head: { @@ -14323,43 +16255,70 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - datasets__get_metadata_file: { - /** Returns the metadata file associated with this history item. */ - parameters: { - query: { - /** @description The name of the metadata file to retrieve. */ - metadata_file: string; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Bad Request */ + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - get_metadata_file_datasets_api_datasets__history_content_id__metadata_file_head: { - /** Check if metadata file can be downloaded. */ + datasets__get_metadata_file: { + /** Returns the metadata file associated with this history item. */ parameters: { query: { /** @description The name of the metadata file to retrieve. */ @@ -14376,201 +16335,158 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: { + 200: never; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_datatypes_get: { - /** - * Lists all available data types - * @description Gets the list of all available data types. - */ - parameters?: { - /** @description Whether to return only the datatype's extension rather than the datatype's details */ - /** @description Whether to return only datatypes which can be uploaded */ - query?: { - /** @description Whether to return only the datatype's extension rather than the datatype's details */ - extension_only?: boolean | null; - /** @description Whether to return only datatypes which can be uploaded */ - upload_only?: boolean | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description List of data types */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["DatatypeDetails"][] | string[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - converters_api_datatypes_converters_get: { - /** - * Returns the list of all installed converters - * @description Gets the list of all installed converters. - */ - responses: { - /** @description List of all datatype converters */ - 200: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { - "application/json": components["schemas"]["DatatypeConverterList"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - edam_data_api_datatypes_edam_data_get: { - /** - * Returns a dictionary/map of datatypes and EDAM data - * @description Gets a map of datatypes and their corresponding EDAM data. - */ - responses: { - /** @description Dictionary/map of datatypes and EDAM data */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": { - [key: string]: string; - }; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - edam_data_detailed_api_datatypes_edam_data_detailed_get: { - /** - * Returns a dictionary of datatypes and EDAM data details - * @description Gets a map of datatypes and their corresponding EDAM data. - * EDAM data contains the EDAM iri, label, and definition. - */ + get_metadata_file_datasets_api_datasets__history_content_id__metadata_file_head: { + /** Check if metadata file can be downloaded. */ + parameters: { + query: { + /** @description The name of the metadata file to retrieve. */ + metadata_file: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; + }; + }; responses: { - /** @description Dictionary of EDAM data details containing the EDAM iri, label, and definition */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; + "application/json": Record; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - edam_formats_api_datatypes_edam_formats_get: { - /** - * Returns a dictionary/map of datatypes and EDAM formats - * @description Gets a map of datatypes and their corresponding EDAM formats. - */ - responses: { - /** @description Dictionary/map of datatypes and EDAM formats */ - 200: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": { - [key: string]: string; - }; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - edam_formats_detailed_api_datatypes_edam_formats_detailed_get: { - /** - * Returns a dictionary of datatypes and EDAM format details - * @description Gets a map of datatypes and their corresponding EDAM formats. - * EDAM formats contain the EDAM iri, label, and definition. - */ - responses: { - /** @description Dictionary of EDAM format details containing the EDAM iri, label, and definition */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - mapping_api_datatypes_mapping_get: { - /** - * Returns mappings for data types and their implementing classes - * @description Gets mappings for data types. - */ - responses: { - /** @description Dictionary to map data types with their classes */ - 200: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { - "application/json": components["schemas"]["DatatypesMap"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - sniffers_api_datatypes_sniffers_get: { - /** - * Returns the list of all installed sniffers - * @description Gets the list of all installed data type sniffers. - */ - responses: { - /** @description List of datatype sniffers */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": string[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - types_and_mapping_api_datatypes_types_and_mapping_get: { + index_api_datatypes_get: { /** - * Returns all the data types extensions and their mappings - * @description Combines the datatype information from (/api/datatypes) and the - * mapping information from (/api/datatypes/mapping) into a single - * response. + * Lists all available data types + * @description Gets the list of all available data types. */ parameters?: { /** @description Whether to return only the datatype's extension rather than the datatype's details */ @@ -14583,510 +16499,14809 @@ export interface operations { }; }; responses: { - /** @description Dictionary to map data types with their classes */ + /** @description List of data types */ 200: { content: { - "application/json": components["schemas"]["DatatypesCombinedMap"]; + "application/json": components["schemas"]["DatatypeDetails"][] | string[]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - display_applications_index_api_display_applications_get: { - /** - * Returns the list of display applications. - * @description Returns the list of display applications. - */ - responses: { - /** @description Successful Response */ - 200: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": components["schemas"]["DisplayApplication"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - display_applications_reload_api_display_applications_reload_post: { - /** - * Reloads the list of display applications. - * @description Reloads the list of display applications. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody?: { - content: { - "application/json": { - [key: string]: string[]; - } | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["ReloadFeedback"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - download_api_drs_download__object_id__get: { - /** Download */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group */ - object_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Bad Request */ - 422: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_folders__folder_id__contents_get: { - /** - * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. - * @description Returns a list of a folder's contents (files and sub-folders). - * - * Additional metadata for the folder is provided in the response as a separate object containing data - * for breadcrumb path building, permissions and other folder's details. - * - * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). - * - * **Security note**: - * - Accessing a library folder or sub-folder requires only access to the parent library. - * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. - * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. - */ - parameters: { - query?: { - /** @description Maximum number of contents to return. */ - limit?: number; - /** @description Return contents from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, contents between position 200-299 will be returned. */ - offset?: number; - /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ - search_text?: string | null; - /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ - include_deleted?: boolean | null; - /** @description Sort results by specified field. */ - order_by?: "name" | "description" | "type" | "size" | "update_time"; - /** @description Sort results in descending order. */ - sort_desc?: boolean | null; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded identifier of the library folder. */ - folder_id: string; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; }; + }; + converters_api_datatypes_converters_get: { + /** + * Returns the list of all installed converters + * @description Gets the list of all installed converters. + */ responses: { - /** @description The contents of the folder that match the query parameters. */ + /** @description List of all datatype converters */ 200: { content: { - "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; + "application/json": components["schemas"]["DatatypeConverterList"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - add_history_datasets_to_library_api_folders__folder_id__contents_post: { - /** Creates a new library file from an existing HDA/HDCA. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded identifier of the library folder. */ - folder_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibraryFilePayload"]; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_api_folders__id__get: { - /** - * Displays information about a particular library folder. - * @description Returns detailed information about the library folder with the given ID. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_api_folders__id__put: { + edam_data_api_datatypes_edam_data_get: { /** - * Updates the information of an existing library folder. - * @description Updates the information of an existing library folder. + * Returns a dictionary/map of datatypes and EDAM data + * @description Gets a map of datatypes and their corresponding EDAM data. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; - }; - }; responses: { - /** @description Successful Response */ + /** @description Dictionary/map of datatypes and EDAM data */ 200: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": { + [key: string]: string; + }; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - create_api_folders__id__post: { - /** - * Create a new library folder underneath the one specified by the ID. - * @description Returns detailed information about the newly created library folder. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibraryFolderPayload"]; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_folders__id__delete: { - /** - * Marks the specified library folder as deleted (or undeleted). - * @description Marks the specified library folder as deleted (or undeleted). - */ - parameters: { - query?: { - /** @description Whether to restore a deleted library folder. */ - undelete?: boolean | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_api_folders__id__patch: { + edam_data_detailed_api_datatypes_edam_data_detailed_get: { /** - * Update - * @description Updates the information of an existing library folder. + * Returns a dictionary of datatypes and EDAM data details + * @description Gets a map of datatypes and their corresponding EDAM data. + * EDAM data contains the EDAM iri, label, and definition. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + responses: { + /** @description Dictionary of EDAM data details containing the EDAM iri, label, and definition */ + 200: { + content: { + "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; + }; }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + edam_formats_api_datatypes_edam_formats_get: { + /** + * Returns a dictionary/map of datatypes and EDAM formats + * @description Gets a map of datatypes and their corresponding EDAM formats. + */ + responses: { + /** @description Dictionary/map of datatypes and EDAM formats */ + 200: { + content: { + "application/json": { + [key: string]: string; + }; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + edam_formats_detailed_api_datatypes_edam_formats_detailed_get: { + /** + * Returns a dictionary of datatypes and EDAM format details + * @description Gets a map of datatypes and their corresponding EDAM formats. + * EDAM formats contain the EDAM iri, label, and definition. + */ + responses: { + /** @description Dictionary of EDAM format details containing the EDAM iri, label, and definition */ + 200: { + content: { + "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + mapping_api_datatypes_mapping_get: { + /** + * Returns mappings for data types and their implementing classes + * @description Gets mappings for data types. + */ + responses: { + /** @description Dictionary to map data types with their classes */ + 200: { + content: { + "application/json": components["schemas"]["DatatypesMap"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + sniffers_api_datatypes_sniffers_get: { + /** + * Returns the list of all installed sniffers + * @description Gets the list of all installed data type sniffers. + */ + responses: { + /** @description List of datatype sniffers */ + 200: { + content: { + "application/json": string[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + types_and_mapping_api_datatypes_types_and_mapping_get: { + /** + * Returns all the data types extensions and their mappings + * @description Combines the datatype information from (/api/datatypes) and the + * mapping information from (/api/datatypes/mapping) into a single + * response. + */ + parameters?: { + /** @description Whether to return only the datatype's extension rather than the datatype's details */ + /** @description Whether to return only datatypes which can be uploaded */ + query?: { + /** @description Whether to return only the datatype's extension rather than the datatype's details */ + extension_only?: boolean | null; + /** @description Whether to return only datatypes which can be uploaded */ + upload_only?: boolean | null; + }; + }; + responses: { + /** @description Dictionary to map data types with their classes */ + 200: { + content: { + "application/json": components["schemas"]["DatatypesCombinedMap"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + display_applications_index_api_display_applications_get: { + /** + * Returns the list of display applications. + * @description Returns the list of display applications. + */ + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["DisplayApplication"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + display_applications_reload_api_display_applications_reload_post: { + /** + * Reloads the list of display applications. + * @description Reloads the list of display applications. + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody?: { + content: { + "application/json": { + [key: string]: string[]; + } | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ReloadFeedback"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + download_api_drs_download__object_id__get: { + /** Download */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group */ + object_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: never; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_folders__folder_id__contents_get: { + /** + * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. + * @description Returns a list of a folder's contents (files and sub-folders). + * + * Additional metadata for the folder is provided in the response as a separate object containing data + * for breadcrumb path building, permissions and other folder's details. + * + * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). + * + * **Security note**: + * - Accessing a library folder or sub-folder requires only access to the parent library. + * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. + * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. + */ + parameters: { + query?: { + /** @description Maximum number of contents to return. */ + limit?: number; + /** @description Return contents from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, contents between position 200-299 will be returned. */ + offset?: number; + /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ + search_text?: string | null; + /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ + include_deleted?: boolean | null; + /** @description Sort results by specified field. */ + order_by?: "name" | "description" | "type" | "size" | "update_time"; + /** @description Sort results in descending order. */ + sort_desc?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + folder_id: string; + }; + }; + responses: { + /** @description The contents of the folder that match the query parameters. */ + 200: { + content: { + "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + add_history_datasets_to_library_api_folders__folder_id__contents_post: { + /** Creates a new library file from an existing HDA/HDCA. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + folder_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryFilePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_api_folders__id__get: { + /** + * Displays information about a particular library folder. + * @description Returns detailed information about the library folder with the given ID. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibraryFolderDetails"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_api_folders__id__put: { + /** + * Updates the information of an existing library folder. + * @description Updates the information of an existing library folder. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibraryFolderDetails"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_api_folders__id__post: { + /** + * Create a new library folder underneath the one specified by the ID. + * @description Returns detailed information about the newly created library folder. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryFolderPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibraryFolderDetails"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_api_folders__id__delete: { + /** + * Marks the specified library folder as deleted (or undeleted). + * @description Marks the specified library folder as deleted (or undeleted). + */ + parameters: { + query?: { + /** @description Whether to restore a deleted library folder. */ + undelete?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibraryFolderDetails"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_api_folders__id__patch: { + /** + * Update + * @description Updates the information of an existing library folder. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibraryFolderDetails"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; get_permissions_api_folders__id__permissions_get: { /** - * Gets the current or available permissions of a particular library folder. - * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. + * Gets the current or available permissions of a particular library folder. + * @description Gets the current or available permissions of a particular library. + * The results can be paginated and additionally filtered by a query. + */ + parameters: { + query?: { + /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ + scope?: components["schemas"]["LibraryPermissionScope"] | null; + /** @description The page number to retrieve when paginating the available roles. */ + page?: number; + /** @description The maximum number of permissions per page when paginating. */ + page_limit?: number; + /** @description Optional search text to retrieve only the roles matching this query. */ + q?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["LibraryFolderCurrentPermissions"] + | components["schemas"]["LibraryAvailablePermissions"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + set_permissions_api_folders__id__permissions_post: { + /** + * Sets the permissions to manage a library folder. + * @description Sets the permissions to manage a library folder. + */ + parameters: { + query?: { + /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ + action?: components["schemas"]["LibraryFolderPermissionAction"] | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["LibraryFolderPermissionsPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibraryFolderCurrentPermissions"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_api_forms__id__delete: { + /** Delete */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + undelete_api_forms__id__undelete_post: { + /** Undelete */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_ftp_files_get: { + /** + * Displays remote files available to the user. Please use /api/remote_files instead. + * @deprecated + * @description Lists all remote files available to the user from different sources. + */ + parameters?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + query?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + target?: string; + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + format?: components["schemas"]["RemoteFilesFormat"] | null; + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + recursive?: boolean | null; + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + disable?: components["schemas"]["RemoteFilesDisableMode"] | null; + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + writeable?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["ListUriResponse"] + | components["schemas"]["ListJstreeResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_genomes_get: { + /** Return a list of installed genomes */ + parameters?: { + /** @description If true, return genome keys with chromosome lengths */ + query?: { + /** @description If true, return genome keys with chromosome lengths */ + chrom_info?: boolean; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Installed genomes */ + 200: { + content: { + "application/json": string[][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_api_genomes__id__get: { + /** Return information about build */ + parameters: { + query?: { + /** @description If true, return reference data */ + reference?: boolean; + /** @description Limits size of returned data */ + num?: number; + /** @description Limits size of returned data */ + chrom?: string; + /** @description Limits size of returned data */ + low?: number; + /** @description Limits size of returned data */ + high?: number; + /** @description Format */ + format?: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description Genome ID */ + id: string; + }; + }; + responses: { + /** @description Information about genome build */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + indexes_api_genomes__id__indexes_get: { + /** Return all available indexes for a genome id for provided type */ + parameters: { + query?: { + /** @description Index type */ + type?: string; + /** @description Format */ + format?: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description Genome ID */ + id: string; + }; + }; + responses: { + /** @description Indexes for a genome id for provided type */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + sequences_api_genomes__id__sequences_get: { + /** Return raw sequence data */ + parameters: { + query?: { + /** @description If true, return reference data */ + reference?: boolean; + /** @description Limits size of returned data */ + chrom?: string; + /** @description Limits size of returned data */ + low?: number; + /** @description Limits size of returned data */ + high?: number; + /** @description Format */ + format?: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description Genome ID */ + id: string; + }; + }; + responses: { + /** @description Raw sequence data */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_groups_get: { + /** Displays a collection (list) of groups. */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupListResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_api_groups_post: { + /** Creates a new group. */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["GroupCreatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupListResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_group_api_groups__group_id__get: { + /** Displays information about a group. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + group_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_api_groups__group_id__put: { + /** Modifies a group. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + group_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["GroupCreatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_api_groups__group_id__delete: { + /** Delete */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + group_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + purge_api_groups__group_id__purge_post: { + /** Purge */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + group_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + group_roles_api_groups__group_id__roles_get: { + /** Displays a collection (list) of groups. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupRoleListResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + group_role_api_groups__group_id__roles__role_id__get: { + /** Displays information about a group role. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the role. */ + role_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupRoleResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_api_groups__group_id__roles__role_id__put: { + /** Adds a role to a group */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the role. */ + role_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupRoleResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_api_groups__group_id__roles__role_id__delete: { + /** Removes a role from a group */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the role. */ + role_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupRoleResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + undelete_api_groups__group_id__undelete_post: { + /** Undelete */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + group_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + group_user_api_groups__group_id__user__user_id__get: { + /** + * Displays information about a group user. + * @description Displays information about a group user. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupUserResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_api_groups__group_id__user__user_id__put: { + /** + * Adds a user to a group + * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Adds a user to a group + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupUserResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_api_groups__group_id__user__user_id__delete: { + /** + * Removes a user from a group + * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Removes a user from a group + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupUserResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + group_users_api_groups__group_id__users_get: { + /** + * Displays a collection (list) of groups. + * @description GET /api/groups/{encoded_group_id}/users + * Displays a collection (list) of groups. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupUserListResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + group_user_api_groups__group_id__users__user_id__get: { + /** + * Displays information about a group user. + * @description Displays information about a group user. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupUserResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_api_groups__group_id__users__user_id__put: { + /** + * Adds a user to a group + * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Adds a user to a group + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupUserResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_api_groups__group_id__users__user_id__delete: { + /** + * Removes a user from a group + * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Removes a user from a group + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupUserResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + search_forum_api_help_forum_search_get: { + /** + * Search the Galaxy Help forum. + * @description Search the Galaxy Help forum using the Discourse API. + * + * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. + */ + parameters: { + query: { + /** @description Search query to use for searching the Galaxy Help forum. */ + query: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["HelpForumSearchResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_histories_get: { + /** Returns histories available to the current user. */ + parameters?: { + /** @description The maximum number of items to return. */ + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + /** @description Whether to include archived histories. */ + /** @description Sort index by this specified attribute */ + /** @description Sort in descending order? */ + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `name` + * : The history's name. + * + * `annotation` + * : The history's annotation. (The tag `a` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The history's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Historys: `title`, `description`, `slug`, `tag`. + */ + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + /** + * @deprecated + * @description Whether to return only deleted items. + */ + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { + limit?: number | null; + offset?: number | null; + show_own?: boolean; + show_published?: boolean; + show_shared?: boolean; + show_archived?: boolean | null; + sort_by?: "create_time" | "name" | "update_time" | "username"; + sort_desc?: boolean; + search?: string | null; + all?: boolean | null; + deleted?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_api_histories_post: { + /** + * Creates a new history. + * @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?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": components["schemas"]["Body_create_api_histories_post"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["JobImportHistoryResponse"] + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_archived_histories_api_histories_archived_get: { + /** + * Get a list of all archived histories for the current user. + * @description Get a list of all archived histories for the current user. + * + * 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. */ + /** @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. */ + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["ArchivedHistorySummary"] + | components["schemas"]["ArchivedHistoryDetailed"] + | Record + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + batch_delete_api_histories_batch_delete_put: { + /** Marks several histories with the given IDs 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; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["DeleteHistoriesPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + batch_undelete_api_histories_batch_undelete_put: { + /** Marks several histories with the given IDs as undeleted. */ + parameters?: { + /** @description View to be passed to the serializer */ + /** @description Comma-separated list of keys to be passed to the serializer */ + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UndeleteHistoriesPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + count_api_histories_count_get: { + /** Returns number of histories for the current user. */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": number; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_deleted_api_histories_deleted_get: { + /** Returns deleted histories for the current user. */ + parameters?: { + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + all?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + undelete_api_histories_deleted__history_id__undelete_post: { + /** Restores a deleted history with the given ID (that hasn't been purged). */ + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + 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?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryFromStore"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_from_store_async_api_histories_from_store_async_post: { + /** Launch a task to create histories from a model store. */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryFromStore"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + 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?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + published_api_histories_published_get: { + /** Return all histories that are published. */ + parameters?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + shared_with_me_api_histories_shared_with_me_get: { + /** Return all histories that are shared with the current user. */ + parameters?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_api_histories__history_id__get: { + /** Returns the history with the given ID. */ + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_api_histories__history_id__put: { + /** Updates the values for the history with the given ID. */ + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": unknown; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_api_histories__history_id__delete: { + /** Marks the history with the given ID as deleted. */ + parameters: { + query?: { + purge?: boolean; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryPayload"] | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + archive_history_api_histories__history_id__archive_post: { + /** + * Archive a history. + * @description Marks the given history as 'archived' and returns the history. + * + * Archiving a history will remove it from the list of active histories of the user but it will still be + * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. + * + * Associating an export record: + * + * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the + * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and + * must be in the ready state. + * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. + * + * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. + * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ArchiveHistoryRequestPayload"] | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["ArchivedHistorySummary"] + | components["schemas"]["ArchivedHistoryDetailed"] + | Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + restore_archived_history_api_histories__history_id__archive_restore_put: { + /** + * Restore an archived history. + * @description Restores an archived history and returns it. + * + * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). + * + * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them + * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export + * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. + */ + parameters: { + query?: { + /** @description If true, the history will be un-archived even if it has an associated archive export record and was purged. */ + force?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + citations_api_histories__history_id__citations_get: { + /** Return all the citations for the tools used to produce the datasets in the history. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__index: { + /** + * Returns the contents of the given history. + * @description Return a list of `HDA`/`HDCA` data for the history with the given ``ID``. + * + * - The contents can be filtered and queried using the appropriate parameters. + * - The amount of information returned for each item can be customized. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ + parameters: { + query?: { + /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ + v?: string | null; + /** + * @deprecated + * @description Legacy name for the `dataset_details` parameter. + */ + details?: string | null; + /** + * @deprecated + * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. + */ + ids?: string | null; + /** + * @deprecated + * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. + */ + types?: string[] | null; + /** + * @deprecated + * @description Whether to return deleted or undeleted datasets only. Leave unset for both. + */ + deleted?: boolean | null; + /** + * @deprecated + * @description Whether to return visible or hidden datasets only. Leave unset for both. + */ + visible?: boolean | null; + /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ + shareable?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description The contents of the history that match the query. */ + 200: { + content: { + "application/json": components["schemas"]["HistoryContentsResult"]; + "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_batch_api_histories__history_id__contents_put: { + /** + * Batch update specific properties of a set items contained in the given History. + * @description Batch update specific properties of a set items contained in the given History. + * + * If you provide an invalid/unknown property key the request will not fail, but no changes + * will be made to the items. + */ + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryContentsBatchPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["HistoryContentsResult"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__create: { + /** + * Create a new `HDA` or `HDCA` in the given History. + * @deprecated + * @description Create a new `HDA` or `HDCA` in the given History. + */ + parameters: { + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"] | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryContentPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + | ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__archive: { + /** + * Build and return a compressed archive of the selected history contents. + * @description Build and return a compressed archive of the selected history contents. + * + * **Note**: this is a volatile endpoint and settings and behavior may change. + */ + parameters: { + query?: { + /** @description The name that the Archive will have (defaults to history name). */ + filename?: string | null; + /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ + dry_run?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__archive_named: { + /** + * Build and return a compressed archive of the selected history contents. + * @description Build and return a compressed archive of the selected history contents. + * + * **Note**: this is a volatile endpoint and settings and behavior may change. + */ + parameters: { + query?: { + /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ + dry_run?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The name that the Archive will have (defaults to history name). */ + filename: string; + /** + * @deprecated + * @description Output format of the archive. + */ + format: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + bulk_operation_api_histories__history_id__contents_bulk_put: { + /** + * Executes an operation on a set of items contained in the given History. + * @description Executes an operation on a set of items contained in the given History. + * + * The items to be processed can be explicitly set or determined by a dynamic query. + */ + parameters: { + query?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["HistoryContentBulkOperationPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["HistoryContentBulkOperationResult"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__download_collection: { + /** + * Download the content of a dataset collection as a `zip` archive. + * @description Download the content of a history dataset collection as a `zip` archive + * while maintaining approximate collection structure. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; + /** @description The encoded database identifier of the History. */ + history_id: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: never; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + materialize_dataset_api_histories__history_id__contents_datasets__id__materialize_post: { + /** Materialize a deferred dataset into real, usable dataset. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_permissions_api_histories__history_id__contents__dataset_id__permissions_put: { + /** + * Set permissions of the given history dataset to the given role ids. + * @description Set permissions of the given history dataset to the given role ids. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + dataset_id: string; + }; + }; + requestBody: { + content: { + "application/json": Record; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["DatasetAssociationRoles"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents_display_api_histories__history_id__contents__history_content_id__display_get: { + /** + * Displays (preview) or downloads dataset content. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. + */ + parameters: { + query?: { + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ + offset?: number | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; + history_id: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: never; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents_display_api_histories__history_id__contents__history_content_id__display_head: { + /** + * Check if dataset content can be previewed or downloaded. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. + */ + parameters: { + query?: { + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ + offset?: number | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; + history_id: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + extra_files_history_api_histories__history_id__contents__history_content_id__extra_files_get: { + /** Get the list of extra files/directories associated with a dataset. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["DatasetExtraFiles"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__get_metadata_file: { + /** Returns the metadata file associated with this history item. */ + parameters: { + query: { + /** @description The name of the metadata file to retrieve. */ + metadata_file: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: never; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_histories__history_id__contents__history_content_id__tags_get: { + /** Show tags based on history_content_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_content_id: string; + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ItemTagsListResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_api_histories__history_id__contents__history_content_id__tags__tag_name__get: { + /** Show tag based on history_content_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_content_id: string; + tag_name: string; + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ItemTagsResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_api_histories__history_id__contents__history_content_id__tags__tag_name__put: { + /** Update tag based on history_content_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_content_id: string; + tag_name: string; + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ItemTagsResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_api_histories__history_id__contents__history_content_id__tags__tag_name__post: { + /** Create tag based on history_content_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_content_id: string; + tag_name: string; + history_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ItemTagsResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_api_histories__history_id__contents__history_content_id__tags__tag_name__delete: { + /** Delete tag based on history_content_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_content_id: string; + tag_name: string; + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": boolean; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__show_legacy: { + /** + * Return detailed information about an HDA within a history. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. + * @deprecated + * @description Return detailed information about an `HDA` or `HDCA` within a history. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ + parameters: { + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; + /** @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. */ + fuzzy_count?: number | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__update_legacy: { + /** + * Updates the values for the history content item with the given ``ID`` and query specified type. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. + * @deprecated + * @description Updates the values for the history content item with the given ``ID``. + */ + parameters: { + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__delete_legacy: { + /** + * Delete the history dataset with the given ``ID``. + * @description Delete the history content with the given ``ID`` and query specified type (defaults to dataset). + * + * **Note**: Currently does not stop any active jobs for which this dataset is an output. + */ + parameters: { + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; + /** + * @deprecated + * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. + */ + purge?: boolean | null; + /** + * @deprecated + * @description When deleting a dataset collection, whether to also delete containing datasets. + */ + recursive?: boolean | null; + /** + * @deprecated + * @description Whether to stop the creating job if all outputs of the job have been deleted. + */ + stop_job?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentPayload"]; + }; + }; + responses: { + /** @description Request has been executed. */ + 200: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentResult"]; + }; + }; + /** @description Request accepted, processing will finish later. */ + 202: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentResult"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + validate_api_histories__history_id__contents__id__validate_put: { + /** + * Validates the metadata associated with a dataset within a History. + * @description Validates the metadata associated with a dataset within a History. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__index_typed: { + /** + * Returns the contents of the given history filtered by type. + * @description Return a list of either `HDA`/`HDCA` data for the history with the given ``ID``. + * + * - The contents can be filtered and queried using the appropriate parameters. + * - The amount of information returned for each item can be customized. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ + parameters: { + query?: { + /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ + v?: string | null; + /** + * @deprecated + * @description Legacy name for the `dataset_details` parameter. + */ + details?: string | null; + /** + * @deprecated + * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. + */ + ids?: string | null; + /** + * @deprecated + * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. + */ + types?: string[] | null; + /** + * @deprecated + * @description Whether to return deleted or undeleted datasets only. Leave unset for both. + */ + deleted?: boolean | null; + /** + * @deprecated + * @description Whether to return visible or hidden datasets only. Leave unset for both. + */ + visible?: boolean | null; + /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ + shareable?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["HistoryContentsResult"] + | components["schemas"]["HistoryContentsWithStatsResult"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__create_typed: { + /** + * Create a new `HDA` or `HDCA` in the given History. + * @description Create a new `HDA` or `HDCA` in the given History. + */ + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryContentPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + | ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__show: { + /** + * Return detailed information about a specific HDA or HDCA with the given `ID` within a history. + * @description Return detailed information about an `HDA` or `HDCA` within a history. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ + parameters: { + query?: { + /** @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. */ + fuzzy_count?: number | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__update_typed: { + /** + * Updates the values for the history content item with the given ``ID`` and path specified type. + * @description Updates the values for the history content item with the given ``ID``. + */ + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__delete_typed: { + /** + * Delete the history content with the given ``ID`` and path specified type. + * @description Delete the history content with the given ``ID`` and path specified type. + * + * **Note**: Currently does not stop any active jobs for which this dataset is an output. + */ + parameters: { + query?: { + /** + * @deprecated + * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. + */ + purge?: boolean | null; + /** + * @deprecated + * @description When deleting a dataset collection, whether to also delete containing datasets. + */ + recursive?: boolean | null; + /** + * @deprecated + * @description Whether to stop the creating job if all outputs of the job have been deleted. + */ + stop_job?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentPayload"]; + }; + }; + responses: { + /** @description Request has been executed. */ + 200: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentResult"]; + }; + }; + /** @description Request accepted, processing will finish later. */ + 202: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentResult"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_jobs_summary_api_histories__history_id__contents__type_s__id__jobs_summary_get: { + /** + * Return detailed information about an `HDA` or `HDCAs` jobs. + * @description Return detailed information about an `HDA` or `HDCAs` jobs. + * + * **Warning**: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["JobStateSummary"] + | components["schemas"]["ImplicitCollectionJobsStateSummary"] + | components["schemas"]["WorkflowInvocationStateSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + prepare_store_download_api_histories__history_id__contents__type_s__id__prepare_store_download_post: { + /** Prepare a dataset or dataset collection for export-style download. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["StoreExportPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncFile"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + write_store_api_histories__history_id__contents__type_s__id__write_store_post: { + /** Prepare a dataset or dataset collection for export-style download and write to supplied URI. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["WriteStoreToPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_from_store_api_histories__history_id__contents_from_store_post: { + /** + * Create contents from store. + * @description Create history contents from model store. + * Input can be a tarfile created with build_objects script distributed + * with galaxy-data, from an exported history with files stripped out, + * or hand-crafted JSON dictionary. + */ + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryContentFromStore"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_custom_builds_metadata_api_histories__history_id__custom_builds_metadata_get: { + /** Returns meta data for custom builds. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["CustomBuildsMetadataResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + disable_link_access_api_histories__history_id__disable_link_access_put: { + /** + * Makes this item inaccessible by a URL link. + * @description Makes this item inaccessible by a URL link and return the current sharing status. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["SharingStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + enable_link_access_api_histories__history_id__enable_link_access_put: { + /** + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["SharingStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_history_exports_api_histories__history_id__exports_get: { + /** + * Get previous history exports. + * @description By default the legacy job-based history exports (jeha) are returned. + * + * Change the `accept` content type header to return the new task-based history exports. + */ + parameters: { + query?: { + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description A list of history exports */ + 200: { + content: { + "application/json": components["schemas"]["JobExportHistoryArchiveListResponse"]; + "application/vnd.galaxy.task.export+json": components["schemas"]["ExportTaskListResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + archive_export_api_histories__history_id__exports_put: { + /** + * Start job (if needed) to create history export for corresponding history. + * @deprecated + * @description This will start a job to create a history export archive. + * + * Calling this endpoint multiple times will return the 202 status code until the archive + * has been completely generated and is ready to download. When ready, it will return + * the 200 status code along with the download link information. + * + * If the history will be exported to a `directory_uri`, instead of returning the download + * link information, the Job ID will be returned so it can be queried to determine when + * the file has been written. + * + * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or + * `/api/histories/{id}/write_store` instead. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ExportHistoryArchivePayload"] | null; + }; + }; + responses: { + /** @description Object containing url to fetch export from. */ + 200: { + content: { + "application/json": + | components["schemas"]["JobExportHistoryArchiveModel"] + | components["schemas"]["JobIdResponse"]; + }; + }; + /** @description The exported archive file is not ready yet. */ + 202: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_archive_download_api_histories__history_id__exports__jeha_id__get: { + /** + * If ready and available, return raw contents of exported history as a downloadable archive. + * @deprecated + * @description See ``PUT /api/histories/{id}/exports`` to initiate the creation + * of the history export - when ready, that route will return 200 status + * code (instead of 202) and this route can be used to download the archive. + * + * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or + * `/api/histories/{id}/write_store` instead. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the specific Job Export History Association or `latest` (default) to download the last generated archive. */ + jeha_id: string | "latest"; + }; + }; + responses: { + /** @description The archive file containing the History. */ + 200: never; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_jobs_summary_api_histories__history_id__jobs_summary_get: { + /** + * Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. + * @description Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. + * + * **Warning**: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ + parameters: { + query?: { + /** @description A comma-separated list of encoded ids of job summary objects to return - if `ids` is specified types must also be specified and have same length. */ + ids?: string | null; + /** @description A comma-separated list of type of object represented by elements in the `ids` array - any of `Job`, `ImplicitCollectionJob`, or `WorkflowInvocation`. */ + types?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["JobStateSummary"] + | components["schemas"]["ImplicitCollectionJobsStateSummary"] + | components["schemas"]["WorkflowInvocationStateSummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + materialize_to_history_api_histories__history_id__materialize_post: { + /** Materialize a deferred library or HDA dataset into real, usable dataset in specified history. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["MaterializeDatasetInstanceAPIRequest"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + prepare_store_download_api_histories__history_id__prepare_store_download_post: { + /** Return a short term storage token to monitor download of the history. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["StoreExportPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncFile"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + publish_api_histories__history_id__publish_put: { + /** + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["SharingStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + share_with_users_api_histories__history_id__share_with_users_put: { + /** + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ShareWithPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ShareHistoryWithStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + sharing_api_histories__history_id__sharing_get: { + /** + * Get the current sharing status of the given item. + * @description Return the sharing status of the item. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["SharingStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + set_slug_api_histories__history_id__slug_put: { + /** + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetSlugPayload"]; + }; + }; + responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Successful Response */ + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_histories__history_id__tags_get: { + /** Show tags based on history_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ItemTagsListResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_api_histories__history_id__tags__tag_name__get: { + /** Show tag based on history_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_id: string; + tag_name: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ItemTagsResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_api_histories__history_id__tags__tag_name__put: { + /** Update tag based on history_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_id: string; + tag_name: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ItemTagsResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_api_histories__history_id__tags__tag_name__post: { + /** Create tag based on history_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_id: string; + tag_name: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ItemTagsResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_api_histories__history_id__tags__tag_name__delete: { + /** Delete tag based on history_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_id: string; + tag_name: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": boolean; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + unpublish_api_histories__history_id__unpublish_put: { + /** + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["SharingStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + write_store_api_histories__history_id__write_store_post: { + /** Prepare history for export-style download and write to supplied URI. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["WriteStoreToPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_invocations_api_invocations_get: { + /** Get the list of a user's workflow invocations. */ + 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?: { + /** @description Return only invocations for this Workflow ID */ + workflow_id?: string | null; + /** @description Return only invocations for this History ID */ + history_id?: string | null; + /** @description Return only invocations for this Job ID */ + job_id?: string | null; + /** @description Return invocations for this User ID. */ + user_id?: string | null; + /** @description Sort Workflow Invocations by this attribute */ + sort_by?: components["schemas"]["InvocationSortByEnum"] | null; + /** @description Sort in descending order? */ + sort_desc?: boolean; + /** @description Set to false to only include terminal Invocations. */ + include_terminal?: boolean | null; + /** @description Limit the number of invocations to return. */ + limit?: number | null; + /** @description Number of invocations to skip. */ + offset?: number | null; + /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ + instance?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + include_nested_invocations?: boolean; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_invocations_from_store_api_invocations_from_store_post: { + /** + * Create Invocations From Store + * @description Create invocation(s) from a supplied model store. + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInvocationsFromStorePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + step_api_invocations_steps__step_id__get: { + /** Show details of workflow invocation step. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["InvocationStep"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_invocation_api_invocations__invocation_id__get: { + /** Get detailed description of a workflow invocation. */ + parameters: { + query?: { + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + /** + * @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. + */ + legacy_job_state?: boolean; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["WorkflowInvocationResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + cancel_invocation_api_invocations__invocation_id__delete: { + /** Cancel the specified workflow invocation. */ + parameters: { + query?: { + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + /** + * @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. + */ + legacy_job_state?: boolean; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["WorkflowInvocationResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + invocation_jobs_summary_api_invocations__invocation_id__jobs_summary_get: { + /** + * Get job state summary info aggregated across all current jobs of the workflow invocation. + * @description Warning: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["InvocationJobsResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + prepare_store_download_api_invocations__invocation_id__prepare_store_download_post: { + /** Prepare a workflow invocation export-style download. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["PrepareStoreDownloadPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncFile"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_invocation_report_api_invocations__invocation_id__report_get: { + /** Get JSON summarizing invocation for reporting. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["InvocationReport"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get: { + /** Get PDF summarizing invocation for reporting. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: never; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + invocation_step_jobs_summary_api_invocations__invocation_id__step_jobs_summary_get: { + /** + * Get job state summary info aggregated per step of the workflow invocation. + * @description Warning: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["InvocationStepJobsResponseStepModel"] + | components["schemas"]["InvocationStepJobsResponseJobModel"] + | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + invocation_step_api_invocations__invocation_id__steps__step_id__get: { + /** + * Show details of workflow invocation step. + * @description An alias for `GET /api/invocations/steps/{step_id}`. `invocation_id` is ignored. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["InvocationStep"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_invocation_step_api_invocations__invocation_id__steps__step_id__put: { + /** Update state of running workflow step invocation - still very nebulous but this would be for stuff like confirming paused steps can proceed etc. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["InvocationUpdatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["InvocationStep"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + write_store_api_invocations__invocation_id__write_store_post: { + /** Prepare a workflow invocation export-style download and write to supplied URI. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["WriteInvocationStoreToPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + job_lock_status_api_job_lock_get: { + /** + * Job Lock Status + * @description Get job lock status. + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["JobLock"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_job_lock_api_job_lock_put: { + /** + * Update Job Lock + * @description Set job lock status. + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["JobLock"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["JobLock"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_jobs_get: { + /** Index */ + parameters?: { + /** @description If true, and requester is an admin, will return external job id and user email. This is only available to admins. */ + /** @description an encoded user id to restrict query to, must be own id if not admin user */ + /** @description Determines columns to return. Defaults to 'collection'. */ + /** @description Limit listing of jobs to those that are updated after specified date (e.g. '2014-01-01') */ + /** @description Limit listing of jobs to those that are updated before specified date (e.g. '2014-01-01') */ + /** @description Limit listing of jobs to those that match the history_id. If none, jobs from any history may be returned. */ + /** @description Limit listing of jobs to those that match the specified workflow ID. If none, jobs from any workflow (or from no workflows) may be returned. */ + /** @description Limit listing of jobs to those that match the specified workflow invocation ID. If none, jobs from any workflow invocation (or from no workflows) may be returned. */ + /** @description Limit listing of jobs to those that match the specified implicit collection job ID. If none, jobs from any implicit collection execution (or from no implicit collection execution) may be returned. */ + /** @description Sort results by specified field. */ + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `user` + * : The user email of the user that executed the Job. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tool_id` + * : The tool ID corresponding to the job. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `runner` + * : The job runner name used to execute the job. (The tag `r` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. + * + * `handler` + * : The job handler name used to execute the job. (The tag `h` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Jobs: `user`, `tool`, `handler`, `runner`. + */ + /** @description Maximum number of jobs to return. */ + /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ + /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ + /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ + /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ + query?: { + user_details?: boolean; + user_id?: string | null; + view?: components["schemas"]["JobIndexViewEnum"]; + date_range_min?: string | string | null; + date_range_max?: string | string | null; + history_id?: string | null; + workflow_id?: string | null; + invocation_id?: string | null; + implicit_collection_jobs_id?: string | null; + order_by?: components["schemas"]["JobIndexSortByEnum"]; + search?: string | null; + /** @description Maximum number of jobs to return. */ + limit?: number; + /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ + offset?: number; + /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ + state?: string[] | null; + /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ + tool_id?: string[] | null; + /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ + tool_id_like?: string[] | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["ShowFullJobResponse"] + | components["schemas"]["EncodedJobDetails"] + | components["schemas"]["JobSummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + search_jobs_api_jobs_search_post: { + /** + * Return jobs for current user + * @description This method is designed to scan the list of previously run jobs and find records of jobs that had + * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply + * recycle the old results. + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SearchJobsPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["EncodedJobDetails"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_job_api_jobs__job_id__get: { + /** Return dictionary containing description of job data. */ + parameters: { + query?: { + /** @description Show extra information. */ + full?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["ShowFullJobResponse"] + | components["schemas"]["EncodedJobDetails"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + cancel_job_api_jobs__job_id__delete: { + /** Cancels specified job */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteJobPayload"] | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": boolean; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + check_common_problems_api_jobs__job_id__common_problems_get: { + /** Check inputs and job for common potential problems to aid in error reporting */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["JobInputSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + destination_params_job_api_jobs__job_id__destination_params_get: { + /** Return destination parameters for specified job. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["JobDestinationParams"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + report_error_api_jobs__job_id__error_post: { + /** Submits a bug report via the API. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ReportJobErrorPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["JobErrorSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_inputs_api_jobs__job_id__inputs_get: { + /** Returns input datasets created by a job. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["JobInputAssociation"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_metrics_api_jobs__job_id__metrics_get: { + /** Return job metrics for specified job. */ + parameters: { + query?: { + /** + * @deprecated + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + */ + hda_ldda?: components["schemas"]["DatasetSourceType"] | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": (components["schemas"]["JobMetric"] | null)[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_token_api_jobs__job_id__oidc_tokens_get: { + /** + * Get a fresh OIDC token + * @description Allows remote job running mechanisms to get a fresh OIDC token that can be used on remote side to authorize user. It is not meant to represent part of Galaxy's stable, user facing API + */ + parameters: { + query: { + /** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job */ + job_key: string; + /** @description OIDC provider name */ + provider: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "text/plain": string; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "text/plain": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_outputs_api_jobs__job_id__outputs_get: { + /** Returns output datasets created by a job. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["JobOutputAssociation"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + resolve_parameters_display_api_jobs__job_id__parameters_display_get: { + /** + * Resolve parameters as a list for nested display. + * @description Resolve parameters as a list for nested display. + * This API endpoint is unstable and tied heavily to Galaxy's JS client code, + * this endpoint will change frequently. + */ + parameters: { + query?: { + /** + * @deprecated + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + */ + hda_ldda?: components["schemas"]["DatasetSourceType"] | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["JobDisplayParametersSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + resume_paused_job_api_jobs__job_id__resume_put: { + /** Resumes a paused job. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["JobOutputAssociation"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_libraries_get: { + /** + * Returns a list of summary data for all libraries. + * @description Returns a list of summary data for all libraries. + */ + parameters?: { + /** @description Whether to include deleted libraries in the result. */ + query?: { + /** @description Whether to include deleted libraries in the result. */ + deleted?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibrarySummaryList"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_api_libraries_post: { + /** + * Creates a new library and returns its summary information. + * @description Creates a new library and returns its summary information. Currently, only admin users can create libraries. + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibrarySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_deleted_api_libraries_deleted_get: { + /** + * Returns a list of summary data for all libraries marked as deleted. + * @description Returns a list of summary data for all libraries marked as deleted. + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibrarySummaryList"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_from_store_api_libraries_from_store_post: { + /** Create libraries from a model store. */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibrariesFromStore"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibrarySummary"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_api_libraries__id__get: { + /** + * Returns summary information about a particular library. + * @description Returns summary information about a particular library. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Library. */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibrarySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_api_libraries__id__delete: { + /** + * Marks the specified library as deleted (or undeleted). + * @description Marks the specified library as deleted (or undeleted). + * Currently, only admin users can delete or restore libraries. + */ + parameters: { + query?: { + /** @description Whether to restore a deleted library. */ + undelete?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Library. */ + id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteLibraryPayload"] | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibrarySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_api_libraries__id__patch: { + /** + * Updates the information of an existing library. + * @description Updates the information of an existing library. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Library. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateLibraryPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["LibrarySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_permissions_api_libraries__id__permissions_get: { + /** + * Gets the current or available permissions of a particular library. + * @description Gets the current or available permissions of a particular library. + * The results can be paginated and additionally filtered by a query. + */ + parameters: { + query?: { + /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ + scope?: components["schemas"]["LibraryPermissionScope"] | null; + /** @description Indicates whether the roles available for the library access are requested. */ + is_library_access?: boolean | null; + /** @description The page number to retrieve when paginating the available roles. */ + page?: number; + /** @description The maximum number of permissions per page when paginating. */ + page_limit?: number; + /** @description Optional search text to retrieve only the roles matching this query. */ + q?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Library. */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["LibraryCurrentPermissions"] + | components["schemas"]["LibraryAvailablePermissions"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + set_permissions_api_libraries__id__permissions_post: { + /** + * Sets the permissions to access and manipulate a library. + * @description Sets the permissions to access and manipulate a library. + */ + parameters: { + query?: { + /** @description Indicates what action should be performed on the Library. */ + action?: components["schemas"]["LibraryPermissionAction"] | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Library. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": + | components["schemas"]["LibraryPermissionsPayload"] + | components["schemas"]["LegacyLibraryPermissionsPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["LibraryLegacySummary"] + | components["schemas"]["LibraryCurrentPermissions"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_licenses_get: { + /** + * Lists all available SPDX licenses + * @description Returns an index with all the available [SPDX licenses](https://spdx.org/licenses/). + */ + responses: { + /** @description List of SPDX licenses */ + 200: { + content: { + "application/json": components["schemas"]["LicenseMetadataModel"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_api_licenses__id__get: { + /** + * Gets the SPDX license metadata associated with the short identifier + * @description Returns the license metadata associated with the given + * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). + */ + parameters: { + path: { + /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ + id: unknown; + }; + }; + responses: { + /** @description SPDX license metadata */ + 200: { + content: { + "application/json": components["schemas"]["LicenseMetadataModel"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_api_metrics_post: { + /** + * Records a collection of metrics. + * @description Record any metrics sent and return some status object. + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateMetricsPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_user_notifications_api_notifications_get: { + /** + * Returns the list of notifications associated with the user. + * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. + * + * You can use the `limit` and `offset` parameters to paginate through the notifications. + */ + parameters?: { + query?: { + limit?: number | null; + offset?: number | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["UserNotificationListResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_user_notifications_api_notifications_put: { + /** Updates a list of notifications with the requested values in a single request. */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UserNotificationsBatchUpdateRequest"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + send_notification_api_notifications_post: { + /** + * Sends a notification to a list of recipients (users, groups or roles). + * @description Sends a notification to a list of recipients (users, groups or roles). */ - parameters: { - query?: { - /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ - scope?: components["schemas"]["LibraryPermissionScope"] | null; - /** @description The page number to retrieve when paginating the available roles. */ - page?: number; - /** @description The maximum number of permissions per page when paginating. */ - page_limit?: number; - /** @description Optional search text to retrieve only the roles matching this query. */ - q?: string | null; + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationCreateRequest"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["NotificationCreatedResponse"] + | components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; + }; + }; + delete_user_notifications_api_notifications_delete: { + /** Deletes a list of notifications received by the user in a single request. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationsBatchRequest"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + get_all_broadcasted_api_notifications_broadcast_get: { + /** + * Returns all currently active broadcasted notifications. + * @description Only Admin users can access inactive notifications (scheduled or recently expired). + */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["BroadcastNotificationListResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { - "application/json": - | components["schemas"]["LibraryFolderCurrentPermissions"] - | components["schemas"]["LibraryAvailablePermissions"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - set_permissions_api_folders__id__permissions_post: { + broadcast_notification_api_notifications_broadcast_post: { /** - * Sets the permissions to manage a library folder. - * @description Sets the permissions to manage a library folder. + * Broadcasts a notification to every user in the system. + * @description Broadcasted notifications are a special kind of notification that are always accessible to all users, including anonymous users. + * They are typically used to display important information such as maintenance windows or new features. + * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. + * + * Broadcasted notifications can include action links that are displayed as buttons. + * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. + * + * Some key features of broadcasted notifications include: + * - They are not associated with a specific user, so they cannot be deleted or marked as read. + * - They can be scheduled to be displayed in the future or to expire after a certain time. + * - By default, broadcasted notifications are published immediately and expire six months after publication. + * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. */ - parameters: { - query?: { - /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ - action?: components["schemas"]["LibraryFolderPermissionAction"] | null; - }; + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; }; requestBody: { content: { - "application/json": components["schemas"]["LibraryFolderPermissionsPayload"]; + "application/json": components["schemas"]["BroadcastNotificationCreateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibraryFolderCurrentPermissions"]; + "application/json": components["schemas"]["NotificationCreatedResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - delete_api_forms__id__delete: { - /** Delete */ + get_broadcasted_api_notifications_broadcast__notification_id__get: { + /** + * Returns the information of a specific broadcasted notification. + * @description Only Admin users can access inactive notifications (scheduled or recently expired). + */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - id: string; + /** @description The ID of the Notification. */ + notification_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["BroadcastNotificationResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - undelete_api_forms__id__undelete_post: { - /** Undelete */ + update_broadcasted_notification_api_notifications_broadcast__notification_id__put: { + /** + * Updates the state of a broadcasted notification. + * @description Only Admins can update broadcasted notifications. This is useful to reschedule, edit or expire broadcasted notifications. + */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - id: string; + /** @description The ID of the Notification. */ + notification_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationBroadcastUpdateRequest"]; }; }; responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Successful Response */ - 200: { + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - index_api_ftp_files_get: { + get_notification_preferences_api_notifications_preferences_get: { /** - * Displays remote files available to the user. Please use /api/remote_files instead. - * @deprecated - * @description Lists all remote files available to the user from different sources. + * Returns the current user's preferences for notifications. + * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. + * + * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. + * The supported channels are returned in the `supported-channels` header. */ parameters?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - query?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - target?: string; - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - format?: components["schemas"]["RemoteFilesFormat"] | null; - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - recursive?: boolean | null; - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - disable?: components["schemas"]["RemoteFilesDisableMode"] | null; - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - writeable?: boolean | null; - }; + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -15096,729 +31311,660 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["ListUriResponse"] - | components["schemas"]["ListJstreeResponse"]; + "application/json": components["schemas"]["UserNotificationPreferences"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - index_api_genomes_get: { - /** Return a list of installed genomes */ + update_notification_preferences_api_notifications_preferences_put: { + /** + * Updates the user's preferences for notifications. + * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. + * + * - Can be used to completely enable/disable notifications for a particular type (category) + * or to enable/disable a particular channel on each category. + */ parameters?: { - /** @description If true, return genome keys with chromosome lengths */ - query?: { - /** @description If true, return genome keys with chromosome lengths */ - chrom_info?: 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?: { /** @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. */ "run-as"?: string | null; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateUserNotificationPreferencesRequest"]; + }; + }; responses: { - /** @description Installed genomes */ + /** @description Successful Response */ 200: { content: { - "application/json": string[][]; + "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_api_genomes__id__get: { - /** Return information about build */ - parameters: { - query?: { - /** @description If true, return reference data */ - reference?: boolean; - /** @description Limits size of returned data */ - num?: number; - /** @description Limits size of returned data */ - chrom?: string; - /** @description Limits size of returned data */ - low?: number; - /** @description Limits size of returned data */ - high?: number; - /** @description Format */ - format?: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description Genome ID */ - id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Information about genome build */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - indexes_api_genomes__id__indexes_get: { - /** Return all available indexes for a genome id for provided type */ - parameters: { - query?: { - /** @description Index type */ - type?: string; - /** @description Format */ - format?: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description Genome ID */ - id: string; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Indexes for a genome id for provided type */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - sequences_api_genomes__id__sequences_get: { - /** Return raw sequence data */ + get_notifications_status_api_notifications_status_get: { + /** + * Returns the current status summary of the user's notifications since a particular date. + * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. + */ parameters: { - query?: { - /** @description If true, return reference data */ - reference?: boolean; - /** @description Limits size of returned data */ - chrom?: string; - /** @description Limits size of returned data */ - low?: number; - /** @description Limits size of returned data */ - high?: number; - /** @description Format */ - format?: string; + query: { + since: string; }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description Genome ID */ - id: string; - }; }; responses: { - /** @description Raw sequence data */ + /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["NotificationStatusSummary"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_groups_get: { - /** Displays a collection (list) of groups. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["GroupListResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - create_api_groups_post: { - /** Creates a new group. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["GroupCreatePayload"]; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["GroupListResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - show_group_api_groups__group_id__get: { - /** Displays information about a group. */ + show_notification_api_notifications__notification_id__get: { + /** Displays information about a notification received by the user. */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - group_id: string; + /** @description The ID of the Notification. */ + notification_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupResponse"]; + "application/json": components["schemas"]["UserNotificationResponse"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_api_groups__group_id__put: { - /** Modifies a group. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - group_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["GroupCreatePayload"]; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["GroupResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_groups__group_id__delete: { - /** Delete */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - group_id: string; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - purge_api_groups__group_id__purge_post: { - /** Purge */ + update_user_notification_api_notifications__notification_id__put: { + /** Updates the state of a notification received by the user. */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - group_id: string; + /** @description The ID of the Notification. */ + notification_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UserNotificationUpdateRequest"]; }; }; responses: { - /** @description Successful Response */ - 200: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Successful Response */ + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - group_roles_api_groups__group_id__roles_get: { - /** Displays a collection (list) of groups. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the group. */ - group_id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["GroupRoleListResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - group_role_api_groups__group_id__roles__role_id__get: { - /** Displays information about a group role. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the role. */ - role_id: string; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["GroupRoleResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_api_groups__group_id__roles__role_id__put: { - /** Adds a role to a group */ + delete_user_notification_api_notifications__notification_id__delete: { + /** + * Deletes a notification received by the user. + * @description When a notification is deleted, it is not immediately removed from the database, but marked as deleted. + * + * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. + * - It will be eventually removed from the database by a background task after the expiration time. + * - Deleted notifications will be permanently deleted when the expiration time is reached. + */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the role. */ - role_id: string; + /** @description The ID of the Notification. */ + notification_id: string; }; }; responses: { - /** @description Successful Response */ - 200: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { - "application/json": components["schemas"]["GroupRoleResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Successful Response */ + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_groups__group_id__roles__role_id__delete: { - /** Removes a role from a group */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the role. */ - role_id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["GroupRoleResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - undelete_api_groups__group_id__undelete_post: { - /** Undelete */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - group_id: string; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - group_user_api_groups__group_id__user__user_id__get: { - /** - * Displays information about a group user. - * @description Displays information about a group user. - */ - parameters: { + index_api_object_stores_get: { + /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ + parameters?: { + /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ + query?: { + /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ + selectable?: boolean; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; - }; }; responses: { - /** @description Successful Response */ + /** @description A list of the configured object stores. */ 200: { content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": components["schemas"]["ConcreteObjectStoreModel"][]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_api_groups__group_id__user__user_id__put: { - /** - * Adds a user to a group - * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_groups__group_id__user__user_id__delete: { - /** - * Removes a user from a group - * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - group_users_api_groups__group_id__users_get: { - /** - * Displays a collection (list) of groups. - * @description GET /api/groups/{encoded_group_id}/users - * Displays a collection (list) of groups. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["GroupUserListResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - group_user_api_groups__group_id__users__user_id__get: { - /** - * Displays information about a group user. - * @description Displays information about a group user. - */ + show_info_api_object_stores__object_store_id__get: { + /** Get information about a concrete object store configured with Galaxy. */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; + /** @description The concrete object store ID. */ + object_store_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": components["schemas"]["ConcreteObjectStoreModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_api_groups__group_id__users__user_id__put: { - /** - * Adds a user to a group - * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_groups__group_id__users__user_id__delete: { - /** - * Removes a user from a group - * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - search_forum_api_help_forum_search_get: { - /** - * Search the Galaxy Help forum. - * @description Search the Galaxy Help forum using the Discourse API. - * - * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. - */ - parameters: { - query: { - /** @description Search query to use for searching the Galaxy Help forum. */ - query: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["HelpForumSearchResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_histories_get: { - /** Returns histories available to the current user. */ + index_api_pages_get: { + /** + * Lists all Pages viewable by the user. + * @description Get a list with summary information of all Pages available to the user. + */ parameters?: { - /** @description The maximum number of items to return. */ - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - /** @description Whether to include archived histories. */ - /** @description Sort index by this specified attribute */ - /** @description Sort in descending order? */ + /** @description Whether to include deleted pages in the result. */ /** * @description A mix of free text and GitHub-style tags used to filter the index operation. * @@ -15838,227 +31984,120 @@ export interface operations { * * ## GitHub-style Tags Available * - * `name` - * : The history's name. + * `title` + * : The page's title. * - * `annotation` - * : The history's annotation. (The tag `a` can be used a short hand alias for this tag to filter on this attribute.) + * `slug` + * : The page's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) * * `tag` - * : The history's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * : The page's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `user` + * : The page's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) * * ## Free Text * * Free text search terms will be searched against the following attributes of the - * Historys: `title`, `description`, `slug`, `tag`. - */ - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - /** - * @deprecated - * @description Whether to return only deleted items. + * Pages: `title`, `slug`, `tag`, `user`. */ - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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 */ + /** @description Sort page index by this specified attribute on the page model */ + /** @description Sort in descending order? */ query?: { - limit?: number | null; - offset?: number | null; + deleted?: boolean; + limit?: number; + offset?: number; + search?: string | null; show_own?: boolean; show_published?: boolean; show_shared?: boolean; - show_archived?: boolean | null; - sort_by?: "create_time" | "name" | "update_time" | "username"; + /** @description Sort page index by this specified attribute on the page model */ + sort_by?: "create_time" | "title" | "update_time" | "username"; + /** @description Sort in descending order? */ sort_desc?: boolean; - search?: string | null; - all?: boolean | null; - deleted?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @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. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; - }; - }; - /** @description Bad Request */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_histories_post: { - /** - * Creates a new history. - * @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?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + user_id?: string | null; }; header?: { /** @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. */ "run-as"?: string | null; }; }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": components["schemas"]["Body_create_api_histories_post"]; - }; - }; responses: { - /** @description Successful Response */ + /** @description A list with summary page information. */ 200: { content: { - "application/json": - | components["schemas"]["JobImportHistoryResponse"] - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["PageSummaryList"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_archived_histories_api_histories_archived_get: { - /** - * Get a list of all archived histories for the current user. - * @description Get a list of all archived histories for the current user. - * - * 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. */ - /** @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. */ - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": ( - | components["schemas"]["ArchivedHistorySummary"] - | components["schemas"]["ArchivedHistoryDetailed"] - | Record - )[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - batch_delete_api_histories_batch_delete_put: { - /** Marks several histories with the given IDs 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; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["DeleteHistoriesPayload"]; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - batch_undelete_api_histories_batch_undelete_put: { - /** Marks several histories with the given IDs as undeleted. */ + create_api_pages_post: { + /** + * Create a page and return summary information. + * @description Get a list with details of all Pages available to the user. + */ parameters?: { - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -16066,913 +32105,924 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["UndeleteHistoriesPayload"]; + "application/json": components["schemas"]["CreatePagePayload"]; }; }; responses: { - /** @description Successful Response */ + /** @description The page summary information. */ 200: { content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": components["schemas"]["PageSummary"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - count_api_histories_count_get: { - /** Returns number of histories for the current user. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": number; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_deleted_api_histories_deleted_get: { - /** Returns deleted histories for the current user. */ - parameters?: { - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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?: { - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - all?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - undelete_api_histories_deleted__history_id__undelete_post: { - /** Restores a deleted history with the given ID (that hasn't been purged). */ + show_api_pages__id__get: { + /** + * Return a page summary and the content of the last revision. + * @description Return summary information about a specific Page and the content of the last revision. + */ parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The ID of the Page. */ + id: string; }; }; responses: { - /** @description Successful Response */ + /** @description The page summary information. */ 200: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["PageDetails"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - 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?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + delete_api_pages__id__delete: { + /** + * Marks the specific Page as deleted. + * @description Marks the Page with the given ID as deleted. + */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Page. */ + id: string; + }; }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryFromStore"]; + responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { /** @description Successful Response */ - 200: { + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - create_from_store_async_api_histories_from_store_async_post: { - /** Launch a task to create histories from a model store. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryFromStore"]; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - 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?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + show_pdf_api_pages__id__pdf_get: { + /** + * Return a PDF document of the last revision of the Page. + * @description Return a PDF document of the last revision of the Page. + * + * This feature may not be available in this Galaxy. + */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Page. */ + id: string; + }; }; responses: { - /** @description Successful Response */ + /** @description PDF document with the last revision of the page. */ 200: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/pdf": unknown; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - published_api_histories_published_get: { - /** Return all histories that are published. */ - parameters?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - shared_with_me_api_histories_shared_with_me_get: { - /** Return all histories that are shared with the current user. */ - parameters?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description PDF conversion service not available. */ + 501: { + content: never; + }; }; }; - history_api_histories__history_id__get: { - /** Returns the history with the given ID. */ + /** + * Makes this item inaccessible by a URL link. + * @description Makes this item inaccessible by a URL link and return the current sharing status. + */ + disable_link_access_api_pages__id__disable_link_access_put: { parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The ID of the Page. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_api_histories__history_id__put: { - /** Updates the values for the history with the given ID. */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": unknown; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - delete_api_histories__history_id__delete: { - /** Marks the history with the given ID as deleted. */ + enable_link_access_api_pages__id__enable_link_access_put: { + /** + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. + */ parameters: { - query?: { - purge?: boolean; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryPayload"] | null; + /** @description The ID of the Page. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - archive_history_api_histories__history_id__archive_post: { - /** - * Archive a history. - * @description Marks the given history as 'archived' and returns the history. - * - * Archiving a history will remove it from the list of active histories of the user but it will still be - * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. - * - * Associating an export record: - * - * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the - * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and - * must be in the ready state. - * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. - * - * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. - * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ArchiveHistoryRequestPayload"] | null; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": - | components["schemas"]["ArchivedHistorySummary"] - | components["schemas"]["ArchivedHistoryDetailed"] - | Record; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - restore_archived_history_api_histories__history_id__archive_restore_put: { + prepare_pdf_api_pages__id__prepare_download_post: { /** - * Restore an archived history. - * @description Restores an archived history and returns it. - * - * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). + * Return a PDF document of the last revision of the Page. + * @description Return a STS download link for this page to be downloaded as a PDF. * - * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them - * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export - * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. + * This feature may not be available in this Galaxy. */ parameters: { - query?: { - /** @description If true, the history will be un-archived even if it has an associated archive export record and was purged. */ - force?: boolean | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The ID of the Page. */ + id: string; }; }; responses: { - /** @description Successful Response */ + /** @description Short term storage reference for async monitoring of this download. */ 200: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["AsyncFile"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description PDF conversion service not available. */ + 501: { + content: never; + }; }; }; - citations_api_histories__history_id__citations_get: { - /** Return all the citations for the tools used to produce the datasets in the history. */ + /** + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. + */ + publish_api_pages__id__publish_put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The ID of the Page. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record[]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - history_contents__index: { - /** - * Returns the contents of the given history. - * @description Return a list of `HDA`/`HDCA` data for the history with the given ``ID``. - * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - parameters: { - query?: { - /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ - v?: string | null; - /** - * @deprecated - * @description Legacy name for the `dataset_details` parameter. - */ - details?: string | null; - /** - * @deprecated - * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. - */ - ids?: string | null; - /** - * @deprecated - * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. - */ - types?: string[] | null; - /** - * @deprecated - * @description Whether to return deleted or undeleted datasets only. Leave unset for both. - */ - deleted?: boolean | null; - /** - * @deprecated - * @description Whether to return visible or hidden datasets only. Leave unset for both. - */ - visible?: boolean | null; - /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ - shareable?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description The contents of the history that match the query. */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["HistoryContentsResult"]; - "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - update_batch_api_histories__history_id__contents_put: { + share_with_users_api_pages__id__share_with_users_put: { /** - * Batch update specific properties of a set items contained in the given History. - * @description Batch update specific properties of a set items contained in the given History. - * - * If you provide an invalid/unknown property key the request will not fail, but no changes - * will be made to the items. + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. */ parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The ID of the Page. */ + id: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["UpdateHistoryContentsBatchPayload"]; + "application/json": components["schemas"]["ShareWithPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["HistoryContentsResult"]; + "application/json": components["schemas"]["ShareWithStatus"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - history_contents__create: { - /** - * Create a new `HDA` or `HDCA` in the given History. - * @deprecated - * @description Create a new `HDA` or `HDCA` in the given History. - */ - parameters: { - query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"] | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryContentPayload"]; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - | ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - history_contents__archive: { + sharing_api_pages__id__sharing_get: { /** - * Build and return a compressed archive of the selected history contents. - * @description Build and return a compressed archive of the selected history contents. - * - * **Note**: this is a volatile endpoint and settings and behavior may change. + * Get the current sharing status of the given Page. + * @description Return the sharing status of the item. */ parameters: { - query?: { - /** @description The name that the Archive will have (defaults to history name). */ - filename?: string | null; - /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ - dry_run?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The ID of the Page. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["SharingStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - history_contents__archive_named: { + set_slug_api_pages__id__slug_put: { /** - * Build and return a compressed archive of the selected history contents. - * @description Build and return a compressed archive of the selected history contents. - * - * **Note**: this is a volatile endpoint and settings and behavior may change. + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. */ parameters: { - query?: { - /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ - dry_run?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The name that the Archive will have (defaults to history name). */ - filename: string; - /** - * @deprecated - * @description Output format of the archive. - */ - format: string; + /** @description The ID of the Page. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetSlugPayload"]; }; }; responses: { - /** @description Successful Response */ - 200: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Successful Response */ + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - bulk_operation_api_histories__history_id__contents_bulk_put: { - /** - * Executes an operation on a set of items contained in the given History. - * @description Executes an operation on a set of items contained in the given History. - * - * The items to be processed can be explicitly set or determined by a dynamic query. - */ - parameters: { - query?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["HistoryContentBulkOperationPayload"]; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["HistoryContentBulkOperationResult"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - history_contents__download_collection: { + undelete_api_pages__id__undelete_put: { /** - * Download the content of a dataset collection as a `zip` archive. - * @description Download the content of a history dataset collection as a `zip` archive - * while maintaining approximate collection structure. + * Undelete the specific Page. + * @description Marks the Page with the given ID as undeleted. */ parameters: { header?: { @@ -16980,56 +33030,79 @@ export interface operations { "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ + /** @description The ID of the Page. */ id: string; - /** @description The encoded database identifier of the History. */ - history_id: string | null; }; }; responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Successful Response */ - 200: never; - /** @description Bad Request */ - 422: { + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - materialize_dataset_api_histories__history_id__contents_datasets__id__materialize_post: { - /** Materialize a deferred dataset into real, usable dataset. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - update_permissions_api_histories__history_id__contents__dataset_id__permissions_put: { + unpublish_api_pages__id__unpublish_put: { /** - * Set permissions of the given history dataset to the given role ids. - * @description Set permissions of the given history dataset to the given role ids. + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. */ parameters: { header?: { @@ -17037,498 +33110,415 @@ export interface operations { "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - dataset_id: string; - }; - }; - requestBody: { - content: { - "application/json": Record; + /** @description The ID of the Page. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatasetAssociationRoles"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - history_contents_display_api_histories__history_id__contents__history_content_id__display_get: { - /** - * Displays (preview) or downloads dataset content. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ - parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; - history_id: string | null; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Bad Request */ + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - history_contents_display_api_histories__history_id__contents__history_content_id__display_head: { + index_api_quotas_get: { /** - * Check if dataset content can be previewed or downloaded. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. + * Displays a list with information of quotas that are currently active. + * @description Displays a list with information of quotas that are currently active. */ - parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; - }; + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; - history_id: string | null; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["QuotaSummaryList"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - extra_files_history_api_histories__history_id__contents__history_content_id__extra_files_get: { - /** Get the list of extra files/directories associated with a dataset. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["DatasetExtraFiles"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - history_contents__get_metadata_file: { - /** Returns the metadata file associated with this history item. */ - parameters: { - query: { - /** @description The name of the metadata file to retrieve. */ - metadata_file: string; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - index_api_histories__history_id__contents__history_content_id__tags_get: { - /** Show tags based on history_content_id */ - parameters: { + create_api_quotas_post: { + /** + * Creates a new quota. + * @description Creates a new quota. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - history_content_id: string; - history_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateQuotaParams"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsListResponse"]; + "application/json": components["schemas"]["CreateQuotaResult"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_api_histories__history_id__contents__history_content_id__tags__tag_name__get: { - /** Show tag based on history_content_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - history_content_id: string; - tag_name: string; - history_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_api_histories__history_id__contents__history_content_id__tags__tag_name__put: { - /** Update tag based on history_content_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - history_content_id: string; - tag_name: string; - history_id: string; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_api_histories__history_id__contents__history_content_id__tags__tag_name__post: { - /** Create tag based on history_content_id */ - parameters: { + index_deleted_api_quotas_deleted_get: { + /** + * Displays a list with information of quotas that have been deleted. + * @description Displays a list with information of quotas that have been deleted. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - history_content_id: string; - tag_name: string; - history_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["QuotaSummaryList"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_histories__history_id__contents__history_content_id__tags__tag_name__delete: { - /** Delete tag based on history_content_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - history_content_id: string; - tag_name: string; - history_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": boolean; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - history_contents__show_legacy: { - /** - * Return detailed information about an HDA within a history. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. - * @deprecated - * @description Return detailed information about an `HDA` or `HDCA` within a history. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - parameters: { - query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; - /** @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. */ - fuzzy_count?: number | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - history_contents__update_legacy: { + deleted_quota_api_quotas_deleted__id__get: { /** - * Updates the values for the history content item with the given ``ID`` and query specified type. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. - * @deprecated - * @description Updates the values for the history content item with the given ``ID``. + * Displays details on a particular quota that has been deleted. + * @description Displays details on a particular quota that has been deleted. */ parameters: { - query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ + /** @description The ID of the Quota. */ id: string; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; - }; - }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + "application/json": components["schemas"]["QuotaDetails"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - history_contents__delete_legacy: { - /** - * Delete the history dataset with the given ``ID``. - * @description Delete the history content with the given ``ID`` and query specified type (defaults to dataset). - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. - */ - parameters: { - query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - purge?: boolean | null; - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - recursive?: boolean | null; - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - stop_job?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentPayload"]; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Request has been executed. */ - 200: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Request accepted, processing will finish later. */ - 202: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - validate_api_histories__history_id__contents__id__validate_put: { + undelete_api_quotas_deleted__id__undelete_post: { /** - * Validates the metadata associated with a dataset within a History. - * @description Validates the metadata associated with a dataset within a History. + * Restores a previously deleted quota. + * @description Restores a previously deleted quota. */ parameters: { header?: { @@ -17536,9 +33526,7 @@ export interface operations { "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ + /** @description The ID of the Quota. */ id: string; }; }; @@ -17546,1591 +33534,1497 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": string; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - history_contents__index_typed: { - /** - * Returns the contents of the given history filtered by type. - * @description Return a list of either `HDA`/`HDCA` data for the history with the given ``ID``. - * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - parameters: { - query?: { - /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ - v?: string | null; - /** - * @deprecated - * @description Legacy name for the `dataset_details` parameter. - */ - details?: string | null; - /** - * @deprecated - * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. - */ - ids?: string | null; - /** - * @deprecated - * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. - */ - types?: string[] | null; - /** - * @deprecated - * @description Whether to return deleted or undeleted datasets only. Leave unset for both. - */ - deleted?: boolean | null; - /** - * @deprecated - * @description Whether to return visible or hidden datasets only. Leave unset for both. - */ - visible?: boolean | null; - /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ - shareable?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": - | components["schemas"]["HistoryContentsResult"] - | components["schemas"]["HistoryContentsWithStatsResult"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - history_contents__create_typed: { + quota_api_quotas__id__get: { /** - * Create a new `HDA` or `HDCA` in the given History. - * @description Create a new `HDA` or `HDCA` in the given History. + * Displays details on a particular active quota. + * @description Displays details on a particular active quota. */ parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryContentPayload"]; + /** @description The ID of the Quota. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - | ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; + "application/json": components["schemas"]["QuotaDetails"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - history_contents__show: { - /** - * Return detailed information about a specific HDA or HDCA with the given `ID` within a history. - * @description Return detailed information about an `HDA` or `HDCA` within a history. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - parameters: { - query?: { - /** @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. */ - fuzzy_count?: number | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - history_contents__update_typed: { + update_api_quotas__id__put: { /** - * Updates the values for the history content item with the given ``ID`` and path specified type. - * @description Updates the values for the history content item with the given ``ID``. + * Updates an existing quota. + * @description Updates an existing quota. */ parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ + /** @description The ID of the Quota. */ id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; }; }; requestBody: { content: { - "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; + "application/json": components["schemas"]["UpdateQuotaParams"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + "application/json": string; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - history_contents__delete_typed: { + delete_api_quotas__id__delete: { /** - * Delete the history content with the given ``ID`` and path specified type. - * @description Delete the history content with the given ``ID`` and path specified type. - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. + * Deletes an existing quota. + * @description Deletes an existing quota. */ parameters: { - query?: { - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - purge?: boolean | null; - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - recursive?: boolean | null; - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - stop_job?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ + /** @description The ID of the Quota. */ id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; }; }; requestBody?: { content: { - "application/json": components["schemas"]["DeleteHistoryContentPayload"]; + "application/json": components["schemas"]["DeleteQuotaPayload"]; }; }; responses: { - /** @description Request has been executed. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + "application/json": string; }; }; - /** @description Request accepted, processing will finish later. */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - show_jobs_summary_api_histories__history_id__contents__type_s__id__jobs_summary_get: { - /** - * Return detailed information about an `HDA` or `HDCAs` jobs. - * @description Return detailed information about an `HDA` or `HDCAs` jobs. - * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ + purge_api_quotas__id__purge_post: { + /** Purges a previously deleted quota. */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ + /** @description The ID of the Quota. */ id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["JobStateSummary"] - | components["schemas"]["ImplicitCollectionJobsStateSummary"] - | components["schemas"]["WorkflowInvocationStateSummary"]; + "application/json": string; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - prepare_store_download_api_histories__history_id__contents__type_s__id__prepare_store_download_post: { - /** Prepare a dataset or dataset collection for export-style download. */ - parameters: { + index_api_remote_files_get: { + /** + * Displays remote files available to the user. + * @description Lists all remote files available to the user from different sources. + */ + parameters?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + query?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + target?: string; + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + format?: components["schemas"]["RemoteFilesFormat"] | null; + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + recursive?: boolean | null; + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + disable?: components["schemas"]["RemoteFilesDisableMode"] | null; + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + writeable?: boolean | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["StoreExportPayload"]; - }; }; responses: { - /** @description Successful Response */ + /** @description A list with details about the remote files available to the user. */ 200: { content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": + | components["schemas"]["ListUriResponse"] + | components["schemas"]["ListJstreeResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - write_store_api_histories__history_id__contents__type_s__id__write_store_post: { - /** Prepare a dataset or dataset collection for export-style download and write to supplied URI. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["WriteStoreToPayload"]; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_from_store_api_histories__history_id__contents_from_store_post: { + create_entry_api_remote_files_post: { /** - * Create contents from store. - * @description Create history contents from model store. - * Input can be a tarfile created with build_objects script distributed - * with galaxy-data, from an exported history with files stripped out, - * or hand-crafted JSON dictionary. + * Creates a new entry (directory/record) on the remote files source. + * @description Creates a new entry on the remote files source. */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; }; requestBody: { content: { - "application/json": components["schemas"]["CreateHistoryContentFromStore"]; + "application/json": components["schemas"]["CreateEntryPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; + "application/json": components["schemas"]["CreatedEntryResponse"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_custom_builds_metadata_api_histories__history_id__custom_builds_metadata_get: { - /** Returns meta data for custom builds. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["CustomBuildsMetadataResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - disable_link_access_api_histories__history_id__disable_link_access_put: { - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - enable_link_access_api_histories__history_id__enable_link_access_put: { - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_history_exports_api_histories__history_id__exports_get: { + plugins_api_remote_files_plugins_get: { /** - * Get previous history exports. - * @description By default the legacy job-based history exports (jeha) are returned. - * - * Change the `accept` content type header to return the new task-based history exports. + * Display plugin information for each of the gxfiles:// URI targets available. + * @description Display plugin information for each of the gxfiles:// URI targets available. */ - parameters: { + parameters?: { + /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ + /** @description Whether to return **only** filesources of the specified kind. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ + /** @description Whether to exclude filesources of the specified kind from the list. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ query?: { - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; + /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ + browsable_only?: boolean | null; + /** @description Whether to return **only** filesources of the specified kind. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ + include_kind?: components["schemas"]["PluginKind"][] | null; + /** @description Whether to exclude filesources of the specified kind from the list. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ + exclude_kind?: components["schemas"]["PluginKind"][] | null; }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; }; responses: { - /** @description A list of history exports */ + /** @description A list with details about each plugin. */ 200: { content: { - "application/json": components["schemas"]["JobExportHistoryArchiveListResponse"]; - "application/vnd.galaxy.task.export+json": components["schemas"]["ExportTaskListResponse"]; + "application/json": components["schemas"]["FilesSourcePluginList"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - archive_export_api_histories__history_id__exports_put: { - /** - * Start job (if needed) to create history export for corresponding history. - * @deprecated - * @description This will start a job to create a history export archive. - * - * Calling this endpoint multiple times will return the 202 status code until the archive - * has been completely generated and is ready to download. When ready, it will return - * the 200 status code along with the download link information. - * - * If the history will be exported to a `directory_uri`, instead of returning the download - * link information, the Job ID will be returned so it can be queried to determine when - * the file has been written. - * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ExportHistoryArchivePayload"] | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Object containing url to fetch export from. */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": - | components["schemas"]["JobExportHistoryArchiveModel"] - | components["schemas"]["JobIdResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description The exported archive file is not ready yet. */ - 202: never; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - history_archive_download_api_histories__history_id__exports__jeha_id__get: { - /** - * If ready and available, return raw contents of exported history as a downloadable archive. - * @deprecated - * @description See ``PUT /api/histories/{id}/exports`` to initiate the creation - * of the history export - when ready, that route will return 200 status - * code (instead of 202) and this route can be used to download the archive. - * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the specific Job Export History Association or `latest` (default) to download the last generated archive. */ - jeha_id: string | "latest"; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description The archive file containing the History. */ - 200: never; - /** @description Bad Request */ + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - index_jobs_summary_api_histories__history_id__jobs_summary_get: { - /** - * Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. - * @description Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. - * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - parameters: { - query?: { - /** @description A comma-separated list of encoded ids of job summary objects to return - if `ids` is specified types must also be specified and have same length. */ - ids?: string | null; - /** @description A comma-separated list of type of object represented by elements in the `ids` array - any of `Job`, `ImplicitCollectionJob`, or `WorkflowInvocation`. */ - types?: string | null; - }; + index_api_roles_get: { + /** Index */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["JobStateSummary"] - | components["schemas"]["ImplicitCollectionJobsStateSummary"] - | components["schemas"]["WorkflowInvocationStateSummary"] - )[]; + "application/json": components["schemas"]["RoleListResponse"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - materialize_to_history_api_histories__history_id__materialize_post: { - /** Materialize a deferred library or HDA dataset into real, usable dataset in specified history. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["MaterializeDatasetInstanceAPIRequest"]; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - prepare_store_download_api_histories__history_id__prepare_store_download_post: { - /** Return a short term storage token to monitor download of the history. */ - parameters: { + create_api_roles_post: { + /** Create */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; }; requestBody: { content: { - "application/json": components["schemas"]["StoreExportPayload"]; + "application/json": components["schemas"]["RoleDefinitionModel"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": components["schemas"]["RoleModelResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - publish_api_histories__history_id__publish_put: { - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ + show_api_roles__id__get: { + /** Show */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - share_with_users_api_histories__history_id__share_with_users_put: { - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ShareWithPayload"]; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["ShareHistoryWithStatus"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - sharing_api_histories__history_id__sharing_get: { - /** - * Get the current sharing status of the given item. - * @description Return the sharing status of the item. - */ + delete_api_roles__id__delete: { + /** Delete */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["RoleModelResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - set_slug_api_histories__history_id__slug_put: { - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["SetSlugPayload"]; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 204: never; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_histories__history_id__tags_get: { - /** Show tags based on history_id */ + purge_api_roles__id__purge_post: { + /** Purge */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - history_id: string; + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsListResponse"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_api_histories__history_id__tags__tag_name__get: { - /** Show tag based on history_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - history_id: string; - tag_name: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_api_histories__history_id__tags__tag_name__put: { - /** Update tag based on history_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - history_id: string; - tag_name: string; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_api_histories__history_id__tags__tag_name__post: { - /** Create tag based on history_id */ + undelete_api_roles__id__undelete_post: { + /** Undelete */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - history_id: string; - tag_name: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_histories__history_id__tags__tag_name__delete: { - /** Delete tag based on history_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_id: string; - tag_name: string; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": boolean; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - unpublish_api_histories__history_id__unpublish_put: { - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - write_store_api_histories__history_id__write_store_post: { - /** Prepare history for export-style download and write to supplied URI. */ + serve_api_short_term_storage__storage_request_id__get: { + /** Serve the staged download specified by request ID. */ parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["WriteStoreToPayload"]; + storage_request_id: string; }; }; responses: { - /** @description Successful Response */ - 200: { + /** @description The archive file containing the History. */ + 200: never; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Request was cancelled without an exception condition recorded. */ + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_invocations_api_invocations_get: { - /** Get the list of a user's workflow invocations. */ - 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?: { - /** @description Return only invocations for this Workflow ID */ - workflow_id?: string | null; - /** @description Return only invocations for this History ID */ - history_id?: string | null; - /** @description Return only invocations for this Job ID */ - job_id?: string | null; - /** @description Return invocations for this User ID. */ - user_id?: string | null; - /** @description Sort Workflow Invocations by this attribute */ - sort_by?: components["schemas"]["InvocationSortByEnum"] | null; - /** @description Sort in descending order? */ - sort_desc?: boolean; - /** @description Set to false to only include terminal Invocations. */ - include_terminal?: boolean | null; - /** @description Limit the number of invocations to return. */ - limit?: number | null; - /** @description Number of invocations to skip. */ - offset?: number | null; - /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ - instance?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - include_nested_invocations?: boolean; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - create_invocations_from_store_api_invocations_from_store_post: { - /** - * Create Invocations From Store - * @description Create invocation(s) from a supplied model store. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInvocationsFromStorePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - step_api_invocations_steps__step_id__get: { - /** Show details of workflow invocation step. */ + is_ready_api_short_term_storage__storage_request_id__ready_get: { + /** Determine if specified storage request ID is ready for download. */ parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; path: { - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; + storage_request_id: string; }; }; responses: { - /** @description Successful Response */ + /** @description Boolean indicating if the storage is ready. */ 200: { content: { - "application/json": components["schemas"]["InvocationStep"]; + "application/json": boolean; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_invocation_api_invocations__invocation_id__get: { - /** Get detailed description of a workflow invocation. */ - parameters: { - query?: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ - legacy_job_state?: boolean; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - cancel_invocation_api_invocations__invocation_id__delete: { - /** Cancel the specified workflow invocation. */ - parameters: { - query?: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ - legacy_job_state?: boolean; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - invocation_jobs_summary_api_invocations__invocation_id__jobs_summary_get: { - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["InvocationJobsResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - prepare_store_download_api_invocations__invocation_id__prepare_store_download_post: { - /** Prepare a workflow invocation export-style download. */ - parameters: { + cleanup_datasets_api_storage_datasets_delete: { + /** + * Purges a set of datasets by ID from disk. The datasets must be owned by the user. + * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; }; requestBody: { content: { - "application/json": components["schemas"]["PrepareStoreDownloadPayload"]; + "application/json": components["schemas"]["CleanupStorageItemsRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": components["schemas"]["StorageItemsCleanupResult"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_invocation_report_api_invocations__invocation_id__report_get: { - /** Get JSON summarizing invocation for reporting. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": components["schemas"]["InvocationReport"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get: { - /** Get PDF summarizing invocation for reporting. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - invocation_step_jobs_summary_api_invocations__invocation_id__step_jobs_summary_get: { - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": ( - | components["schemas"]["InvocationStepJobsResponseStepModel"] - | components["schemas"]["InvocationStepJobsResponseJobModel"] - | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"] - )[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; - }; - }; - }; - invocation_step_api_invocations__invocation_id__steps__step_id__get: { - /** - * Show details of workflow invocation step. - * @description An alias for `GET /api/invocations/steps/{step_id}`. `invocation_id` is ignored. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + }; + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["InvocationStep"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_invocation_step_api_invocations__invocation_id__steps__step_id__put: { - /** Update state of running workflow step invocation - still very nebulous but this would be for stuff like confirming paused steps can proceed etc. */ - parameters: { + discarded_datasets_api_storage_datasets_discarded_get: { + /** Returns discarded datasets owned by the given user. The results can be paginated. */ + parameters?: { + /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ + query?: { + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ + order?: components["schemas"]["StoredItemOrderBy"] | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["InvocationUpdatePayload"]; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationStep"]; + "application/json": components["schemas"]["StoredItem"][]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - write_store_api_invocations__invocation_id__write_store_post: { - /** Prepare a workflow invocation export-style download and write to supplied URI. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["WriteInvocationStoreToPayload"]; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - job_lock_status_api_job_lock_get: { - /** - * Job Lock Status - * @description Get job lock status. - */ + discarded_datasets_summary_api_storage_datasets_discarded_summary_get: { + /** Returns information with the total storage space taken by discarded datasets owned by the given user. */ parameters?: { /** @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?: { @@ -19142,21 +35036,75 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobLock"]; + "application/json": components["schemas"]["CleanableItemsSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - update_job_lock_api_job_lock_put: { + cleanup_histories_api_storage_histories_delete: { /** - * Update Job Lock - * @description Set job lock status. + * Purges a set of histories by ID. The histories must be owned by the user. + * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. */ parameters?: { /** @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. */ @@ -19167,100 +35115,91 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["JobLock"]; + "application/json": components["schemas"]["CleanupStorageItemsRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobLock"]; + "application/json": components["schemas"]["StorageItemsCleanupResult"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - index_api_jobs_get: { - /** Index */ - parameters?: { - /** @description If true, and requester is an admin, will return external job id and user email. This is only available to admins. */ - /** @description an encoded user id to restrict query to, must be own id if not admin user */ - /** @description Determines columns to return. Defaults to 'collection'. */ - /** @description Limit listing of jobs to those that are updated after specified date (e.g. '2014-01-01') */ - /** @description Limit listing of jobs to those that are updated before specified date (e.g. '2014-01-01') */ - /** @description Limit listing of jobs to those that match the history_id. If none, jobs from any history may be returned. */ - /** @description Limit listing of jobs to those that match the specified workflow ID. If none, jobs from any workflow (or from no workflows) may be returned. */ - /** @description Limit listing of jobs to those that match the specified workflow invocation ID. If none, jobs from any workflow invocation (or from no workflows) may be returned. */ - /** @description Limit listing of jobs to those that match the specified implicit collection job ID. If none, jobs from any implicit collection execution (or from no implicit collection execution) may be returned. */ - /** @description Sort results by specified field. */ - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `user` - * : The user email of the user that executed the Job. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tool_id` - * : The tool ID corresponding to the job. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `runner` - * : The job runner name used to execute the job. (The tag `r` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. - * - * `handler` - * : The job handler name used to execute the job. (The tag `h` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Jobs: `user`, `tool`, `handler`, `runner`. - */ - /** @description Maximum number of jobs to return. */ - /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ - /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ - /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ - /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ - query?: { - user_details?: boolean; - user_id?: string | null; - view?: components["schemas"]["JobIndexViewEnum"]; - date_range_min?: string | string | null; - date_range_max?: string | string | null; - history_id?: string | null; - workflow_id?: string | null; - invocation_id?: string | null; - implicit_collection_jobs_id?: string | null; - order_by?: components["schemas"]["JobIndexSortByEnum"]; - search?: string | null; - /** @description Maximum number of jobs to return. */ - limit?: number; - /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ - offset?: number; - /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ - state?: string[] | null; - /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ - tool_id?: string[] | null; - /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ - tool_id_like?: string[] | null; + archived_histories_api_storage_histories_archived_get: { + /** Returns archived histories owned by the given user that are not purged. The results can be paginated. */ + parameters?: { + /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ + query?: { + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ + order?: components["schemas"]["StoredItemOrderBy"] | null; }; header?: { /** @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. */ @@ -19271,28 +35210,73 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["ShowFullJobResponse"] - | components["schemas"]["EncodedJobDetails"] - | components["schemas"]["JobSummary"] - )[]; + "application/json": components["schemas"]["StoredItem"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - search_jobs_api_jobs_search_post: { - /** - * Return jobs for current user - * @description This method is designed to scan the list of previously run jobs and find records of jobs that had - * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply - * recycle the old results. - */ + archived_histories_summary_api_storage_histories_archived_summary_get: { + /** Returns information with the total storage space taken by non-purged archived histories associated with the given user. */ parameters?: { /** @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?: { @@ -19300,460 +35284,482 @@ export interface operations { "run-as"?: string | null; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["SearchJobsPayload"]; - }; - }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["EncodedJobDetails"][]; + "application/json": components["schemas"]["CleanableItemsSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - show_job_api_jobs__job_id__get: { - /** Return dictionary containing description of job data. */ - parameters: { + discarded_histories_api_storage_histories_discarded_get: { + /** Returns all discarded histories associated with the given user. */ + parameters?: { + /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ query?: { - /** @description Show extra information. */ - full?: boolean | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ + order?: components["schemas"]["StoredItemOrderBy"] | null; }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the job */ - job_id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["ShowFullJobResponse"] - | components["schemas"]["EncodedJobDetails"]; + "application/json": components["schemas"]["StoredItem"][]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - cancel_job_api_jobs__job_id__delete: { - /** Cancels specified job */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the job */ - job_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteJobPayload"] | null; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": boolean; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - check_common_problems_api_jobs__job_id__common_problems_get: { - /** Check inputs and job for common potential problems to aid in error reporting */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the job */ - job_id: string; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["JobInputSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - destination_params_job_api_jobs__job_id__destination_params_get: { - /** Return destination parameters for specified job. */ - parameters: { + discarded_histories_summary_api_storage_histories_discarded_summary_get: { + /** Returns information with the total storage space taken by discarded histories associated with the given user. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the job */ - job_id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobDestinationParams"]; + "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - report_error_api_jobs__job_id__error_post: { - /** Submits a bug report via the API. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the job */ - job_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ReportJobErrorPayload"]; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["JobErrorSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - get_inputs_api_jobs__job_id__inputs_get: { - /** Returns input datasets created by a job. */ - parameters: { + update_api_tags_put: { + /** + * Apply a new set of tags to an item. + * @description Replaces the tags associated with an item with the new ones specified in the payload. + * + * - The previous tags will be __deleted__. + * - If no tags are provided in the request body, the currently associated tags will also be __deleted__. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the job */ - job_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ItemTagsPayload"]; }; }; responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Successful Response */ - 200: { + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": components["schemas"]["JobInputAssociation"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_metrics_api_jobs__job_id__metrics_get: { - /** Return job metrics for specified job. */ - parameters: { - query?: { - /** - * @deprecated - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - */ - hda_ldda?: components["schemas"]["DatasetSourceType"] | null; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the job */ - job_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": (components["schemas"]["JobMetric"] | null)[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_token_api_jobs__job_id__oidc_tokens_get: { - /** - * Get a fresh OIDC token - * @description Allows remote job running mechanisms to get a fresh OIDC token that can be used on remote side to authorize user. It is not meant to represent part of Galaxy's stable, user facing API - */ - parameters: { - query: { - /** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job */ - job_key: string; - /** @description OIDC provider name */ - provider: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - job_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "text/plain": string; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_outputs_api_jobs__job_id__outputs_get: { - /** Returns output datasets created by a job. */ + state_api_tasks__task_id__state_get: { + /** Determine state of task ID */ parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; path: { - /** @description The ID of the job */ - job_id: string; + task_id: string; }; }; responses: { - /** @description Successful Response */ + /** @description String indicating task state. */ 200: { content: { - "application/json": components["schemas"]["JobOutputAssociation"][]; + "application/json": components["schemas"]["TaskState"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - resolve_parameters_display_api_jobs__job_id__parameters_display_get: { - /** - * Resolve parameters as a list for nested display. - * @description Resolve parameters as a list for nested display. - * This API endpoint is unstable and tied heavily to Galaxy's JS client code, - * this endpoint will change frequently. - */ - parameters: { - query?: { - /** - * @deprecated - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - */ - hda_ldda?: components["schemas"]["DatasetSourceType"] | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the job */ - job_id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["JobDisplayParametersSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - resume_paused_job_api_jobs__job_id__resume_put: { - /** Resumes a paused job. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the job */ - job_id: string; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["JobOutputAssociation"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_libraries_get: { + index_api_tool_data_get: { /** - * Returns a list of summary data for all libraries. - * @description Returns a list of summary data for all libraries. + * Lists all available data tables + * @description Get the list of all available data tables. */ - parameters?: { - /** @description Whether to include deleted libraries in the result. */ - query?: { - /** @description Whether to include deleted libraries in the result. */ - deleted?: boolean | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; responses: { - /** @description Successful Response */ + /** @description A list with details on individual data tables. */ 200: { content: { - "application/json": components["schemas"]["LibrarySummaryList"]; + "application/json": components["schemas"]["ToolDataEntryList"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - create_api_libraries_post: { - /** - * Creates a new library and returns its summary information. - * @description Creates a new library and returns its summary information. Currently, only admin users can create libraries. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibraryPayload"]; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_deleted_api_libraries_deleted_get: { - /** - * Returns a list of summary data for all libraries marked as deleted. - * @description Returns a list of summary data for all libraries marked as deleted. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["LibrarySummaryList"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_from_store_api_libraries_from_store_post: { - /** Create libraries from a model store. */ + create_api_tool_data_post: { + /** Import a data manager bundle */ parameters?: { - /** @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. */ + query?: { + tool_data_file_path?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; @@ -19761,98 +35767,82 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["CreateLibrariesFromStore"]; + "application/json": components["schemas"]["ImportToolDataBundle"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibrarySummary"][]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_api_libraries__id__get: { - /** - * Returns summary information about a particular library. - * @description Returns summary information about a particular library. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Library. */ - id: string; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_libraries__id__delete: { - /** - * Marks the specified library as deleted (or undeleted). - * @description Marks the specified library as deleted (or undeleted). - * Currently, only admin users can delete or restore libraries. - */ - parameters: { - query?: { - /** @description Whether to restore a deleted library. */ - undelete?: boolean | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Library. */ - id: string; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteLibraryPayload"] | null; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_api_libraries__id__patch: { + show_api_tool_data__table_name__get: { /** - * Updates the information of an existing library. - * @description Updates the information of an existing library. + * Get details of a given data table + * @description Get details of a given tool data table. */ parameters: { header?: { @@ -19860,395 +35850,342 @@ export interface operations { "run-as"?: string | null; }; path: { - /** @description The ID of the Library. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryPayload"]; + /** @description The name of the tool data table */ + table_name: string; }; }; responses: { - /** @description Successful Response */ + /** @description A description of the given data table and its content */ 200: { content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": components["schemas"]["ToolDataDetails"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_permissions_api_libraries__id__permissions_get: { - /** - * Gets the current or available permissions of a particular library. - * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. - */ - parameters: { - query?: { - /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ - scope?: components["schemas"]["LibraryPermissionScope"] | null; - /** @description Indicates whether the roles available for the library access are requested. */ - is_library_access?: boolean | null; - /** @description The page number to retrieve when paginating the available roles. */ - page?: number; - /** @description The maximum number of permissions per page when paginating. */ - page_limit?: number; - /** @description Optional search text to retrieve only the roles matching this query. */ - q?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Library. */ - id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": - | components["schemas"]["LibraryCurrentPermissions"] - | components["schemas"]["LibraryAvailablePermissions"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - set_permissions_api_libraries__id__permissions_post: { + delete_api_tool_data__table_name__delete: { /** - * Sets the permissions to access and manipulate a library. - * @description Sets the permissions to access and manipulate a library. + * Removes an item from a data table + * @description Removes an item from a data table and reloads it to return its updated details. */ parameters: { - query?: { - /** @description Indicates what action should be performed on the Library. */ - action?: components["schemas"]["LibraryPermissionAction"] | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Library. */ - id: string; + /** @description The name of the tool data table */ + table_name: string; }; }; requestBody: { content: { - "application/json": - | components["schemas"]["LibraryPermissionsPayload"] - | components["schemas"]["LegacyLibraryPermissionsPayload"]; + "application/json": components["schemas"]["ToolDataItem"]; }; }; responses: { - /** @description Successful Response */ + /** @description A description of the affected data table and its content */ 200: { content: { - "application/json": - | components["schemas"]["LibraryLegacySummary"] - | components["schemas"]["LibraryCurrentPermissions"]; + "application/json": components["schemas"]["ToolDataDetails"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_licenses_get: { - /** - * Lists all available SPDX licenses - * @description Returns an index with all the available [SPDX licenses](https://spdx.org/licenses/). - */ - responses: { - /** @description List of SPDX licenses */ - 200: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": components["schemas"]["LicenseMetadataModel"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_api_licenses__id__get: { - /** - * Gets the SPDX license metadata associated with the short identifier - * @description Returns the license metadata associated with the given - * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). - */ - parameters: { - path: { - /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ - id: unknown; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description SPDX license metadata */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["LicenseMetadataModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - create_api_metrics_post: { - /** - * Records a collection of metrics. - * @description Record any metrics sent and return some status object. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateMetricsPayload"]; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_user_notifications_api_notifications_get: { + show_field_api_tool_data__table_name__fields__field_name__get: { /** - * Returns the list of notifications associated with the user. - * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. - * - * You can use the `limit` and `offset` parameters to paginate through the notifications. + * Get information about a particular field in a tool data table + * @description Reloads a data table and return its details. */ - parameters?: { - query?: { - limit?: number | null; - offset?: number | null; - }; + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The name of the tool data table */ + table_name: string; + /** @description The name of the tool data table field */ + field_name: string; + }; }; responses: { - /** @description Successful Response */ + /** @description Information about a data table field */ 200: { content: { - "application/json": components["schemas"]["UserNotificationListResponse"]; + "application/json": components["schemas"]["ToolDataField"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_user_notifications_api_notifications_put: { - /** Updates a list of notifications with the requested values in a single request. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UserNotificationsBatchUpdateRequest"]; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - send_notification_api_notifications_post: { - /** - * Sends a notification to a list of recipients (users, groups or roles). - * @description Sends a notification to a list of recipients (users, groups or roles). - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["NotificationCreateRequest"]; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": - | components["schemas"]["NotificationCreatedResponse"] - | components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_user_notifications_api_notifications_delete: { - /** Deletes a list of notifications received by the user in a single request. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["NotificationsBatchRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_all_broadcasted_api_notifications_broadcast_get: { + download_field_file_api_tool_data__table_name__fields__field_name__files__file_name__get: { /** - * Returns all currently active broadcasted notifications. - * @description Only Admin users can access inactive notifications (scheduled or recently expired). + * Get information about a particular field in a tool data table + * @description Download a file associated with the data table field. */ - parameters?: { - /** @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. */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The name of the tool data table */ + table_name: string; + /** @description The name of the tool data table field */ + field_name: string; + /** @description The name of a file associated with this data table field */ + file_name: string; + }; }; responses: { - /** @description Successful Response */ - 200: { + /** @description Information about a data table field */ + 200: never; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { - "application/json": components["schemas"]["BroadcastNotificationListResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - broadcast_notification_api_notifications_broadcast_post: { - /** - * Broadcasts a notification to every user in the system. - * @description Broadcasted notifications are a special kind of notification that are always accessible to all users, including anonymous users. - * They are typically used to display important information such as maintenance windows or new features. - * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. - * - * Broadcasted notifications can include action links that are displayed as buttons. - * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. - * - * Some key features of broadcasted notifications include: - * - They are not associated with a specific user, so they cannot be deleted or marked as read. - * - They can be scheduled to be displayed in the future or to expire after a certain time. - * - By default, broadcasted notifications are published immediately and expire six months after publication. - * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["BroadcastNotificationCreateRequest"]; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["NotificationCreatedResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - get_broadcasted_api_notifications_broadcast__notification_id__get: { + reload_api_tool_data__table_name__reload_get: { /** - * Returns the information of a specific broadcasted notification. - * @description Only Admin users can access inactive notifications (scheduled or recently expired). + * Reloads a tool data table + * @description Reloads a data table and return its details. */ parameters: { header?: { @@ -20256,242 +36193,174 @@ export interface operations { "run-as"?: string | null; }; path: { - /** @description The ID of the Notification. */ - notification_id: string; + /** @description The name of the tool data table */ + table_name: string; }; }; responses: { - /** @description Successful Response */ + /** @description A description of the reloaded data table and its content */ 200: { content: { - "application/json": components["schemas"]["BroadcastNotificationResponse"]; + "application/json": components["schemas"]["ToolDataDetails"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_broadcasted_notification_api_notifications_broadcast__notification_id__put: { - /** - * Updates the state of a broadcasted notification. - * @description Only Admins can update broadcasted notifications. This is useful to reschedule, edit or expire broadcasted notifications. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["NotificationBroadcastUpdateRequest"]; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 204: never; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_notification_preferences_api_notifications_preferences_get: { - /** - * Returns the current user's preferences for notifications. - * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. - * - * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. - * The supported channels are returned in the `supported-channels` header. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["UserNotificationPreferences"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_notification_preferences_api_notifications_preferences_put: { - /** - * Updates the user's preferences for notifications. - * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. - * - * - Can be used to completely enable/disable notifications for a particular type (category) - * or to enable/disable a particular channel on each category. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateUserNotificationPreferencesRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["UserNotificationPreferences"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_notifications_status_api_notifications_status_get: { - /** - * Returns the current status summary of the user's notifications since a particular date. - * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. - */ - parameters: { - query: { - since: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; + index_api_tool_shed_repositories_get: { + /** Lists installed tool shed repositories. */ + parameters?: { + /** @description Filter by repository name. */ + /** @description Filter by repository owner. */ + /** @description Filter by changeset revision. */ + /** @description Filter by whether the repository has been deleted. */ + /** @description Filter by whether the repository has been uninstalled. */ + query?: { + /** @description Filter by repository name. */ + name?: string | null; + /** @description Filter by repository owner. */ + owner?: string | null; + /** @description Filter by changeset revision. */ + changeset?: string | null; + /** @description Filter by whether the repository has been deleted. */ + deleted?: boolean | null; + /** @description Filter by whether the repository has been uninstalled. */ + uninstalled?: boolean | null; }; }; responses: { - /** @description Successful Response */ + /** @description A list of installed tool shed repository objects. */ 200: { content: { - "application/json": components["schemas"]["NotificationStatusSummary"]; + "application/json": components["schemas"]["InstalledToolShedRepository"][]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_notification_api_notifications__notification_id__get: { - /** Displays information about a notification received by the user. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["UserNotificationResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_user_notification_api_notifications__notification_id__put: { - /** Updates the state of a notification received by the user. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UserNotificationUpdateRequest"]; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 204: never; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_user_notification_api_notifications__notification_id__delete: { - /** - * Deletes a notification received by the user. - * @description When a notification is deleted, it is not immediately removed from the database, but marked as deleted. - * - * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. - * - It will be eventually removed from the database by a background task after the expiration time. - * - Deleted notifications will be permanently deleted when the expiration time is reached. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 204: never; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_object_stores_get: { - /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ + check_for_updates_api_tool_shed_repositories_check_for_updates_get: { + /** Check for updates to the specified repository, or all installed repositories. */ parameters?: { - /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ query?: { - /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ - selectable?: boolean; + id?: string | null; }; header?: { /** @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. */ @@ -20499,131 +36368,153 @@ export interface operations { }; }; responses: { - /** @description A list of the configured object stores. */ + /** @description A description of the state and updates message. */ 200: { content: { - "application/json": components["schemas"]["ConcreteObjectStoreModel"][]; + "application/json": components["schemas"]["CheckForUpdatesResponse"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_info_api_object_stores__object_store_id__get: { - /** Get information about a concrete object store configured with Galaxy. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The concrete object store ID. */ - object_store_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["ConcreteObjectStoreModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_pages_get: { - /** - * Lists all Pages viewable by the user. - * @description Get a list with summary information of all Pages available to the user. - */ - parameters?: { - /** @description Whether to include deleted pages in the result. */ - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `title` - * : The page's title. - * - * `slug` - * : The page's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The page's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `user` - * : The page's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Pages: `title`, `slug`, `tag`, `user`. - */ - /** @description Sort page index by this specified attribute on the page model */ - /** @description Sort in descending order? */ - query?: { - deleted?: boolean; - limit?: number; - offset?: number; - search?: string | null; - show_own?: boolean; - show_published?: boolean; - show_shared?: boolean; - /** @description Sort page index by this specified attribute on the page model */ - sort_by?: "create_time" | "title" | "update_time" | "username"; - /** @description Sort in descending order? */ - sort_desc?: boolean; - user_id?: string | null; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_api_tool_shed_repositories__id__get: { + /** Show installed tool shed repository. */ + parameters: { + path: { + /** @description The encoded database identifier of the installed Tool Shed Repository. */ + id: string; }; }; responses: { - /** @description A list with summary page information. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["PageSummaryList"]; + "application/json": components["schemas"]["InstalledToolShedRepository"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - create_api_pages_post: { - /** - * Create a page and return summary information. - * @description Get a list with details of all Pages available to the user. - */ + fetch_form_api_tools_fetch_post: { + /** Upload files to Galaxy */ parameters?: { /** @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?: { @@ -20633,182 +36524,235 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["CreatePagePayload"]; + "multipart/form-data": components["schemas"]["Body_fetch_form_api_tools_fetch_post"]; }; }; responses: { - /** @description The page summary information. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["PageSummary"]; + "application/json": Record; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_api_pages__id__get: { - /** - * Return a page summary and the content of the last revision. - * @description Return summary information about a specific Page and the content of the last revision. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Page. */ - id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description The page summary information. */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["PageDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_pages__id__delete: { - /** - * Marks the specific Page as deleted. - * @description Marks the Page with the given ID as deleted. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Page. */ - id: string; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 204: never; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - show_pdf_api_pages__id__pdf_get: { + index_api_tours_get: { /** - * Return a PDF document of the last revision of the Page. - * @description Return a PDF document of the last revision of the Page. - * - * This feature may not be available in this Galaxy. + * Index + * @description Return list of available tours. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; responses: { - /** @description PDF document with the last revision of the page. */ + /** @description Successful Response */ 200: { content: { - "application/pdf": unknown; + "application/json": components["schemas"]["TourList"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description PDF conversion service not available. */ + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ 501: { - content: never; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; }; }; - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ - disable_link_access_api_pages__id__disable_link_access_put: { + show_api_tours__tour_id__get: { + /** + * Show + * @description Return a tour definition. + */ parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; path: { - /** @description The ID of the Page. */ - id: string; + tour_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["TourDetails"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - enable_link_access_api_pages__id__enable_link_access_put: { - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Page. */ - id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - prepare_pdf_api_pages__id__prepare_download_post: { + update_tour_api_tours__tour_id__post: { /** - * Return a PDF document of the last revision of the Page. - * @description Return a STS download link for this page to be downloaded as a PDF. - * - * This feature may not be available in this Galaxy. + * Update Tour + * @description Return a tour definition. */ parameters: { header?: { @@ -20816,242 +36760,266 @@ export interface operations { "run-as"?: string | null; }; path: { - /** @description The ID of the Page. */ - id: string; + tour_id: string; }; }; responses: { - /** @description Short term storage reference for async monitoring of this download. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": components["schemas"]["TourDetails"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description PDF conversion service not available. */ - 501: { - content: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - }; - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ - publish_api_pages__id__publish_put: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Page. */ - id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - share_with_users_api_pages__id__share_with_users_put: { + get_users_api_users_get: { /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. + * Get Users + * @description Return a collection of users. Filters will only work if enabled in config or user is admin. */ - parameters: { + parameters?: { + /** @description Indicates if the collection will be about deleted users */ + /** @description An email address to filter on */ + /** @description An username address to filter on */ + /** @description Filter on username OR email */ + query?: { + /** @description Indicates if the collection will be about deleted users */ + deleted?: boolean; + /** @description An email address to filter on */ + f_email?: string | null; + /** @description An username address to filter on */ + f_name?: string | null; + /** @description Filter on username OR email */ + f_any?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ShareWithPayload"]; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ShareWithStatus"]; + "application/json": ( + | components["schemas"]["UserModel"] + | components["schemas"]["LimitedUserModel"] + )[]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - sharing_api_pages__id__sharing_get: { - /** - * Get the current sharing status of the given Page. - * @description Return the sharing status of the item. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Page. */ - id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - set_slug_api_pages__id__slug_put: { - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ - parameters: { + create_user_api_users_post: { + /** Create a new Galaxy user. Only admins can create users for now. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Page. */ - id: string; - }; }; requestBody: { content: { - "application/json": components["schemas"]["SetSlugPayload"]; + "application/json": + | components["schemas"]["UserCreationPayload"] + | components["schemas"]["RemoteUserCreationPayload"]; }; }; responses: { /** @description Successful Response */ - 204: never; - /** @description Bad Request */ - 422: { + 200: { + content: { + "application/json": components["schemas"]["CreatedUserModel"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - undelete_api_pages__id__undelete_put: { - /** - * Undelete the specific Page. - * @description Marks the Page with the given ID as undeleted. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Page. */ - id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 204: never; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - unpublish_api_pages__id__unpublish_put: { - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Page. */ - id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_quotas_get: { - /** - * Displays a list with information of quotas that are currently active. - * @description Displays a list with information of quotas that are currently active. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["QuotaSummaryList"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_api_quotas_post: { + recalculate_disk_usage_api_users_current_recalculate_disk_usage_put: { /** - * Creates a new quota. - * @description Creates a new quota. + * Triggers a recalculation of the current user disk usage. + * @description This route will be removed in a future version. + * + * Please use `/api/users/current/recalculate_disk_usage` instead. */ parameters?: { /** @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. */ @@ -21060,380 +37028,343 @@ export interface operations { "run-as"?: string | null; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateQuotaParams"]; - }; - }; responses: { - /** @description Successful Response */ + /** @description The asynchronous task summary to track the task state. */ 200: { content: { - "application/json": components["schemas"]["CreateQuotaResult"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_deleted_api_quotas_deleted_get: { - /** - * Displays a list with information of quotas that have been deleted. - * @description Displays a list with information of quotas that have been deleted. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description The background task was submitted but there is no status tracking ID available. */ + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["QuotaSummaryList"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - deleted_quota_api_quotas_deleted__id__get: { - /** - * Displays details on a particular quota that has been deleted. - * @description Displays details on a particular quota that has been deleted. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Quota. */ - id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["QuotaDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - undelete_api_quotas_deleted__id__undelete_post: { + get_deleted_users_api_users_deleted_get: { /** - * Restores a previously deleted quota. - * @description Restores a previously deleted quota. + * Get Deleted Users + * @description Return a collection of deleted users. Only admins can see deleted users. */ - parameters: { + parameters?: { + /** @description An email address to filter on */ + /** @description An username address to filter on */ + /** @description Filter on username OR email */ + query?: { + /** @description An email address to filter on */ + f_email?: string | null; + /** @description An username address to filter on */ + f_name?: string | null; + /** @description Filter on username OR email */ + f_any?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Quota. */ - id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": string; + "application/json": ( + | components["schemas"]["UserModel"] + | components["schemas"]["LimitedUserModel"] + )[]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - quota_api_quotas__id__get: { - /** - * Displays details on a particular active quota. - * @description Displays details on a particular active quota. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Quota. */ - id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["QuotaDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_api_quotas__id__put: { - /** - * Updates an existing quota. - * @description Updates an existing quota. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Quota. */ - id: string; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateQuotaParams"]; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": string; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - delete_api_quotas__id__delete: { - /** - * Deletes an existing quota. - * @description Deletes an existing quota. - */ + get_deleted_user_api_users_deleted__user_id__get: { + /** Return information about a deleted user. Only admins can see deleted users. */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Quota. */ - id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteQuotaPayload"]; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": string; + "application/json": + | components["schemas"]["DetailedUserModel"] + | components["schemas"]["AnonUserModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - purge_api_quotas__id__purge_post: { - /** Purges a previously deleted quota. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the Quota. */ - id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": string; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_remote_files_get: { - /** - * Displays remote files available to the user. - * @description Lists all remote files available to the user from different sources. - */ - parameters?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - query?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - target?: string; - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - format?: components["schemas"]["RemoteFilesFormat"] | null; - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - recursive?: boolean | null; - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - disable?: components["schemas"]["RemoteFilesDisableMode"] | null; - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - writeable?: boolean | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description A list with details about the remote files available to the user. */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": - | components["schemas"]["ListUriResponse"] - | components["schemas"]["ListJstreeResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_entry_api_remote_files_post: { - /** - * Creates a new entry (directory/record) on the remote files source. - * @description Creates a new entry on the remote files source. - */ - parameters?: { - /** @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. */ + undelete_user_api_users_deleted__user_id__undelete_post: { + /** Restore a deleted user. Only admins can restore users. */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateEntryPayload"]; + path: { + /** @description The ID of the user. */ + user_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["CreatedEntryResponse"]; + "application/json": components["schemas"]["DetailedUserModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - plugins_api_remote_files_plugins_get: { - /** - * Display plugin information for each of the gxfiles:// URI targets available. - * @description Display plugin information for each of the gxfiles:// URI targets available. - */ - parameters?: { - /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ - /** @description Whether to return **only** filesources of the specified kind. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ - /** @description Whether to exclude filesources of the specified kind from the list. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ - query?: { - /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ - browsable_only?: boolean | null; - /** @description Whether to return **only** filesources of the specified kind. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ - include_kind?: components["schemas"]["PluginKind"][] | null; - /** @description Whether to exclude filesources of the specified kind from the list. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ - exclude_kind?: components["schemas"]["PluginKind"][] | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description A list with details about each plugin. */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["FilesSourcePluginList"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_roles_get: { - /** Index */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["RoleListResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - create_api_roles_post: { - /** Create */ + recalculate_disk_usage_api_users_recalculate_disk_usage_put: { + /** + * Triggers a recalculation of the current user disk usage. + * @deprecated + * @description This route will be removed in a future version. + * + * Please use `/api/users/current/recalculate_disk_usage` instead. + */ parameters?: { /** @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?: { @@ -21441,836 +37372,667 @@ export interface operations { "run-as"?: string | null; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["RoleDefinitionModel"]; - }; - }; responses: { - /** @description Successful Response */ + /** @description The asynchronous task summary to track the task state. */ 200: { content: { - "application/json": components["schemas"]["RoleModelResponse"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_api_roles__id__get: { - /** Show */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - id: string; + /** @description The background task was submitted but there is no status tracking ID available. */ + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["RoleModelResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_roles__id__delete: { - /** Delete */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["RoleModelResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - purge_api_roles__id__purge_post: { - /** Purge */ + get_user_api_users__user_id__get: { + /** Return information about a specified or the current user. Only admin can see deleted or other users */ parameters: { + query?: { + /** @description Indicates if the user is deleted */ + deleted?: boolean | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - id: string; + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["RoleModelResponse"]; + "application/json": + | components["schemas"]["DetailedUserModel"] + | components["schemas"]["AnonUserModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - undelete_api_roles__id__undelete_post: { - /** Undelete */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["RoleModelResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - serve_api_short_term_storage__storage_request_id__get: { - /** Serve the staged download specified by request ID. */ - parameters: { - path: { - storage_request_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description The archive file containing the History. */ - 200: { - content: never; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - /** @description Request was cancelled without an exception condition recorded. */ - 204: never; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - is_ready_api_short_term_storage__storage_request_id__ready_get: { - /** Determine if specified storage request ID is ready for download. */ - parameters: { - path: { - storage_request_id: string; - }; - }; - responses: { - /** @description Boolean indicating if the storage is ready. */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": boolean; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - cleanup_datasets_api_storage_datasets_delete: { - /** - * Purges a set of datasets by ID from disk. The datasets must be owned by the user. - * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. - */ - parameters?: { - /** @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. */ + update_user_api_users__user_id__put: { + /** Update the values of a user. Only admin can update others. */ + parameters: { + query?: { + /** @description Indicates if the user is deleted */ + deleted?: boolean | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; + }; }; requestBody: { content: { - "application/json": components["schemas"]["CleanupStorageItemsRequest"]; + "application/json": Record; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["StorageItemsCleanupResult"]; + "application/json": components["schemas"]["DetailedUserModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - discarded_datasets_api_storage_datasets_discarded_get: { - /** Returns discarded datasets owned by the given user. The results can be paginated. */ - parameters?: { - /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ - query?: { - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ - order?: components["schemas"]["StoredItemOrderBy"] | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["StoredItem"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - discarded_datasets_summary_api_storage_datasets_discarded_summary_get: { - /** Returns information with the total storage space taken by discarded datasets owned by the given user. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["CleanableItemsSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - cleanup_histories_api_storage_histories_delete: { - /** - * Purges a set of histories by ID. The histories must be owned by the user. - * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. - */ - parameters?: { + delete_user_api_users__user_id__delete: { + /** Delete a user. Only admins can delete others or purge users. */ + parameters: { /** @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?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["CleanupStorageItemsRequest"]; + "application/json": components["schemas"]["UserDeletionPayload"] | null; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["StorageItemsCleanupResult"]; + "application/json": components["schemas"]["DetailedUserModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - archived_histories_api_storage_histories_archived_get: { - /** Returns archived histories owned by the given user that are not purged. The results can be paginated. */ - parameters?: { - /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ - query?: { - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ - order?: components["schemas"]["StoredItemOrderBy"] | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["StoredItem"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - archived_histories_summary_api_storage_histories_archived_summary_get: { - /** Returns information with the total storage space taken by non-purged archived histories associated with the given user. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["CleanableItemsSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - discarded_histories_api_storage_histories_discarded_get: { - /** Returns all discarded histories associated with the given user. */ - parameters?: { - /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ - query?: { - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ - order?: components["schemas"]["StoredItemOrderBy"] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["StoredItem"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - discarded_histories_summary_api_storage_histories_discarded_summary_get: { - /** Returns information with the total storage space taken by discarded histories associated with the given user. */ - parameters?: { - /** @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. */ + get_or_create_api_key_api_users__user_id__api_key_get: { + /** Return the user's API key */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["CleanableItemsSummary"]; + "application/json": string; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - update_api_tags_put: { - /** - * Apply a new set of tags to an item. - * @description Replaces the tags associated with an item with the new ones specified in the payload. - * - * - The previous tags will be __deleted__. - * - If no tags are provided in the request body, the currently associated tags will also be __deleted__. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsPayload"]; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 204: never; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - state_api_tasks__task_id__state_get: { - /** Determine state of task ID */ - parameters: { - path: { - task_id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description String indicating task state. */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["TaskState"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_tool_data_get: { - /** - * Lists all available data tables - * @description Get the list of all available data tables. - */ - responses: { - /** @description A list with details on individual data tables. */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["ToolDataEntryList"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - create_api_tool_data_post: { - /** Import a data manager bundle */ - parameters?: { - query?: { - tool_data_file_path?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ImportToolDataBundle"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_api_tool_data__table_name__get: { - /** - * Get details of a given data table - * @description Get details of a given tool data table. - */ + create_api_key_api_users__user_id__api_key_post: { + /** Create a new API key for the user */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The name of the tool data table */ - table_name: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { - /** @description A description of the given data table and its content */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ToolDataDetails"]; + "application/json": string; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_tool_data__table_name__delete: { - /** - * Removes an item from a data table - * @description Removes an item from a data table and reloads it to return its updated details. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The name of the tool data table */ - table_name: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ToolDataItem"]; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description A description of the affected data table and its content */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["ToolDataDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_field_api_tool_data__table_name__fields__field_name__get: { - /** - * Get information about a particular field in a tool data table - * @description Reloads a data table and return its details. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The name of the tool data table */ - table_name: string; - /** @description The name of the tool data table field */ - field_name: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Information about a data table field */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["ToolDataField"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - download_field_file_api_tool_data__table_name__fields__field_name__files__file_name__get: { - /** - * Get information about a particular field in a tool data table - * @description Download a file associated with the data table field. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The name of the tool data table */ - table_name: string; - /** @description The name of the tool data table field */ - field_name: string; - /** @description The name of a file associated with this data table field */ - file_name: string; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Information about a data table field */ - 200: never; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - reload_api_tool_data__table_name__reload_get: { - /** - * Reloads a tool data table - * @description Reloads a data table and return its details. - */ + delete_api_key_api_users__user_id__api_key_delete: { + /** Delete the current API key of the user */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The name of the tool data table */ - table_name: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { - /** @description A description of the reloaded data table and its content */ - 200: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { - "application/json": components["schemas"]["ToolDataDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Successful Response */ + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_tool_shed_repositories_get: { - /** Lists installed tool shed repositories. */ - parameters?: { - /** @description Filter by repository name. */ - /** @description Filter by repository owner. */ - /** @description Filter by changeset revision. */ - /** @description Filter by whether the repository has been deleted. */ - /** @description Filter by whether the repository has been uninstalled. */ - query?: { - /** @description Filter by repository name. */ - name?: string | null; - /** @description Filter by repository owner. */ - owner?: string | null; - /** @description Filter by changeset revision. */ - changeset?: string | null; - /** @description Filter by whether the repository has been deleted. */ - deleted?: boolean | null; - /** @description Filter by whether the repository has been uninstalled. */ - uninstalled?: boolean | null; - }; - }; - responses: { - /** @description A list of installed tool shed repository objects. */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["InstalledToolShedRepository"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - check_for_updates_api_tool_shed_repositories_check_for_updates_get: { - /** Check for updates to the specified repository, or all installed repositories. */ - parameters?: { - query?: { - id?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description A description of the state and updates message. */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["CheckForUpdatesResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_api_tool_shed_repositories__id__get: { - /** Show installed tool shed repository. */ - parameters: { - path: { - /** @description The encoded database identifier of the installed Tool Shed Repository. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["InstalledToolShedRepository"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - fetch_form_api_tools_fetch_post: { - /** Upload files to Galaxy */ - parameters?: { - /** @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. */ + get_api_key_detailed_api_users__user_id__api_key_detailed_get: { + /** Return the user's API key with extra information. */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "multipart/form-data": components["schemas"]["Body_fetch_form_api_tools_fetch_post"]; + path: { + /** @description The ID of the user. */ + user_id: string; }; }; responses: { - /** @description Successful Response */ + /** @description The API key of the user. */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["APIKeyModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - index_api_tours_get: { - /** - * Index - * @description Return list of available tours. - */ - responses: { - /** @description Successful Response */ - 200: { + /** @description The user doesn't have an API key. */ + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": components["schemas"]["TourList"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_api_tours__tour_id__get: { - /** - * Show - * @description Return a tour definition. - */ - parameters: { - path: { - tour_id: string; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["TourDetails"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - update_tour_api_tours__tour_id__post: { + get_beacon_settings_api_users__user_id__beacon_get: { /** - * Update Tour - * @description Return a tour definition. + * Return information about beacon share settings + * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. */ parameters: { header?: { @@ -22278,200 +38040,170 @@ export interface operations { "run-as"?: string | null; }; path: { - tour_id: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["TourDetails"]; + "application/json": components["schemas"]["UserBeaconSetting"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_users_api_users_get: { - /** - * Get Users - * @description Return a collection of users. Filters will only work if enabled in config or user is admin. - */ - parameters?: { - /** @description Indicates if the collection will be about deleted users */ - /** @description An email address to filter on */ - /** @description An username address to filter on */ - /** @description Filter on username OR email */ - query?: { - /** @description Indicates if the collection will be about deleted users */ - deleted?: boolean; - /** @description An email address to filter on */ - f_email?: string | null; - /** @description An username address to filter on */ - f_name?: string | null; - /** @description Filter on username OR email */ - f_any?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": ( - | components["schemas"]["UserModel"] - | components["schemas"]["LimitedUserModel"] - )[]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - create_user_api_users_post: { - /** Create a new Galaxy user. Only admins can create users for now. */ - parameters?: { - /** @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. */ + set_beacon_settings_api_users__user_id__beacon_post: { + /** + * Change beacon setting + * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. + */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; }; requestBody: { content: { - "application/json": - | components["schemas"]["UserCreationPayload"] - | components["schemas"]["RemoteUserCreationPayload"]; + "application/json": components["schemas"]["UserBeaconSetting"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["CreatedUserModel"]; + "application/json": components["schemas"]["UserBeaconSetting"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - recalculate_disk_usage_api_users_current_recalculate_disk_usage_put: { - /** - * Triggers a recalculation of the current user disk usage. - * @description This route will be removed in a future version. - * - * Please use `/api/users/current/recalculate_disk_usage` instead. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description The asynchronous task summary to track the task state. */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description The background task was submitted but there is no status tracking ID available. */ - 204: never; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_deleted_users_api_users_deleted_get: { - /** - * Get Deleted Users - * @description Return a collection of deleted users. Only admins can see deleted users. - */ - parameters?: { - /** @description An email address to filter on */ - /** @description An username address to filter on */ - /** @description Filter on username OR email */ - query?: { - /** @description An email address to filter on */ - f_email?: string | null; - /** @description An username address to filter on */ - f_name?: string | null; - /** @description Filter on username OR email */ - f_any?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": ( - | components["schemas"]["UserModel"] - | components["schemas"]["LimitedUserModel"] - )[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_deleted_user_api_users_deleted__user_id__get: { - /** Return information about a deleted user. Only admins can see deleted users. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the user. */ - user_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": - | components["schemas"]["DetailedUserModel"] - | components["schemas"]["AnonUserModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - undelete_user_api_users_deleted__user_id__undelete_post: { - /** Restore a deleted user. Only admins can restore users. */ + get_custom_builds_api_users__user_id__custom_builds_get: { + /** Returns collection of custom builds. */ parameters: { header?: { /** @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. */ @@ -22486,180 +38218,161 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DetailedUserModel"]; + "application/json": components["schemas"]["CustomBuildsCollection"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - recalculate_disk_usage_api_users_recalculate_disk_usage_put: { - /** - * Triggers a recalculation of the current user disk usage. - * @deprecated - * @description This route will be removed in a future version. - * - * Please use `/api/users/current/recalculate_disk_usage` instead. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description The asynchronous task summary to track the task state. */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description The background task was submitted but there is no status tracking ID available. */ - 204: never; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_user_api_users__user_id__get: { - /** Return information about a specified or the current user. Only admin can see deleted or other users */ - parameters: { - query?: { - /** @description Indicates if the user is deleted */ - deleted?: boolean | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": - | components["schemas"]["DetailedUserModel"] - | components["schemas"]["AnonUserModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_user_api_users__user_id__put: { - /** Update the values of a user. Only admin can update others. */ + add_custom_builds_api_users__user_id__custom_builds__key__put: { + /** Add new custom build. */ parameters: { - query?: { - /** @description Indicates if the user is deleted */ - deleted?: boolean | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; + /** @description The ID of the user. */ + user_id: string; + /** @description The key of the custom build to be deleted. */ + key: string; }; }; requestBody: { content: { - "application/json": Record; + "application/json": components["schemas"]["CustomBuildCreationPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DetailedUserModel"]; + "application/json": Record; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_user_api_users__user_id__delete: { - /** Delete a user. Only admins can delete others or purge users. */ - parameters: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the user. */ - user_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["UserDeletionPayload"] | null; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["DetailedUserModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_or_create_api_key_api_users__user_id__api_key_get: { - /** Return the user's API key */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the user. */ - user_id: string; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": string; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_api_key_api_users__user_id__api_key_post: { - /** Create a new API key for the user */ + delete_custom_build_api_users__user_id__custom_builds__key__delete: { + /** Delete a custom build */ parameters: { header?: { /** @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. */ @@ -22668,110 +38381,81 @@ export interface operations { path: { /** @description The ID of the user. */ user_id: string; + /** @description The key of the custom build to be deleted. */ + key: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": string; + "application/json": components["schemas"]["DeletedCustomBuild"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_api_key_api_users__user_id__api_key_delete: { - /** Delete the current API key of the user */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the user. */ - user_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 204: never; - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_api_key_detailed_api_users__user_id__api_key_detailed_get: { - /** Return the user's API key with extra information. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the user. */ - user_id: string; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description The API key of the user. */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["APIKeyModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description The user doesn't have an API key. */ - 204: never; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_beacon_settings_api_users__user_id__beacon_get: { - /** - * Return information about beacon share settings - * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the user. */ - user_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["UserBeaconSetting"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - set_beacon_settings_api_users__user_id__beacon_post: { - /** - * Change beacon setting - * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. - */ + set_favorite_api_users__user_id__favorites__object_type__put: { + /** Add the object to user's favorites */ parameters: { header?: { /** @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. */ @@ -22780,120 +38464,86 @@ export interface operations { path: { /** @description The ID of the user. */ user_id: string; + /** @description The object type the user wants to favorite */ + object_type: components["schemas"]["FavoriteObjectType"]; }; }; requestBody: { content: { - "application/json": components["schemas"]["UserBeaconSetting"]; + "application/json": components["schemas"]["FavoriteObject"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserBeaconSetting"]; + "application/json": components["schemas"]["FavoriteObjectsSummary"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - get_custom_builds_api_users__user_id__custom_builds_get: { - /** Returns collection of custom builds. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the user. */ - user_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": components["schemas"]["CustomBuildsCollection"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - add_custom_builds_api_users__user_id__custom_builds__key__put: { - /** Add new custom build. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The key of the custom build to be deleted. */ - key: string; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CustomBuildCreationPayload"]; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": Record; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - delete_custom_build_api_users__user_id__custom_builds__key__delete: { - /** Delete a custom build */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The key of the custom build to be deleted. */ - key: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["DeletedCustomBuild"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - set_favorite_api_users__user_id__favorites__object_type__put: { - /** Add the object to user's favorites */ + remove_favorite_api_users__user_id__favorites__object_type___object_id__delete: { + /** Remove the object from user's favorites */ parameters: { header?: { /** @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. */ @@ -22904,11 +38554,8 @@ export interface operations { user_id: string; /** @description The object type the user wants to favorite */ object_type: components["schemas"]["FavoriteObjectType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["FavoriteObject"]; + /** @description The ID of an object the user wants to remove from favorites */ + object_id: string; }; }; responses: { @@ -22918,43 +38565,66 @@ export interface operations { "application/json": components["schemas"]["FavoriteObjectsSummary"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - remove_favorite_api_users__user_id__favorites__object_type___object_id__delete: { - /** Remove the object from user's favorites */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The object type the user wants to favorite */ - object_type: components["schemas"]["FavoriteObjectType"]; - /** @description The ID of an object the user wants to remove from favorites */ - object_id: string; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": components["schemas"]["FavoriteObjectsSummary"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_user_objectstore_usage_api_users__user_id__objectstore_usage_get: { @@ -22976,12 +38646,66 @@ export interface operations { "application/json": components["schemas"]["UserObjectstoreUsage"][]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; recalculate_disk_usage_by_user_id_api_users__user_id__recalculate_disk_usage_put: { @@ -23003,14 +38727,68 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description The background task was submitted but there is no status tracking ID available. */ 204: never; - /** @description Bad Request */ + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; send_activation_email_api_users__user_id__send_activation_email_post: { @@ -23032,12 +38810,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; set_theme_api_users__user_id__theme__theme__put: { @@ -23061,12 +38893,66 @@ export interface operations { "application/json": string; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_user_usage_api_users__user_id__usage_get: { @@ -23080,16 +38966,70 @@ export interface operations { /** @description The ID of the user to get or 'current'. */ user_id: string | "current"; }; - }; - responses: { - /** @description Successful Response */ - 200: { + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["UserQuotaUsage"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["UserQuotaUsage"][]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -23117,12 +39057,66 @@ export interface operations { "application/json": components["schemas"]["UserQuotaUsage"] | null; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; version_api_version_get: { @@ -23137,12 +39131,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; index_api_visualizations_get: { @@ -23213,12 +39261,66 @@ export interface operations { "application/json": components["schemas"]["VisualizationSummaryList"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; disable_link_access_api_visualizations__id__disable_link_access_put: { @@ -23243,12 +39345,66 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; enable_link_access_api_visualizations__id__enable_link_access_put: { @@ -23270,41 +39426,149 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["SharingStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + publish_api_visualizations__id__publish_put: { + /** + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Visualization. */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["SharingStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - publish_api_visualizations__id__publish_put: { - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Visualization. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -23338,12 +39602,66 @@ export interface operations { "application/json": components["schemas"]["ShareWithStatus"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; sharing_api_visualizations__id__sharing_get: { @@ -23368,12 +39686,66 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; set_slug_api_visualizations__id__slug_put: { @@ -23397,14 +39769,68 @@ export interface operations { }; }; responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Successful Response */ 204: never; - /** @description Bad Request */ + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; unpublish_api_visualizations__id__unpublish_put: { @@ -23429,12 +39855,66 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; whoami_api_whoami_get: { @@ -23456,12 +39936,66 @@ export interface operations { "application/json": components["schemas"]["UserModel"] | null; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; index_api_workflows_get: { @@ -23541,12 +40075,66 @@ export interface operations { "application/json": Record[]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_workflow_menu_api_workflows_menu_get: { @@ -23577,12 +40165,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_workflow_api_workflows__workflow_id__get: { @@ -23611,12 +40253,66 @@ export interface operations { "application/json": components["schemas"]["StoredWorkflowDetailed"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; delete_workflow_api_workflows__workflow_id__delete: { @@ -23638,12 +40334,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; workflows__invocation_counts: { @@ -23669,12 +40419,66 @@ export interface operations { "application/json": components["schemas"]["RootModel_Dict_str__int__"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; disable_link_access_api_workflows__workflow_id__disable_link_access_put: { @@ -23699,12 +40503,66 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; enable_link_access_api_workflows__workflow_id__enable_link_access_put: { @@ -23729,12 +40587,66 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; index_invocations_api_workflows__workflow_id__invocations_get: { @@ -23777,15 +40689,69 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"][]; + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; Invoke_workflow_api_workflows__workflow_id__invocations_post: { @@ -23814,12 +40780,66 @@ export interface operations { | components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__get: { @@ -23857,12 +40877,66 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; cancel_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__delete: { @@ -23900,12 +40974,66 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; workflow_invocation_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__jobs_summary_get: { @@ -23932,12 +41060,66 @@ export interface operations { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_workflow_invocation_report_api_workflows__workflow_id__invocations__invocation_id__report_get: { @@ -23961,39 +41143,147 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationReport"]; + "application/json": components["schemas"]["InvocationReport"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_workflow_invocation_report_pdf_api_workflows__workflow_id__invocations__invocation_id__report_pdf_get: { + /** + * Get PDF summarizing invocation for reporting. + * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: never; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - show_workflow_invocation_report_pdf_api_workflows__workflow_id__invocations__invocation_id__report_pdf_get: { - /** - * Get PDF summarizing invocation for reporting. - * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -24028,12 +41318,66 @@ export interface operations { )[]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__get: { @@ -24062,12 +41406,66 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; update_workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__put: { @@ -24101,12 +41499,66 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; publish_api_workflows__workflow_id__publish_put: { @@ -24131,12 +41583,66 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; refactor_api_workflows__workflow_id__refactor_put: { @@ -24166,12 +41672,66 @@ export interface operations { "application/json": components["schemas"]["RefactorResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; share_with_users_api_workflows__workflow_id__share_with_users_put: { @@ -24198,11 +41758,65 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ShareWithStatus"]; + "application/json": components["schemas"]["ShareWithStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -24231,12 +41845,66 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; set_slug_api_workflows__workflow_id__slug_put: { @@ -24260,14 +41928,68 @@ export interface operations { }; }; responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description Successful Response */ 204: never; - /** @description Bad Request */ + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; index_api_workflows__workflow_id__tags_get: { @@ -24288,12 +42010,66 @@ export interface operations { "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_api_workflows__workflow_id__tags__tag_name__get: { @@ -24315,12 +42091,66 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; update_api_workflows__workflow_id__tags__tag_name__put: { @@ -24344,43 +42174,151 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["ItemTagsResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_api_workflows__workflow_id__tags__tag_name__post: { + /** Create tag based on workflow_id */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + workflow_id: string; + tag_name: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ItemTagsResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - create_api_workflows__workflow_id__tags__tag_name__post: { - /** Create tag based on workflow_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - workflow_id: string; - tag_name: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; @@ -24406,12 +42344,66 @@ export interface operations { "application/json": boolean; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; undelete_workflow_api_workflows__workflow_id__undelete_post: { @@ -24433,12 +42425,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; unpublish_api_workflows__workflow_id__unpublish_put: { @@ -24463,12 +42509,66 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; index_invocations_api_workflows__workflow_id__usage_get: { @@ -24517,12 +42617,66 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; Invoke_workflow_api_workflows__workflow_id__usage_post: { @@ -24554,12 +42708,66 @@ export interface operations { | components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_workflow_invocation_api_workflows__workflow_id__usage__invocation_id__get: { @@ -24598,12 +42806,66 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; cancel_workflow_invocation_api_workflows__workflow_id__usage__invocation_id__delete: { @@ -24642,12 +42904,66 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; workflow_invocation_jobs_summary_api_workflows__workflow_id__usage__invocation_id__jobs_summary_get: { @@ -24675,12 +42991,66 @@ export interface operations { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_workflow_invocation_report_api_workflows__workflow_id__usage__invocation_id__report_get: { @@ -24708,12 +43078,66 @@ export interface operations { "application/json": components["schemas"]["InvocationReport"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_workflow_invocation_report_pdf_api_workflows__workflow_id__usage__invocation_id__report_pdf_get: { @@ -24737,12 +43161,66 @@ export interface operations { responses: { /** @description Successful Response */ 200: never; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; workflow_invocation_step_jobs_summary_api_workflows__workflow_id__usage__invocation_id__step_jobs_summary_get: { @@ -24774,12 +43252,66 @@ export interface operations { )[]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; workflow_invocation_step_api_workflows__workflow_id__usage__invocation_id__steps__step_id__get: { @@ -24809,12 +43341,66 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; update_workflow_invocation_step_api_workflows__workflow_id__usage__invocation_id__steps__step_id__put: { @@ -24836,25 +43422,79 @@ export interface operations { /** @description The encoded database identifier of the WorkflowInvocationStep. */ step_id: string; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["InvocationUpdatePayload"]; + }; + requestBody: { + content: { + "application/json": components["schemas"]["InvocationUpdatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["InvocationStep"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - responses: { - /** @description Successful Response */ - 200: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { - "application/json": components["schemas"]["InvocationStep"]; + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; show_versions_api_workflows__workflow_id__versions_get: { @@ -24879,12 +43519,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_object_ga4gh_drs_v1_objects__object_id__get: { @@ -24906,12 +43600,66 @@ export interface operations { "application/json": components["schemas"]["DrsObject"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_object_ga4gh_drs_v1_objects__object_id__post: { @@ -24933,12 +43681,66 @@ export interface operations { "application/json": components["schemas"]["DrsObject"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__get: { @@ -24962,12 +43764,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__post: { @@ -24991,12 +43847,66 @@ export interface operations { "application/json": Record; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; service_info_ga4gh_drs_v1_service_info_get: { @@ -25008,12 +43918,66 @@ export interface operations { "application/json": components["schemas"]["Service"]; }; }; - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; } diff --git a/lib/galaxy/webapps/base/api.py b/lib/galaxy/webapps/base/api.py index a5c2119a6202..8e991bd19b8c 100644 --- a/lib/galaxy/webapps/base/api.py +++ b/lib/galaxy/webapps/base/api.py @@ -38,6 +38,8 @@ ) from galaxy.schema.schema import MessageExceptionModel +from galaxy.exceptions.error_codes import error_codes_by_int_code + log = getLogger(__name__) @@ -237,16 +239,21 @@ def add_request_id_middleware(app: FastAPI): def include_all_package_routers(app: FastAPI, package_name: str): + responses: typing.Dict[typing.Union[int, str], typing.Dict[str, typing.Any]] = { + 422: { + "description": "Validation error", + "model": MessageExceptionModel, + }, + } + for code, error in error_codes_by_int_code.items(): + code_int = int(str(code)[:3]) + if code_int in [0, 204] or code_int in responses: + continue + responses[code_int] = { + "description": str(error), + "model": MessageExceptionModel, + } for _, module in walk_controller_modules(package_name): router = getattr(module, "router", None) if router: - app.include_router( - router, - responses={ - 422: { - "description": "Bad Request", - "model": MessageExceptionModel, - }, - }, - ) - + app.include_router(router, responses=responses) diff --git a/lib/tool_shed/webapp/frontend/src/schema/schema.ts b/lib/tool_shed/webapp/frontend/src/schema/schema.ts index 382a1760171e..f56d914f4046 100644 --- a/lib/tool_shed/webapp/frontend/src/schema/schema.ts +++ b/lib/tool_shed/webapp/frontend/src/schema/schema.ts @@ -1045,12 +1045,66 @@ export interface operations { "application/json": components["schemas"]["APIKeyResponse"] } } - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } categories__index: { @@ -1065,12 +1119,66 @@ export interface operations { "application/json": components["schemas"]["Category"][] } } - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } categories__create: { @@ -1090,12 +1198,66 @@ export interface operations { "application/json": components["schemas"]["Category"] } } - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } /** @@ -1116,12 +1278,66 @@ export interface operations { "application/json": components["schemas"]["Category"] } } - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } /** @@ -1148,12 +1364,66 @@ export interface operations { "application/json": components["schemas"]["RepositoriesByCategory"] } } - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } /** Service Info */ @@ -1165,813 +1435,2703 @@ export interface operations { "application/json": components["schemas"]["Service"] } } - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - tools__trs_tool_classes: { - /** Tool Classes */ - responses: { - /** @description Successful Response */ - 200: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": components["schemas"]["ToolClass"][] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - tools__trs_index: { - /** Trs Index */ - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication required for this request */ + 403: { content: { - "application/json": unknown + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - tools__trs_get: { - /** Trs Get */ - parameters: { - path: { - /** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */ - tool_id: string + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["Tool"] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Trs Get Versions */ - tools__trs_get_versions: { - parameters: { - path: { - /** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */ - tool_id: string - } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["ToolVersion"][] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - /** - * Index - * @description Get a list of repositories or perform a search. - */ - repositories__index: { - parameters: { - query?: { - q?: string | null - page?: number | null - page_size?: number | null - deleted?: boolean | null - owner?: string | null - name?: string | null - } - } + tools__trs_tool_classes: { + /** Tool Classes */ responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["RepositorySearchResults"] - | components["schemas"]["Repository"][] + "application/json": components["schemas"]["ToolClass"][] } } - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** - * Create - * @description create a new repository - */ - repositories__create: { - requestBody: { - content: { - "application/json": components["schemas"]["CreateRepositoryRequest"] + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["Repository"] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** - * Get Ordered Installable Revisions - * @description Get an ordered list of the repository changeset revisions that are installable - */ - repositories__get_ordered_installable_revisions: { - parameters: { - query?: { - owner?: string | null - name?: string | null - tsr_id?: string | null + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { - "application/json": string[] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** - * Legacy Install Info - * @description Get information used by the install client to install this repository. - */ - repositories__legacy_install_info: { - parameters: { - query: { - /** @description Name of the target repository. */ - name: string - /** @description Owner of the target repository. */ - owner: string - /** @description Changeset of the target repository. */ - changeset_revision: string + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": Record[] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - /** - * Install Info - * @description Get information used by the install client to install this repository. - */ - repositories__install_info: { - parameters: { - query: { - /** @description Name of the target repository. */ - name: string - /** @description Owner of the target repository. */ - owner: string - /** @description Changeset of the target repository. */ - changeset_revision: string - } - } + tools__trs_index: { + /** Trs Index */ responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InstallInfo"] + "application/json": unknown } } - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** - * Reset Metadata On Repository Legacy - * @description reset metadata on a repository - */ - repositories__reset_legacy: { - responses: { - /** @description Successful Response */ - 200: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - repositories__update: { - /** Updates */ - parameters: { - query: { - owner?: string | null - name?: string | null - changeset_revision: string - hexlify?: boolean | null + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": Record + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** Show */ - repositories__show: { + tools__trs_get: { + /** Trs Get */ parameters: { path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string + /** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */ + tool_id: string } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DetailedRepository"] + "application/json": components["schemas"]["Tool"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** Show Allow Push */ - repositories__show_allow_push: { + /** Trs Get Versions */ + tools__trs_get_versions: { parameters: { path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string + /** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */ + tool_id: string } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": string[] + "application/json": components["schemas"]["ToolVersion"][] } } - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** Add Allow Push */ - repositories__add_allow_push: { + /** + * Index + * @description Get a list of repositories or perform a search. + */ + repositories__index: { parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - /** @description The target username. */ - username: string + query?: { + q?: string | null + page?: number | null + page_size?: number | null + deleted?: boolean | null + owner?: string | null + name?: string | null } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": string[] + "application/json": + | components["schemas"]["RepositorySearchResults"] + | components["schemas"]["Repository"][] } } - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Remove Allow Push */ - repositories__remove_allow_push: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Create + * @description create a new repository + */ + repositories__create: { + requestBody: { + content: { + "application/json": components["schemas"]["CreateRepositoryRequest"] + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["Repository"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Get Ordered Installable Revisions + * @description Get an ordered list of the repository changeset revisions that are installable + */ + repositories__get_ordered_installable_revisions: { + parameters: { + query?: { + owner?: string | null + name?: string | null + tsr_id?: string | null + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": string[] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Legacy Install Info + * @description Get information used by the install client to install this repository. + */ + repositories__legacy_install_info: { + parameters: { + query: { + /** @description Name of the target repository. */ + name: string + /** @description Owner of the target repository. */ + owner: string + /** @description Changeset of the target repository. */ + changeset_revision: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record[] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Install Info + * @description Get information used by the install client to install this repository. + */ + repositories__install_info: { + parameters: { + query: { + /** @description Name of the target repository. */ + name: string + /** @description Owner of the target repository. */ + owner: string + /** @description Changeset of the target repository. */ + changeset_revision: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["InstallInfo"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Reset Metadata On Repository Legacy + * @description reset metadata on a repository + */ + repositories__reset_legacy: { + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + repositories__update: { + /** Updates */ + parameters: { + query: { + owner?: string | null + name?: string | null + changeset_revision: string + hexlify?: boolean | null + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** Show */ + repositories__show: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["DetailedRepository"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** Show Allow Push */ + repositories__show_allow_push: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": string[] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** Add Allow Push */ + repositories__add_allow_push: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + /** @description The target username. */ + username: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": string[] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** Remove Allow Push */ + repositories__remove_allow_push: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + /** @description The target username. */ + username: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": string[] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Create Changeset Revision + * @description upload new revision to the repository + */ + repositories__create_revision: { + parameters: { + query?: { + /** @description Set commit message as a query parameter. */ + commit_message?: string | null + } + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + requestBody?: { + content: { + "multipart/form-data": components["schemas"]["Body_repositories__create_revision"] + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["RepositoryUpdate"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** Set Deprecated */ + repositories__set_deprecated: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Successful Response */ + 204: never + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** Unset Deprecated */ + repositories__unset_deprecated: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Successful Response */ + 204: never + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Metadata + * @description Get information about repository metadata + */ + repositories__metadata: { + parameters: { + query?: { + /** @description Include only downloadable repositories. */ + downloadable_only?: boolean + } + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** Permissions */ + repositories__permissions: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["RepositoryPermissions"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Reset Metadata On Repository + * @description reset metadata on a repository + */ + repositories__reset: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** Set Malicious */ + repositories__set_malicious: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + /** @description The changeset revision corresponding to the target revision of the target repository. */ + changeset_revision: string + } + } + responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Successful Response */ + 204: never + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** Unset Malicious */ + repositories__unset_malicious: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + /** @description The changeset revision corresponding to the target revision of the target repository. */ + changeset_revision: string + } + } + responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Successful Response */ + 204: never + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Get Readmes + * @description fetch readmes for repository revision + */ + repositories__readmes: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + /** @description The changeset revision corresponding to the target revision of the target repository. */ + changeset_revision: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["RepositoryRevisionReadmes"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** Index */ + tools__index: { + parameters: { + query: { + q: string + page?: number + page_size?: number + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Build Search Index + * @description Not part of the stable API, just something to simplify + * bootstrapping tool sheds, scripting, testing, etc... + */ + tools__build_search_index: { + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["BuildSearchIndexResponse"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + users__index: { + /** + * Index + * @description index users + */ + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["UserV2"][] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + users__create: { + /** + * Create + * @description create a user + */ + requestBody: { + content: { + "application/json": components["schemas"]["CreateUserRequest"] + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["UserV2"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + /** + * Current + * @description show current user + */ + users__current: { + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["UserV2"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + } + } + users__show: { + /** + * Show + * @description show a user + */ parameters: { path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - /** @description The target username. */ - username: string + /** @description The encoded database identifier of the user. */ + encoded_user_id: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["UserV2"] + } + } + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": string[] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - /** - * Create Changeset Revision - * @description upload new revision to the repository - */ - repositories__create_revision: { + /** Return the user's API key */ + users__get_or_create_api_key: { parameters: { - query?: { - /** @description Set commit message as a query parameter. */ - commit_message?: string | null - } path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - requestBody?: { - content: { - "multipart/form-data": components["schemas"]["Body_repositories__create_revision"] + /** @description The encoded database identifier of the user. */ + encoded_user_id: string } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["RepositoryUpdate"] + "application/json": string } } - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Set Deprecated */ - repositories__set_deprecated: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - responses: { - /** @description Successful Response */ - 204: never - /** @description Bad Request */ - 422: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Unset Deprecated */ - repositories__unset_deprecated: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 204: never - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** - * Metadata - * @description Get information about repository metadata - */ - repositories__metadata: { - parameters: { - query?: { - /** @description Include only downloadable repositories. */ - downloadable_only?: boolean + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": Record + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Permissions */ - repositories__permissions: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["RepositoryPermissions"] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - /** - * Reset Metadata On Repository - * @description reset metadata on a repository - */ - repositories__reset: { + /** Creates a new API key for the user */ + users__create_api_key: { parameters: { path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string + /** @description The encoded database identifier of the user. */ + encoded_user_id: string } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] + "application/json": string } } - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Set Malicious */ - repositories__set_malicious: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - /** @description The changeset revision corresponding to the target revision of the target repository. */ - changeset_revision: string + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 204: never - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Unset Malicious */ - repositories__unset_malicious: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - /** @description The changeset revision corresponding to the target revision of the target repository. */ - changeset_revision: string + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 204: never - /** @description Bad Request */ - 422: { + /** @description No such object found. */ + 404: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** - * Get Readmes - * @description fetch readmes for repository revision - */ - repositories__readmes: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - /** @description The changeset revision corresponding to the target revision of the target repository. */ - changeset_revision: string + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["RepositoryRevisionReadmes"] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } - /** Index */ - tools__index: { + /** Delete the current API key of the user */ + users__delete_api_key: { parameters: { - query: { - q: string - page?: number - page_size?: number + path: { + /** @description The encoded database identifier of the user. */ + encoded_user_id: string } } responses: { - /** @description Successful Response */ - 200: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { - "application/json": Record + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Successful Response */ + 204: never + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** - * Build Search Index - * @description Not part of the stable API, just something to simplify - * bootstrapping tool sheds, scripting, testing, etc... - */ - tools__build_search_index: { - responses: { - /** @description Successful Response */ - 200: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { - "application/json": components["schemas"]["BuildSearchIndexResponse"] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Authentication required for this request */ + 403: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - users__index: { - /** - * Index - * @description index users - */ - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": components["schemas"]["UserV2"][] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - users__create: { - /** - * Create - * @description create a user - */ - requestBody: { - content: { - "application/json": components["schemas"]["CreateUserRequest"] - } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { content: { - "application/json": components["schemas"]["UserV2"] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** - * Current - * @description show current user - */ - users__current: { - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["UserV2"] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - users__show: { - /** - * Show - * @description show a user - */ - parameters: { - path: { - /** @description The encoded database identifier of the user. */ - encoded_user_id: string - } - } + /** Version */ + configuration__version: { responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserV2"] + "application/json": components["schemas"]["Version"] } } - /** @description Bad Request */ - 422: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Return the user's API key */ - users__get_or_create_api_key: { - parameters: { - path: { - /** @description The encoded database identifier of the user. */ - encoded_user_id: string - } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description User does not have permissions to run jobs as another user. */ + 400: { content: { - "application/json": string + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Authentication failed, invalid credentials supplied. */ + 401: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Creates a new API key for the user */ - users__create_api_key: { - parameters: { - path: { - /** @description The encoded database identifier of the user. */ - encoded_user_id: string + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 200: { + /** @description No such object found. */ + 404: { content: { - "application/json": string + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Database conflict prevented fulfilling the request. */ + 409: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Delete the current API key of the user */ - users__delete_api_key: { - parameters: { - path: { - /** @description The encoded database identifier of the user. */ - encoded_user_id: string + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } } - } - responses: { - /** @description Successful Response */ - 204: never - /** @description Bad Request */ + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - } - } - /** Version */ - configuration__version: { - responses: { - /** @description Successful Response */ - 200: { + /** @description Internal server error. */ + 500: { content: { - "application/json": components["schemas"]["Version"] + "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Bad Request */ - 422: { + /** @description Method is not implemented. */ + 501: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -1989,14 +4149,68 @@ export interface operations { } } responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } /** @description Successful Response */ 204: never - /** @description Bad Request */ + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } /** @@ -2016,12 +4230,66 @@ export interface operations { "application/json": components["schemas"]["UiLoginResponse"] } } - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } /** @@ -2041,12 +4309,66 @@ export interface operations { "application/json": components["schemas"]["UiLogoutResponse"] } } - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } /** @@ -2066,12 +4388,66 @@ export interface operations { "application/json": components["schemas"]["UiRegisterResponse"] } } - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } /** @@ -2096,12 +4472,66 @@ export interface operations { "application/json": components["schemas"]["RepositoryMetadata"] } } - /** @description Bad Request */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Validation error */ 422: { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"] + } + } } } } From 34a1294469bb6b7c19e50321c9d814ca6b17f899 Mon Sep 17 00:00:00 2001 From: Arash Date: Tue, 2 Jul 2024 15:28:48 +0200 Subject: [PATCH 11/17] update schema --- client/src/api/schema/schema.ts | 6874 ++++++++++++++++++------------- 1 file changed, 4108 insertions(+), 2766 deletions(-) diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index 02f1d97ded14..7cfef6966937 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -8,20 +8,6 @@ export interface paths { /** Returns returns an API key for authenticated user based on BaseAuth headers. */ get: operations["get_api_key_api_authenticate_baseauth_get"]; }; - "/api/cloud/storage/get": { - /** - * Gets given objects from a given cloud-based bucket to a Galaxy history. - * @deprecated - */ - post: operations["get_api_cloud_storage_get_post"]; - }; - "/api/cloud/storage/send": { - /** - * Sends given dataset(s) in a given history to a given cloud-based bucket. - * @deprecated - */ - post: operations["send_api_cloud_storage_send_post"]; - }; "/api/configuration": { /** * Return an object containing exposable configuration settings @@ -318,6 +304,28 @@ export interface paths { /** Download */ get: operations["download_api_drs_download__object_id__get"]; }; + "/api/file_source_instances": { + /** Get a list of persisted file source instances defined by the requesting user. */ + get: operations["file_sources__instances_index"]; + /** Create a user-bound file source. */ + post: operations["file_sources__create_instance"]; + }; + "/api/file_source_instances/test": { + /** Test payload for creating user-bound file source. */ + post: operations["file_sources__test_new_instance_configuration"]; + }; + "/api/file_source_instances/{user_file_source_id}": { + /** Get a persisted user file source instance. */ + get: operations["file_sources__instances_get"]; + /** Update or upgrade user file source instance. */ + put: operations["file_sources__instances_update"]; + /** Purge user file source instance. */ + delete: operations["file_sources__instances_purge"]; + }; + "/api/file_source_templates": { + /** Get a list of file source templates available to build user defined file sources from */ + get: operations["file_sources__templates_index"]; + }; "/api/folders/{folder_id}/contents": { /** * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. @@ -390,6 +398,8 @@ export interface paths { * Displays remote files available to the user. Please use /api/remote_files instead. * @deprecated * @description Lists all remote files available to the user from different sources. + * + * The total count of files and directories is returned in the 'total_matches' header. */ get: operations["index_api_ftp_files_get"]; }; @@ -1245,6 +1255,28 @@ export interface paths { */ delete: operations["delete_user_notification_api_notifications__notification_id__delete"]; }; + "/api/object_store_instances": { + /** Get a list of persisted object store instances defined by the requesting user. */ + get: operations["object_stores__instances_index"]; + /** Create a user-bound object store. */ + post: operations["object_stores__create_instance"]; + }; + "/api/object_store_instances/test": { + /** Test payload for creating user-bound object store. */ + post: operations["object_stores__test_new_instance_configuration"]; + }; + "/api/object_store_instances/{user_object_store_id}": { + /** Get a persisted user object store instance. */ + get: operations["object_stores__instances_get"]; + /** Update or upgrade user object store instance. */ + put: operations["object_stores__instances_update"]; + /** Purge user object store instance. */ + delete: operations["object_stores__instances_purge"]; + }; + "/api/object_store_templates": { + /** Get a list of object store templates available to build user defined object stores from */ + get: operations["object_stores__templates_index"]; + }; "/api/object_stores": { /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ get: operations["index_api_object_stores_get"]; @@ -1409,6 +1441,8 @@ export interface paths { /** * Displays remote files available to the user. * @description Lists all remote files available to the user from different sources. + * + * The total count of files and directories is returned in the 'total_matches' header. */ get: operations["index_api_remote_files_get"]; /** @@ -2452,7 +2486,7 @@ export interface components { | "more_stable" | "less_stable" ) - | ("cloud" | "quota" | "no_quota" | "restricted"); + | ("cloud" | "quota" | "no_quota" | "restricted" | "user_defined"); }; /** BasicRoleModel */ BasicRoleModel: { @@ -2636,7 +2670,7 @@ export interface components { * Documentation * @description Documentation or extended description for this plugin. */ - doc: string; + doc?: string | null; /** * ID * @description The `FilesSource` plugin identifier @@ -2657,6 +2691,15 @@ export interface components { * @description Only users with the roles specified here can access this files source. */ requires_roles?: string | null; + /** + * @description Features supported by this file source. + * @default { + * "pagination": false, + * "search": false, + * "sorting": false + * } + */ + supports?: components["schemas"]["FilesSourceSupports"]; /** * Type * @description The type of the plugin. @@ -2667,12 +2710,16 @@ export interface components { * @description The URI root used by this type of plugin. */ uri_root: string; + /** + * URL + * @description Optional URL that might be provided by some plugins to link to the remote source. + */ + url?: string | null; /** * Writeable * @description Whether this files source plugin allows write access. */ writable: boolean; - [key: string]: unknown | undefined; }; /** BulkOperationItemError */ BulkOperationItemError: { @@ -2749,85 +2796,6 @@ export interface components { /** Item Ids */ item_ids: string[]; }; - /** CloudDatasets */ - CloudDatasets: { - /** - * Authentication ID - * @description The ID of CloudAuthz to be used for authorizing access to the resource provider. You may get a list of the defined authorizations via `/api/cloud/authz`. Also, you can use `/api/cloud/authz/create` to define a new authorization. - * @example 0123456789ABCDEF - */ - authz_id: string; - /** - * Bucket - * @description The name of a bucket to which data should be sent (e.g., a bucket name on AWS S3). - */ - bucket: string; - /** - * Objects - * @description A list of dataset IDs belonging to the specified history that should be sent to the given bucket. If not provided, Galaxy sends all the datasets belonging the specified history. - */ - dataset_ids?: string[] | null; - /** - * History ID - * @description The ID of history from which the object should be downloaded - * @example 0123456789ABCDEF - */ - history_id: string; - /** - * Spaces to tabs - * @description A boolean value. If set to 'True', and an object with same name of the dataset to be sent already exist in the bucket, Galaxy replaces the existing object with the dataset to be sent. If set to 'False', Galaxy appends datetime to the dataset name to prevent overwriting an existing object. - * @default false - */ - overwrite_existing?: boolean | null; - }; - /** CloudDatasetsResponse */ - CloudDatasetsResponse: { - /** - * Bucket - * @description The name of bucket to which the listed datasets are queued to be sent - */ - bucket_name: string; - /** - * Failed datasets - * @description The datasets for which Galaxy failed to create (and queue) send job - */ - failed_dataset_labels: string[]; - /** - * Send datasets - * @description The datasets for which Galaxy succeeded to create (and queue) send job - */ - sent_dataset_labels: string[]; - }; - /** CloudObjects */ - CloudObjects: { - /** - * Authentication ID - * @description The ID of CloudAuthz to be used for authorizing access to the resource provider. You may get a list of the defined authorizations via `/api/cloud/authz`. Also, you can use `/api/cloud/authz/create` to define a new authorization. - * @example 0123456789ABCDEF - */ - authz_id: string; - /** - * Bucket - * @description The name of a bucket from which data should be fetched from (e.g., a bucket name on AWS S3). - */ - bucket: string; - /** - * History ID - * @description The ID of history to which the object should be received to. - * @example 0123456789ABCDEF - */ - history_id: string; - /** - * Input arguments - * @description A summary of the input arguments, which is optional and will default to {}. - */ - input_args?: components["schemas"]["InputArguments"] | null; - /** - * Objects - * @description A list of the names of objects to be fetched. - */ - objects: string[]; - }; /** CollectionElementIdentifier */ CollectionElementIdentifier: { /** @@ -3157,6 +3125,25 @@ export interface components { /** Store Dict */ store_dict?: Record | null; }; + /** CreateInstancePayload */ + CreateInstancePayload: { + /** Description */ + description?: string | null; + /** Name */ + name: string; + /** Secrets */ + secrets: { + [key: string]: string | undefined; + }; + /** Template Id */ + template_id: string; + /** Template Version */ + template_version: number; + /** Variables */ + variables: { + [key: string]: (string | boolean | number) | undefined; + }; + }; /** CreateInvocationsFromStorePayload */ CreateInvocationsFromStorePayload: { /** @@ -4125,47 +4112,6 @@ export interface components { */ sources: Record[]; }; - /** DatasetSummary */ - DatasetSummary: { - /** - * Create Time - * @description The time and date this item was created. - */ - create_time: string | null; - /** Deleted */ - deleted: boolean; - /** File Size */ - file_size: number; - /** - * Id - * @example 0123456789ABCDEF - */ - id: string; - /** Purgable */ - purgable: boolean; - /** Purged */ - purged: boolean; - /** - * State - * @description The current state of this dataset. - */ - state: components["schemas"]["DatasetState"]; - /** Total Size */ - total_size: number; - /** - * Update Time - * @description The last time and date this item was updated. - */ - update_time: string | null; - /** - * UUID - * Format: uuid4 - * @description Universal unique identifier for this dataset. - */ - uuid: string; - }; - /** DatasetSummaryList */ - DatasetSummaryList: components["schemas"]["DatasetSummary"][]; /** DatasetTextContentDetails */ DatasetTextContentDetails: { /** @@ -5197,6 +5143,43 @@ export interface components { */ update_time: string; }; + /** FileSourceTemplateSummaries */ + FileSourceTemplateSummaries: components["schemas"]["FileSourceTemplateSummary"][]; + /** FileSourceTemplateSummary */ + FileSourceTemplateSummary: { + /** Description */ + description: string | null; + /** + * Hidden + * @default false + */ + hidden?: boolean; + /** Id */ + id: string; + /** Name */ + name: string | null; + /** Secrets */ + secrets?: components["schemas"]["TemplateSecret"][] | null; + /** + * Type + * @enum {string} + */ + type: "ftp" | "posix" | "s3fs" | "azure"; + /** Variables */ + variables?: + | ( + | components["schemas"]["TemplateVariableString"] + | components["schemas"]["TemplateVariableInteger"] + | components["schemas"]["TemplateVariablePathComponent"] + | components["schemas"]["TemplateVariableBoolean"] + )[] + | null; + /** + * Version + * @default 0 + */ + version?: number; + }; /** FilesSourcePlugin */ FilesSourcePlugin: { /** @@ -5208,7 +5191,7 @@ export interface components { * Documentation * @description Documentation or extended description for this plugin. */ - doc: string; + doc?: string | null; /** * ID * @description The `FilesSource` plugin identifier @@ -5229,11 +5212,25 @@ export interface components { * @description Only users with the roles specified here can access this files source. */ requires_roles?: string | null; + /** + * @description Features supported by this file source. + * @default { + * "pagination": false, + * "search": false, + * "sorting": false + * } + */ + supports?: components["schemas"]["FilesSourceSupports"]; /** * Type * @description The type of the plugin. */ type: string; + /** + * URL + * @description Optional URL that might be provided by some plugins to link to the remote source. + */ + url?: string | null; /** * Writeable * @description Whether this files source plugin allows write access. @@ -5248,6 +5245,27 @@ export interface components { | components["schemas"]["BrowsableFilesSourcePlugin"] | components["schemas"]["FilesSourcePlugin"] )[]; + /** FilesSourceSupports */ + FilesSourceSupports: { + /** + * Pagination + * @description Whether this file source supports server-side pagination. + * @default false + */ + pagination?: boolean; + /** + * Search + * @description Whether this file source supports server-side search. + * @default false + */ + search?: boolean; + /** + * Sorting + * @description Whether this file source supports server-side sorting. + * @default false + */ + sorting?: boolean; + }; /** FillStepDefaultsAction */ FillStepDefaultsAction: { /** @@ -5492,6 +5510,15 @@ export interface components { */ url: string; }; + /** GroupUpdatePayload */ + GroupUpdatePayload: { + /** name of the group */ + name?: string | null; + /** role IDs */ + role_ids?: string[] | null; + /** user IDs */ + user_ids?: string[] | null; + }; /** GroupUserListResponse */ GroupUserListResponse: components["schemas"]["GroupUserResponse"][]; /** GroupUserResponse */ @@ -6011,11 +6038,96 @@ export interface components { */ visible: boolean; }; + /** + * HDAInaccessible + * @description History Dataset Association information when the user can not access it. + */ + HDAInaccessible: { + /** + * Accessible + * @constant + * @enum {boolean} + */ + accessible: false; + /** 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; + /** + * Deleted + * @description Whether this item is marked as deleted. + */ + deleted: boolean; + /** + * HID + * @description The index position of this item in the History. + */ + hid: number; + /** + * History Content Type + * @description This is always `dataset` for datasets. + * @constant + * @enum {string} + */ + 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; + /** + * 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; + }; /** * HDAObject * @description History Dataset Association Object */ HDAObject: { + /** Accessible */ + accessible?: boolean | null; /** Copied From Ldda Id */ copied_from_ldda_id?: string | null; /** @@ -6041,6 +6153,8 @@ export interface components { * @enum {string} */ model_class: "HistoryDatasetAssociation"; + /** Purged */ + purged: boolean; /** * State * @description The current state of this dataset. @@ -6943,6 +7057,7 @@ export interface components { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; @@ -6959,6 +7074,7 @@ export interface components { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; @@ -7261,33 +7377,6 @@ export interface components { */ uri: string; }; - /** InputArguments */ - InputArguments: { - /** - * Database Key - * @description Sets the database key of the objects being fetched to Galaxy. - * @default ? - */ - dbkey?: string | null; - /** - * File Type - * @description Sets the Galaxy datatype (e.g., `bam`) for the objects being fetched to Galaxy. See the following link for a complete list of Galaxy data types: https://galaxyproject.org/learn/datatypes/. - * @default auto - */ - file_type?: string | null; - /** - * Spaces to tabs - * @description A boolean value ('true' or 'false') that sets if spaces should be converted to tab in the objects being fetched to Galaxy. Applicable only if `to_posix_lines` is True - * @default false - */ - space_to_tab?: boolean | null; - /** - * POSIX line endings - * @description A boolean value ('true' or 'false'); if 'Yes', converts universal line endings to POSIX line endings. Set to 'False' if you upload a gzip, bz2 or zip archive containing a binary file. - * @default Yes - */ - to_posix_lines?: "Yes" | boolean | null; - }; /** InputDataCollectionStep */ InputDataCollectionStep: { /** @@ -8309,6 +8398,11 @@ export interface components { * @default false */ use_cached_job?: boolean | null; + /** + * Version + * @description The version of the workflow to invoke. + */ + version?: number | null; }; /** * ItemTagsCreatePayload @@ -9879,6 +9973,45 @@ export interface components { */ up_to_date: boolean; }; + /** ObjectStoreTemplateSummaries */ + ObjectStoreTemplateSummaries: components["schemas"]["ObjectStoreTemplateSummary"][]; + /** ObjectStoreTemplateSummary */ + ObjectStoreTemplateSummary: { + /** Badges */ + badges: components["schemas"]["BadgeDict"][]; + /** Description */ + description: string | null; + /** + * Hidden + * @default false + */ + hidden?: boolean; + /** Id */ + id: string; + /** Name */ + name: string | null; + /** Secrets */ + secrets?: components["schemas"]["TemplateSecret"][] | null; + /** + * Type + * @enum {string} + */ + type: "aws_s3" | "azure_blob" | "boto3" | "disk" | "generic_s3"; + /** Variables */ + variables?: + | ( + | components["schemas"]["TemplateVariableString"] + | components["schemas"]["TemplateVariableInteger"] + | components["schemas"]["TemplateVariablePathComponent"] + | components["schemas"]["TemplateVariableBoolean"] + )[] + | null; + /** + * Version + * @default 0 + */ + version?: number; + }; /** OutputReferenceByLabel */ OutputReferenceByLabel: { /** @@ -10309,12 +10442,28 @@ export interface components { * @enum {string} */ PersonalNotificationCategory: "message" | "new_shared_item"; + /** PluginAspectStatus */ + PluginAspectStatus: { + /** Message */ + message: string; + /** + * State + * @enum {string} + */ + state: "ok" | "not_ok" | "unknown"; + }; /** * PluginKind * @description Enum to distinguish between different kinds or categories of plugins. * @enum {string} */ PluginKind: "rfs" | "drs" | "rdm" | "stock"; + /** PluginStatus */ + PluginStatus: { + connection?: components["schemas"]["PluginAspectStatus"] | null; + template_definition: components["schemas"]["PluginAspectStatus"]; + template_settings?: components["schemas"]["PluginAspectStatus"] | null; + }; /** Position */ Position: { /** Left */ @@ -11752,6 +11901,92 @@ export interface components { * @enum {string} */ TaskState: "PENDING" | "STARTED" | "RETRY" | "FAILURE" | "SUCCESS"; + /** TemplateSecret */ + TemplateSecret: { + /** Help */ + help: string | null; + /** Label */ + label?: string | null; + /** Name */ + name: string; + }; + /** TemplateVariableBoolean */ + TemplateVariableBoolean: { + /** + * Default + * @default false + */ + default?: boolean; + /** Help */ + help: string | null; + /** Label */ + label?: string | null; + /** Name */ + name: string; + /** + * Type + * @constant + * @enum {string} + */ + type: "boolean"; + }; + /** TemplateVariableInteger */ + TemplateVariableInteger: { + /** + * Default + * @default 0 + */ + default?: number; + /** Help */ + help: string | null; + /** Label */ + label?: string | null; + /** Name */ + name: string; + /** + * Type + * @constant + * @enum {string} + */ + type: "integer"; + }; + /** TemplateVariablePathComponent */ + TemplateVariablePathComponent: { + /** Default */ + default?: string | null; + /** Help */ + help: string | null; + /** Label */ + label?: string | null; + /** Name */ + name: string; + /** + * Type + * @constant + * @enum {string} + */ + type: "path_component"; + }; + /** TemplateVariableString */ + TemplateVariableString: { + /** + * Default + * @default + */ + default?: string; + /** Help */ + help: string | null; + /** Label */ + label?: string | null; + /** Name */ + name: string; + /** + * Type + * @constant + * @enum {string} + */ + type: "string"; + }; /** ToolDataDetails */ ToolDataDetails: { /** @@ -12094,6 +12329,28 @@ export interface components { visible?: boolean | null; [key: string]: unknown; }; + /** UpdateInstancePayload */ + UpdateInstancePayload: { + /** Active */ + active?: boolean | null; + /** Description */ + description?: string | null; + /** Hidden */ + hidden?: boolean | null; + /** Name */ + name?: string | null; + /** Variables */ + variables?: { + [key: string]: (string | boolean | number) | undefined; + } | null; + }; + /** UpdateInstanceSecretPayload */ + UpdateInstanceSecretPayload: { + /** Secret Name */ + secret_name: string; + /** Secret Value */ + secret_value: string; + }; /** UpdateLibraryFolderPayload */ UpdateLibraryFolderPayload: { /** @@ -12275,6 +12532,19 @@ export interface components { */ action_type: "upgrade_all_steps"; }; + /** UpgradeInstancePayload */ + UpgradeInstancePayload: { + /** Secrets */ + secrets: { + [key: string]: string | undefined; + }; + /** Template Version */ + template_version: number; + /** Variables */ + variables: { + [key: string]: (string | boolean | number) | undefined; + }; + }; /** UpgradeSubworkflowAction */ UpgradeSubworkflowAction: { /** @@ -12376,6 +12646,45 @@ export interface components { */ enabled: boolean; }; + /** UserConcreteObjectStoreModel */ + UserConcreteObjectStoreModel: { + /** Active */ + active: boolean; + /** Badges */ + badges: components["schemas"]["BadgeDict"][]; + /** Description */ + description?: string | null; + /** Device */ + device?: string | null; + /** Hidden */ + hidden: boolean; + /** Name */ + name?: string | null; + /** Object Store Id */ + object_store_id?: string | null; + /** Private */ + private: boolean; + /** Purged */ + purged: boolean; + quota: components["schemas"]["QuotaModel"]; + /** Secrets */ + secrets: string[]; + /** Template Id */ + template_id: string; + /** Template Version */ + template_version: number; + /** + * Type + * @enum {string} + */ + type: "aws_s3" | "azure_blob" | "boto3" | "disk" | "generic_s3"; + /** Uuid */ + uuid: string; + /** Variables */ + variables: { + [key: string]: (string | boolean | number) | undefined; + } | null; + }; /** UserCreationPayload */ UserCreationPayload: { /** @@ -12398,9 +12707,11 @@ export interface components { UserDeletionPayload: { /** * Purge user - * @description Purge the user + * @deprecated + * @description Purge the user. Deprecated, please use the `purge` query parameter instead. + * @default false */ - purge: boolean; + purge?: boolean; }; /** UserEmail */ UserEmail: { @@ -12416,6 +12727,38 @@ export interface components { */ id: string; }; + /** UserFileSourceModel */ + UserFileSourceModel: { + /** Active */ + active: boolean; + /** Description */ + description: string | null; + /** Hidden */ + hidden: boolean; + /** Name */ + name: string; + /** Purged */ + purged: boolean; + /** Secrets */ + secrets: string[]; + /** Template Id */ + template_id: string; + /** Template Version */ + template_version: number; + /** + * Type + * @enum {string} + */ + type: "ftp" | "posix" | "s3fs" | "azure"; + /** Uri Root */ + uri_root: string; + /** Uuid */ + uuid: string; + /** Variables */ + variables: { + [key: string]: (string | boolean | number) | undefined; + } | null; + }; /** * UserModel * @description User in a transaction context. @@ -13135,27 +13478,34 @@ export interface operations { }; }; }; - get_api_cloud_storage_get_post: { + index_api_configuration_get: { /** - * Gets given objects from a given cloud-based bucket to a Galaxy history. - * @deprecated + * Return an object containing exposable configuration settings + * @description Return an object containing exposable configuration settings. + * + * A more complete list is returned if the user is an admin. + * Pass in `view` and a comma-seperated list of keys to control which + * configuration settings are returned. */ parameters?: { - /** @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. */ + /** @description View to be passed to the serializer */ + /** @description Comma-separated list of keys to be passed to the serializer */ + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { + /** @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. */ "run-as"?: string | null; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["CloudObjects"]; - }; - }; responses: { - /** @description Successful Response */ + /** @description Object containing exposable configuration settings */ 200: { content: { - "application/json": components["schemas"]["DatasetSummaryList"]; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -13220,27 +13570,28 @@ export interface operations { }; }; }; - send_api_cloud_storage_send_post: { + decode_id_api_configuration_decode__encoded_id__get: { /** - * Sends given dataset(s) in a given history to a given cloud-based bucket. - * @deprecated + * Decode a given id + * @description Decode a given id. */ - parameters?: { - /** @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. */ + parameters: { header?: { + /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CloudDatasets"]; + path: { + /** @description Encoded id to be decoded */ + encoded_id: string; }; }; responses: { - /** @description Successful Response */ + /** @description Decoded id */ 200: { content: { - "application/json": components["schemas"]["CloudDatasetsResponse"]; + "application/json": { + [key: string]: number; + }; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -13305,34 +13656,25 @@ export interface operations { }; }; }; - index_api_configuration_get: { + dynamic_tool_confs_api_configuration_dynamic_tool_confs_get: { /** - * Return an object containing exposable configuration settings - * @description Return an object containing exposable configuration settings. - * - * A more complete list is returned if the user is an admin. - * Pass in `view` and a comma-seperated list of keys to control which - * configuration settings are returned. + * Return dynamic tool configuration files + * @description Return dynamic tool configuration files. */ parameters?: { - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + /** @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?: { /** @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. */ "run-as"?: string | null; }; }; responses: { - /** @description Object containing exposable configuration settings */ + /** @description Dynamic tool configuration files */ 200: { content: { - "application/json": Record; + "application/json": { + [key: string]: string; + }[]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -13397,9 +13739,9 @@ export interface operations { }; }; }; - decode_id_api_configuration_decode__encoded_id__get: { + encode_id_api_configuration_encode__decoded_id__get: { /** - * Decode a given id + * Encode a given id * @description Decode a given id. */ parameters: { @@ -13408,16 +13750,16 @@ export interface operations { "run-as"?: string | null; }; path: { - /** @description Encoded id to be decoded */ - encoded_id: string; + /** @description Decoded id to be encoded */ + decoded_id: number; }; }; responses: { - /** @description Decoded id */ + /** @description Encoded id */ 200: { content: { "application/json": { - [key: string]: number; + [key: string]: string; }; }; }; @@ -13483,10 +13825,10 @@ export interface operations { }; }; }; - dynamic_tool_confs_api_configuration_dynamic_tool_confs_get: { + tool_lineages_api_configuration_tool_lineages_get: { /** - * Return dynamic tool configuration files - * @description Return dynamic tool configuration files. + * Return tool lineages for tools that have them + * @description Return tool lineages for tools that have them. */ parameters?: { /** @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. */ @@ -13496,11 +13838,11 @@ export interface operations { }; }; responses: { - /** @description Dynamic tool configuration files */ + /** @description Tool lineages for tools that have them */ 200: { content: { "application/json": { - [key: string]: string; + [key: string]: Record; }[]; }; }; @@ -13566,28 +13908,23 @@ export interface operations { }; }; }; - encode_id_api_configuration_encode__decoded_id__get: { + reload_toolbox_api_configuration_toolbox_put: { /** - * Encode a given id - * @description Decode a given id. + * Reload the Galaxy toolbox (but not individual tools) + * @description Reload the Galaxy toolbox (but not individual tools). */ - parameters: { + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description Decoded id to be encoded */ - decoded_id: number; - }; }; responses: { - /** @description Encoded id */ + /** @description Successful Response */ 200: { content: { - "application/json": { - [key: string]: string; - }; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -13652,25 +13989,23 @@ export interface operations { }; }; }; - tool_lineages_api_configuration_tool_lineages_get: { - /** - * Return tool lineages for tools that have them - * @description Return tool lineages for tools that have them. - */ - parameters?: { - /** @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. */ + content_api_dataset_collection_element__dce_id__get: { + /** Content */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded ID of the dataset collection element. */ + dce_id: string; + }; }; responses: { - /** @description Tool lineages for tools that have them */ + /** @description Successful Response */ 200: { content: { - "application/json": { - [key: string]: Record; - }[]; + "application/json": components["schemas"]["DCESummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -13735,11 +14070,8 @@ export interface operations { }; }; }; - reload_toolbox_api_configuration_toolbox_put: { - /** - * Reload the Galaxy toolbox (but not individual tools) - * @description Reload the Galaxy toolbox (but not individual tools). - */ + create_api_dataset_collections_post: { + /** Create a new dataset collection instance. */ parameters?: { /** @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?: { @@ -13747,175 +14079,16 @@ export interface operations { "run-as"?: string | null; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateNewCollectionPayload"]; + }; + }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - content_api_dataset_collection_element__dce_id__get: { - /** Content */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded ID of the dataset collection element. */ - dce_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["DCESummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_dataset_collections_post: { - /** Create a new dataset collection instance. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateNewCollectionPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["HDCADetailed"]; + "application/json": components["schemas"]["HDCADetailed"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -14621,6 +14794,7 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; @@ -14906,6 +15080,7 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; @@ -15284,7 +15459,8 @@ export interface operations { "application/json": | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"]; + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -17416,50 +17592,19 @@ export interface operations { }; }; }; - index_api_folders__folder_id__contents_get: { - /** - * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. - * @description Returns a list of a folder's contents (files and sub-folders). - * - * Additional metadata for the folder is provided in the response as a separate object containing data - * for breadcrumb path building, permissions and other folder's details. - * - * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). - * - * **Security note**: - * - Accessing a library folder or sub-folder requires only access to the parent library. - * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. - * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. - */ - parameters: { - query?: { - /** @description Maximum number of contents to return. */ - limit?: number; - /** @description Return contents from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, contents between position 200-299 will be returned. */ - offset?: number; - /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ - search_text?: string | null; - /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ - include_deleted?: boolean | null; - /** @description Sort results by specified field. */ - order_by?: "name" | "description" | "type" | "size" | "update_time"; - /** @description Sort results in descending order. */ - sort_desc?: boolean | null; - }; + file_sources__instances_index: { + /** Get a list of persisted file source instances defined by the requesting user. */ + parameters?: { + /** @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?: { - /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded identifier of the library folder. */ - folder_id: string; - }; }; responses: { - /** @description The contents of the folder that match the query parameters. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; + "application/json": components["schemas"]["UserFileSourceModel"][]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -17524,28 +17669,24 @@ export interface operations { }; }; }; - add_history_datasets_to_library_api_folders__folder_id__contents_post: { - /** Creates a new library file from an existing HDA/HDCA. */ - parameters: { + file_sources__create_instance: { + /** Create a user-bound file source. */ + parameters?: { + /** @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?: { - /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded identifier of the library folder. */ - folder_id: string; - }; }; requestBody: { content: { - "application/json": components["schemas"]["CreateLibraryFilePayload"]; + "application/json": components["schemas"]["CreateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["UserFileSourceModel"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -17610,26 +17751,24 @@ export interface operations { }; }; }; - show_api_folders__id__get: { - /** - * Displays information about a particular library folder. - * @description Returns detailed information about the library folder with the given ID. - */ - parameters: { + file_sources__test_new_instance_configuration: { + /** Test payload for creating user-bound file source. */ + parameters?: { + /** @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?: { - /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["PluginStatus"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -17694,31 +17833,23 @@ export interface operations { }; }; }; - update_api_folders__id__put: { - /** - * Updates the information of an existing library folder. - * @description Updates the information of an existing library folder. - */ + file_sources__instances_get: { + /** Get a persisted user file source instance. */ parameters: { + /** @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?: { - /** @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. */ "run-as"?: string | null; }; + /** @description The UUID index for a persisted UserFileSourceStore object. */ path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; + user_file_source_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["UserFileSourceModel"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -17783,31 +17914,31 @@ export interface operations { }; }; }; - create_api_folders__id__post: { - /** - * Create a new library folder underneath the one specified by the ID. - * @description Returns detailed information about the newly created library folder. - */ + file_sources__instances_update: { + /** Update or upgrade user file source instance. */ parameters: { + /** @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?: { - /** @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. */ "run-as"?: string | null; }; + /** @description The UUID index for a persisted UserFileSourceStore object. */ path: { - /** @description The encoded identifier of the library folder. */ - id: string; + user_file_source_id: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["CreateLibraryFolderPayload"]; + "application/json": + | components["schemas"]["UpdateInstanceSecretPayload"] + | components["schemas"]["UpgradeInstancePayload"] + | components["schemas"]["UpdateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["UserFileSourceModel"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -17872,15 +18003,189 @@ export interface operations { }; }; }; - delete_api_folders__id__delete: { + file_sources__instances_purge: { + /** Purge user file source instance. */ + parameters: { + /** @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 UUID index for a persisted UserFileSourceStore object. */ + path: { + user_file_source_id: string; + }; + }; + responses: { + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Successful Response */ + 204: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + file_sources__templates_index: { + /** Get a list of file source templates available to build user defined file sources from */ + parameters?: { + /** @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; + }; + }; + responses: { + /** @description A list of the configured file source templates. */ + 200: { + content: { + "application/json": components["schemas"]["FileSourceTemplateSummaries"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_folders__folder_id__contents_get: { /** - * Marks the specified library folder as deleted (or undeleted). - * @description Marks the specified library folder as deleted (or undeleted). + * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. + * @description Returns a list of a folder's contents (files and sub-folders). + * + * Additional metadata for the folder is provided in the response as a separate object containing data + * for breadcrumb path building, permissions and other folder's details. + * + * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). + * + * **Security note**: + * - Accessing a library folder or sub-folder requires only access to the parent library. + * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. + * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. */ parameters: { query?: { - /** @description Whether to restore a deleted library folder. */ - undelete?: boolean | null; + /** @description Maximum number of contents to return. */ + limit?: number; + /** @description Return contents from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, contents between position 200-299 will be returned. */ + offset?: number; + /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ + search_text?: string | null; + /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ + include_deleted?: boolean | null; + /** @description Sort results by specified field. */ + order_by?: "name" | "description" | "type" | "size" | "update_time"; + /** @description Sort results in descending order. */ + sort_desc?: boolean | null; }; header?: { /** @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. */ @@ -17888,14 +18193,14 @@ export interface operations { }; path: { /** @description The encoded identifier of the library folder. */ - id: string; + folder_id: string; }; }; responses: { - /** @description Successful Response */ + /** @description The contents of the folder that match the query parameters. */ 200: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -17960,11 +18265,8 @@ export interface operations { }; }; }; - update_api_folders__id__patch: { - /** - * Update - * @description Updates the information of an existing library folder. - */ + add_history_datasets_to_library_api_folders__folder_id__contents_post: { + /** Creates a new library file from an existing HDA/HDCA. */ parameters: { header?: { /** @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. */ @@ -17972,19 +18274,19 @@ export interface operations { }; path: { /** @description The encoded identifier of the library folder. */ - id: string; + folder_id: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; + "application/json": components["schemas"]["CreateLibraryFilePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -18049,23 +18351,12 @@ export interface operations { }; }; }; - get_permissions_api_folders__id__permissions_get: { + show_api_folders__id__get: { /** - * Gets the current or available permissions of a particular library folder. - * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. + * Displays information about a particular library folder. + * @description Returns detailed information about the library folder with the given ID. */ parameters: { - query?: { - /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ - scope?: components["schemas"]["LibraryPermissionScope"] | null; - /** @description The page number to retrieve when paginating the available roles. */ - page?: number; - /** @description The maximum number of permissions per page when paginating. */ - page_limit?: number; - /** @description Optional search text to retrieve only the roles matching this query. */ - q?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -18079,9 +18370,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["LibraryFolderCurrentPermissions"] - | components["schemas"]["LibraryAvailablePermissions"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -18146,16 +18435,12 @@ export interface operations { }; }; }; - set_permissions_api_folders__id__permissions_post: { + update_api_folders__id__put: { /** - * Sets the permissions to manage a library folder. - * @description Sets the permissions to manage a library folder. + * Updates the information of an existing library folder. + * @description Updates the information of an existing library folder. */ parameters: { - query?: { - /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ - action?: components["schemas"]["LibraryFolderPermissionAction"] | null; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -18167,14 +18452,14 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["LibraryFolderPermissionsPayload"]; + "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibraryFolderCurrentPermissions"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -18239,22 +18524,31 @@ export interface operations { }; }; }; - delete_api_forms__id__delete: { - /** Delete */ + create_api_folders__id__post: { + /** + * Create a new library folder underneath the one specified by the ID. + * @description Returns detailed information about the newly created library folder. + */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { + /** @description The encoded identifier of the library folder. */ id: string; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryFolderPayload"]; + }; + }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -18319,14 +18613,22 @@ export interface operations { }; }; }; - undelete_api_forms__id__undelete_post: { - /** Undelete */ + delete_api_folders__id__delete: { + /** + * Marks the specified library folder as deleted (or undeleted). + * @description Marks the specified library folder as deleted (or undeleted). + */ parameters: { + query?: { + /** @description Whether to restore a deleted library folder. */ + undelete?: boolean | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { + /** @description The encoded identifier of the library folder. */ id: string; }; }; @@ -18334,7 +18636,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -18399,124 +18701,31 @@ export interface operations { }; }; }; - index_api_ftp_files_get: { + update_api_folders__id__patch: { /** - * Displays remote files available to the user. Please use /api/remote_files instead. - * @deprecated - * @description Lists all remote files available to the user from different sources. + * Update + * @description Updates the information of an existing library folder. */ - parameters?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - query?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - target?: string; - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - format?: components["schemas"]["RemoteFilesFormat"] | null; - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - recursive?: boolean | null; - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - disable?: components["schemas"]["RemoteFilesDisableMode"] | null; - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - writeable?: boolean | null; - }; + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["ListUriResponse"] - | components["schemas"]["ListJstreeResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; }; }; - }; - index_api_genomes_get: { - /** Return a list of installed genomes */ - parameters?: { - /** @description If true, return genome keys with chromosome lengths */ - query?: { - /** @description If true, return genome keys with chromosome lengths */ - chrom_info?: boolean; - }; - header?: { - /** @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. */ - "run-as"?: string | null; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; }; }; responses: { - /** @description Installed genomes */ + /** @description Successful Response */ 200: { content: { - "application/json": string[][]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -18581,37 +18790,39 @@ export interface operations { }; }; }; - show_api_genomes__id__get: { - /** Return information about build */ + get_permissions_api_folders__id__permissions_get: { + /** + * Gets the current or available permissions of a particular library folder. + * @description Gets the current or available permissions of a particular library. + * The results can be paginated and additionally filtered by a query. + */ parameters: { query?: { - /** @description If true, return reference data */ - reference?: boolean; - /** @description Limits size of returned data */ - num?: number; - /** @description Limits size of returned data */ - chrom?: string; - /** @description Limits size of returned data */ - low?: number; - /** @description Limits size of returned data */ - high?: number; - /** @description Format */ - format?: string; + /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ + scope?: components["schemas"]["LibraryPermissionScope"] | null; + /** @description The page number to retrieve when paginating the available roles. */ + page?: number; + /** @description The maximum number of permissions per page when paginating. */ + page_limit?: number; + /** @description Optional search text to retrieve only the roles matching this query. */ + q?: string | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description Genome ID */ + /** @description The encoded identifier of the library folder. */ id: string; }; }; responses: { - /** @description Information about genome build */ + /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": + | components["schemas"]["LibraryFolderCurrentPermissions"] + | components["schemas"]["LibraryAvailablePermissions"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -18676,29 +18887,35 @@ export interface operations { }; }; }; - indexes_api_genomes__id__indexes_get: { - /** Return all available indexes for a genome id for provided type */ + set_permissions_api_folders__id__permissions_post: { + /** + * Sets the permissions to manage a library folder. + * @description Sets the permissions to manage a library folder. + */ parameters: { query?: { - /** @description Index type */ - type?: string; - /** @description Format */ - format?: string; + /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ + action?: components["schemas"]["LibraryFolderPermissionAction"] | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description Genome ID */ + /** @description The encoded identifier of the library folder. */ id: string; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["LibraryFolderPermissionsPayload"]; + }; + }; responses: { - /** @description Indexes for a genome id for provided type */ + /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["LibraryFolderCurrentPermissions"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -18763,32 +18980,19 @@ export interface operations { }; }; }; - sequences_api_genomes__id__sequences_get: { - /** Return raw sequence data */ + delete_api_forms__id__delete: { + /** Delete */ parameters: { - query?: { - /** @description If true, return reference data */ - reference?: boolean; - /** @description Limits size of returned data */ - chrom?: string; - /** @description Limits size of returned data */ - low?: number; - /** @description Limits size of returned data */ - high?: number; - /** @description Format */ - format?: string; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description Genome ID */ id: string; }; }; responses: { - /** @description Raw sequence data */ + /** @description Successful Response */ 200: { content: { "application/json": Record; @@ -18856,20 +19060,22 @@ export interface operations { }; }; }; - index_api_groups_get: { - /** Displays a collection (list) of groups. */ - parameters?: { - /** @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. */ + undelete_api_forms__id__undelete_post: { + /** Undelete */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupListResponse"]; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -18934,25 +19140,52 @@ export interface operations { }; }; }; - create_api_groups_post: { - /** Creates a new group. */ + index_api_ftp_files_get: { + /** + * Displays remote files available to the user. Please use /api/remote_files instead. + * @deprecated + * @description Lists all remote files available to the user from different sources. + * + * The total count of files and directories is returned in the 'total_matches' header. + */ parameters?: { - /** @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. */ + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + /** @description Maximum number of entries to return. */ + /** @description Number of entries to skip. */ + /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ + /** @description Sort the entries by the specified field. */ + query?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + target?: string; + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + format?: components["schemas"]["RemoteFilesFormat"] | null; + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + recursive?: boolean | null; + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + disable?: components["schemas"]["RemoteFilesDisableMode"] | null; + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + writeable?: boolean | null; + limit?: number | null; + offset?: number | null; + query?: string | null; + sort_by?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["GroupCreatePayload"]; - }; - }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupListResponse"]; + "application/json": + | components["schemas"]["ListUriResponse"] + | components["schemas"]["ListJstreeResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -19017,22 +19250,24 @@ export interface operations { }; }; }; - show_group_api_groups__group_id__get: { - /** Displays information about a group. */ - parameters: { + index_api_genomes_get: { + /** Return a list of installed genomes */ + parameters?: { + /** @description If true, return genome keys with chromosome lengths */ + query?: { + /** @description If true, return genome keys with chromosome lengths */ + chrom_info?: boolean; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - group_id: string; - }; }; responses: { - /** @description Successful Response */ + /** @description Installed genomes */ 200: { content: { - "application/json": components["schemas"]["GroupResponse"]; + "application/json": string[][]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -19097,27 +19332,37 @@ export interface operations { }; }; }; - update_api_groups__group_id__put: { - /** Modifies a group. */ + show_api_genomes__id__get: { + /** Return information about build */ parameters: { + query?: { + /** @description If true, return reference data */ + reference?: boolean; + /** @description Limits size of returned data */ + num?: number; + /** @description Limits size of returned data */ + chrom?: string; + /** @description Limits size of returned data */ + low?: number; + /** @description Limits size of returned data */ + high?: number; + /** @description Format */ + format?: string; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - group_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["GroupCreatePayload"]; + /** @description Genome ID */ + id: string; }; }; responses: { - /** @description Successful Response */ + /** @description Information about genome build */ 200: { content: { - "application/json": components["schemas"]["GroupResponse"]; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -19182,19 +19427,26 @@ export interface operations { }; }; }; - delete_api_groups__group_id__delete: { - /** Delete */ + indexes_api_genomes__id__indexes_get: { + /** Return all available indexes for a genome id for provided type */ parameters: { + query?: { + /** @description Index type */ + type?: string; + /** @description Format */ + format?: string; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - group_id: string; + /** @description Genome ID */ + id: string; }; }; responses: { - /** @description Successful Response */ + /** @description Indexes for a genome id for provided type */ 200: { content: { "application/json": Record; @@ -19262,19 +19514,32 @@ export interface operations { }; }; }; - purge_api_groups__group_id__purge_post: { - /** Purge */ + sequences_api_genomes__id__sequences_get: { + /** Return raw sequence data */ parameters: { + query?: { + /** @description If true, return reference data */ + reference?: boolean; + /** @description Limits size of returned data */ + chrom?: string; + /** @description Limits size of returned data */ + low?: number; + /** @description Limits size of returned data */ + high?: number; + /** @description Format */ + format?: string; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - group_id: string; + /** @description Genome ID */ + id: string; }; }; responses: { - /** @description Successful Response */ + /** @description Raw sequence data */ 200: { content: { "application/json": Record; @@ -19342,23 +19607,103 @@ export interface operations { }; }; }; - group_roles_api_groups__group_id__roles_get: { + index_api_groups_get: { /** Displays a collection (list) of groups. */ - parameters: { + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the group. */ - group_id: string; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["GroupListResponse"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_api_groups_post: { + /** Creates a new group. */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["GroupCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupRoleListResponse"]; + "application/json": components["schemas"]["GroupListResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -19423,25 +19768,22 @@ export interface operations { }; }; }; - group_role_api_groups__group_id__roles__role_id__get: { - /** Displays information about a group role. */ + show_group_api_groups__group_id__get: { + /** Displays information about a group. */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ group_id: string; - /** @description The ID of the role. */ - role_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupRoleResponse"]; + "application/json": components["schemas"]["GroupResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -19506,25 +19848,27 @@ export interface operations { }; }; }; - update_api_groups__group_id__roles__role_id__put: { - /** Adds a role to a group */ + update_api_groups__group_id__put: { + /** Modifies a group. */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ group_id: string; - /** @description The ID of the role. */ - role_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["GroupUpdatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupRoleResponse"]; + "application/json": components["schemas"]["GroupResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -19589,25 +19933,22 @@ export interface operations { }; }; }; - delete_api_groups__group_id__roles__role_id__delete: { - /** Removes a role from a group */ + delete_api_groups__group_id__delete: { + /** Delete */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ group_id: string; - /** @description The ID of the role. */ - role_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupRoleResponse"]; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -19672,8 +20013,8 @@ export interface operations { }; }; }; - undelete_api_groups__group_id__undelete_post: { - /** Undelete */ + purge_api_groups__group_id__purge_post: { + /** Purge */ parameters: { header?: { /** @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. */ @@ -19752,11 +20093,8 @@ export interface operations { }; }; }; - group_user_api_groups__group_id__user__user_id__get: { - /** - * Displays information about a group user. - * @description Displays information about a group user. - */ + group_roles_api_groups__group_id__roles_get: { + /** Displays a collection (list) of groups. */ parameters: { header?: { /** @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. */ @@ -19765,15 +20103,13 @@ export interface operations { path: { /** @description The ID of the group. */ group_id: string; - /** @description The ID of the user. */ - user_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": components["schemas"]["GroupRoleListResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -19838,12 +20174,8 @@ export interface operations { }; }; }; - update_api_groups__group_id__user__user_id__put: { - /** - * Adds a user to a group - * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group - */ + group_role_api_groups__group_id__roles__role_id__get: { + /** Displays information about a group role. */ parameters: { header?: { /** @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. */ @@ -19852,15 +20184,15 @@ export interface operations { path: { /** @description The ID of the group. */ group_id: string; - /** @description The ID of the user. */ - user_id: string; + /** @description The ID of the role. */ + role_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": components["schemas"]["GroupRoleResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -19925,12 +20257,8 @@ export interface operations { }; }; }; - delete_api_groups__group_id__user__user_id__delete: { - /** - * Removes a user from a group - * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group - */ + update_api_groups__group_id__roles__role_id__put: { + /** Adds a role to a group */ parameters: { header?: { /** @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. */ @@ -19939,15 +20267,15 @@ export interface operations { path: { /** @description The ID of the group. */ group_id: string; - /** @description The ID of the user. */ - user_id: string; + /** @description The ID of the role. */ + role_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": components["schemas"]["GroupRoleResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -20012,12 +20340,8 @@ export interface operations { }; }; }; - group_users_api_groups__group_id__users_get: { - /** - * Displays a collection (list) of groups. - * @description GET /api/groups/{encoded_group_id}/users - * Displays a collection (list) of groups. - */ + delete_api_groups__group_id__roles__role_id__delete: { + /** Removes a role from a group */ parameters: { header?: { /** @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. */ @@ -20026,13 +20350,15 @@ export interface operations { path: { /** @description The ID of the group. */ group_id: string; + /** @description The ID of the role. */ + role_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupUserListResponse"]; + "application/json": components["schemas"]["GroupRoleResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -20097,28 +20423,22 @@ export interface operations { }; }; }; - group_user_api_groups__group_id__users__user_id__get: { - /** - * Displays information about a group user. - * @description Displays information about a group user. - */ + undelete_api_groups__group_id__undelete_post: { + /** Undelete */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ group_id: string; - /** @description The ID of the user. */ - user_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -20183,11 +20503,10 @@ export interface operations { }; }; }; - update_api_groups__group_id__users__user_id__put: { + group_user_api_groups__group_id__user__user_id__get: { /** - * Adds a user to a group - * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group + * Displays information about a group user. + * @description Displays information about a group user. */ parameters: { header?: { @@ -20270,11 +20589,11 @@ export interface operations { }; }; }; - delete_api_groups__group_id__users__user_id__delete: { + update_api_groups__group_id__user__user_id__put: { /** - * Removes a user from a group - * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group + * Adds a user to a group + * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Adds a user to a group */ parameters: { header?: { @@ -20357,28 +20676,29 @@ export interface operations { }; }; }; - search_forum_api_help_forum_search_get: { + delete_api_groups__group_id__user__user_id__delete: { /** - * Search the Galaxy Help forum. - * @description Search the Galaxy Help forum using the Discourse API. - * - * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. + * Removes a user from a group + * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Removes a user from a group */ parameters: { - query: { - /** @description Search query to use for searching the Galaxy Help forum. */ - query: string; - }; header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["HelpForumSearchResponse"]; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -20443,94 +20763,27 @@ export interface operations { }; }; }; - index_api_histories_get: { - /** Returns histories available to the current user. */ - parameters?: { - /** @description The maximum number of items to return. */ - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - /** @description Whether to include archived histories. */ - /** @description Sort index by this specified attribute */ - /** @description Sort in descending order? */ - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `name` - * : The history's name. - * - * `annotation` - * : The history's annotation. (The tag `a` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The history's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Historys: `title`, `description`, `slug`, `tag`. - */ - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - /** - * @deprecated - * @description Whether to return only deleted items. - */ - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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?: { - limit?: number | null; - offset?: number | null; - show_own?: boolean; - show_published?: boolean; - show_shared?: boolean; - show_archived?: boolean | null; - sort_by?: "create_time" | "name" | "update_time" | "username"; - sort_desc?: boolean; - search?: string | null; - all?: boolean | null; - deleted?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @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. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + group_users_api_groups__group_id__users_get: { + /** + * Displays a collection (list) of groups. + * @description GET /api/groups/{encoded_group_id}/users + * Displays a collection (list) of groups. + */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the group. */ + group_id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": components["schemas"]["GroupUserListResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -20595,39 +20848,28 @@ export interface operations { }; }; }; - create_api_histories_post: { + group_user_api_groups__group_id__users__user_id__get: { /** - * Creates a new history. - * @description The new history can also be copied form a existing history or imported from an archive or URL. + * Displays information about a group user. + * @description Displays information about a group user. */ - parameters?: { - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": components["schemas"]["Body_create_api_histories_post"]; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["JobImportHistoryResponse"] - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -20692,51 +20934,29 @@ export interface operations { }; }; }; - get_archived_histories_api_histories_archived_get: { + update_api_groups__group_id__users__user_id__put: { /** - * Get a list of all archived histories for the current user. - * @description Get a list of all archived histories for the current user. - * - * Archived histories are histories are not part of the active histories of the user but they can be accessed using this endpoint. + * Adds a user to a group + * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Adds a user to a group */ - 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. */ - /** @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. */ - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["ArchivedHistorySummary"] - | components["schemas"]["ArchivedHistoryDetailed"] - | Record - )[]; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -20801,37 +21021,29 @@ export interface operations { }; }; }; - batch_delete_api_histories_batch_delete_put: { - /** Marks several histories with the given IDs 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; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + delete_api_groups__group_id__users__user_id__delete: { + /** + * Removes a user from a group + * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Removes a user from a group + */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["DeleteHistoriesPayload"]; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -20896,36 +21108,28 @@ export interface operations { }; }; }; - batch_undelete_api_histories_batch_undelete_put: { - /** Marks several histories with the given IDs as undeleted. */ - parameters?: { - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + search_forum_api_help_forum_search_get: { + /** + * Search the Galaxy Help forum. + * @description Search the Galaxy Help forum using the Discourse API. + * + * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. + */ + parameters: { + query: { + /** @description Search query to use for searching the Galaxy Help forum. */ + query: string; }; header?: { /** @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. */ "run-as"?: string | null; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["UndeleteHistoriesPayload"]; - }; - }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": components["schemas"]["HelpForumSearchResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -20990,10 +21194,80 @@ export interface operations { }; }; }; - count_api_histories_count_get: { - /** Returns number of histories for the current user. */ + index_api_histories_get: { + /** Returns histories available to the current user. */ parameters?: { - /** @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. */ + /** @description The maximum number of items to return. */ + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + /** @description Whether to include archived histories. */ + /** @description Sort index by this specified attribute */ + /** @description Sort in descending order? */ + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `name` + * : The history's name. + * + * `annotation` + * : The history's annotation. (The tag `a` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The history's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Historys: `title`, `description`, `slug`, `tag`. + */ + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + /** + * @deprecated + * @description Whether to return only deleted items. + */ + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { + limit?: number | null; + offset?: number | null; + show_own?: boolean; + show_published?: boolean; + show_shared?: boolean; + show_archived?: boolean | null; + sort_by?: "create_time" | "name" | "update_time" | "username"; + sort_desc?: boolean; + search?: string | null; + all?: boolean | null; + deleted?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; @@ -21003,7 +21277,11 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": number; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -21068,30 +21346,15 @@ export interface operations { }; }; }; - index_deleted_api_histories_deleted_get: { - /** Returns deleted histories for the current user. */ + create_api_histories_post: { + /** + * Creates a new history. + * @description The new history can also be copied form a existing history or imported from an archive or URL. + */ parameters?: { - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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?: { - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - all?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ @@ -21102,15 +21365,20 @@ export interface operations { "run-as"?: string | null; }; }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": components["schemas"]["Body_create_api_histories_post"]; + }; + }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( + "application/json": + | components["schemas"]["JobImportHistoryResponse"] | components["schemas"]["CustomHistoryView"] | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + | components["schemas"]["HistorySummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -21175,32 +21443,51 @@ 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: { + get_archived_histories_api_histories_archived_get: { + /** + * Get a list of all archived histories for the current user. + * @description Get a list of all archived histories for the current user. + * + * 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. */ + /** @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. */ query?: { /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": ( + | components["schemas"]["ArchivedHistorySummary"] + | components["schemas"]["ArchivedHistoryDetailed"] + | Record + )[]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -21265,12 +21552,13 @@ export interface operations { }; }; }; - create_from_store_api_histories_from_store_post: { - /** Create histories from a model store. */ + batch_delete_api_histories_batch_delete_put: { + /** Marks several histories with the given IDs 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; /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ @@ -21283,17 +21571,18 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["CreateHistoryFromStore"]; + "application/json": components["schemas"]["DeleteHistoriesPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": + "application/json": ( | components["schemas"]["CustomHistoryView"] | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + | components["schemas"]["HistorySummary"] + )[]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -21358,10 +21647,17 @@ export interface operations { }; }; }; - create_from_store_async_api_histories_from_store_async_post: { - /** Launch a task to create histories from a model store. */ + batch_undelete_api_histories_batch_undelete_put: { + /** Marks several histories with the given IDs as undeleted. */ parameters?: { - /** @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. */ + /** @description View to be passed to the serializer */ + /** @description Comma-separated list of keys to be passed to the serializer */ + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; @@ -21369,14 +21665,18 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["CreateHistoryFromStore"]; + "application/json": components["schemas"]["UndeleteHistoriesPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -21441,17 +21741,10 @@ export interface operations { }; }; }; - show_recent_api_histories_most_recently_used_get: { - /** Returns the most recently used history of the user. */ + count_api_histories_count_get: { + /** Returns number of histories for the current user. */ parameters?: { - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + /** @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?: { /** @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. */ "run-as"?: string | null; @@ -21461,10 +21754,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": number; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -21529,9 +21819,10 @@ export interface operations { }; }; }; - published_api_histories_published_get: { - /** Return all histories that are published. */ + index_deleted_api_histories_deleted_get: { + /** Returns deleted histories for the current user. */ parameters?: { + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ /** @description The value to filter by. */ /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ @@ -21540,6 +21831,8 @@ export interface operations { /** @description View to be passed to the serializer */ /** @description Comma-separated list of keys to be passed to the serializer */ query?: { + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + all?: boolean | null; /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ q?: string[] | null; /** @description The value to filter by. */ @@ -21633,27 +21926,10 @@ export interface operations { }; }; }; - shared_with_me_api_histories_shared_with_me_get: { - /** Return all histories that are shared with the current user. */ - parameters?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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 */ + undelete_api_histories_deleted__history_id__undelete_post: { + /** Restores a deleted history with the given ID (that hasn't been purged). */ + parameters: { query?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ @@ -21663,16 +21939,19 @@ export interface operations { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( + "application/json": | components["schemas"]["CustomHistoryView"] | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + | components["schemas"]["HistorySummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -21737,9 +22016,11 @@ export interface operations { }; }; }; - history_api_histories__history_id__get: { - /** Returns the history with the given ID. */ - parameters: { + 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?: { /** @description View to be passed to the serializer */ view?: string | null; @@ -21750,9 +22031,479 @@ export interface operations { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryFromStore"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_from_store_async_api_histories_from_store_async_post: { + /** Launch a task to create histories from a model store. */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryFromStore"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + 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?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + published_api_histories_published_get: { + /** Return all histories that are published. */ + parameters?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + shared_with_me_api_histories_shared_with_me_get: { + /** Return all histories that are shared with the current user. */ + parameters?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + /** @description The value to filter by. */ + /** @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?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_api_histories__history_id__get: { + /** Returns the history with the given ID. */ + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; }; responses: { @@ -21922,15 +22673,753 @@ export interface operations { }; }; }; - delete_api_histories__history_id__delete: { - /** Marks the history with the given ID as deleted. */ + delete_api_histories__history_id__delete: { + /** Marks the history with the given ID as deleted. */ + parameters: { + query?: { + purge?: boolean; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryPayload"] | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + archive_history_api_histories__history_id__archive_post: { + /** + * Archive a history. + * @description Marks the given history as 'archived' and returns the history. + * + * Archiving a history will remove it from the list of active histories of the user but it will still be + * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. + * + * Associating an export record: + * + * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the + * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and + * must be in the ready state. + * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. + * + * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. + * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ArchiveHistoryRequestPayload"] | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["ArchivedHistorySummary"] + | components["schemas"]["ArchivedHistoryDetailed"] + | Record; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + restore_archived_history_api_histories__history_id__archive_restore_put: { + /** + * Restore an archived history. + * @description Restores an archived history and returns it. + * + * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). + * + * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them + * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export + * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. + */ + parameters: { + query?: { + /** @description If true, the history will be un-archived even if it has an associated archive export record and was purged. */ + force?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + citations_api_histories__history_id__citations_get: { + /** Return all the citations for the tools used to produce the datasets in the history. */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": Record[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__index: { + /** + * Returns the contents of the given history. + * @description Return a list of `HDA`/`HDCA` data for the history with the given ``ID``. + * + * - The contents can be filtered and queried using the appropriate parameters. + * - The amount of information returned for each item can be customized. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ + parameters: { + query?: { + /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ + v?: string | null; + /** + * @deprecated + * @description Legacy name for the `dataset_details` parameter. + */ + details?: string | null; + /** + * @deprecated + * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. + */ + ids?: string | null; + /** + * @deprecated + * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. + */ + types?: string[] | null; + /** + * @deprecated + * @description Whether to return deleted or undeleted datasets only. Leave unset for both. + */ + deleted?: boolean | null; + /** + * @deprecated + * @description Whether to return visible or hidden datasets only. Leave unset for both. + */ + visible?: boolean | null; + /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ + shareable?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description The contents of the history that match the query. */ + 200: { + content: { + "application/json": components["schemas"]["HistoryContentsResult"]; + "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + update_batch_api_histories__history_id__contents_put: { + /** + * Batch update specific properties of a set items contained in the given History. + * @description Batch update specific properties of a set items contained in the given History. + * + * If you provide an invalid/unknown property key the request will not fail, but no changes + * will be made to the items. + */ + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryContentsBatchPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["HistoryContentsResult"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__create: { + /** + * Create a new `HDA` or `HDCA` in the given History. + * @deprecated + * @description Create a new `HDA` or `HDCA` in the given History. + */ + parameters: { + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"] | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryContentPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + | ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_contents__archive: { + /** + * Build and return a compressed archive of the selected history contents. + * @description Build and return a compressed archive of the selected history contents. + * + * **Note**: this is a volatile endpoint and settings and behavior may change. + */ parameters: { query?: { - purge?: boolean; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description The name that the Archive will have (defaults to history name). */ + filename?: string | null; + /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ + dry_run?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; }; header?: { /** @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. */ @@ -21941,19 +23430,11 @@ export interface operations { history_id: string; }; }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryPayload"] | null; - }; - }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -22018,25 +23499,28 @@ export interface operations { }; }; }; - archive_history_api_histories__history_id__archive_post: { + history_contents__archive_named: { /** - * Archive a history. - * @description Marks the given history as 'archived' and returns the history. - * - * Archiving a history will remove it from the list of active histories of the user but it will still be - * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. - * - * Associating an export record: - * - * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the - * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and - * must be in the ready state. - * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. + * Build and return a compressed archive of the selected history contents. + * @description Build and return a compressed archive of the selected history contents. * - * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. - * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. + * **Note**: this is a volatile endpoint and settings and behavior may change. */ parameters: { + query?: { + /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ + dry_run?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; @@ -22044,21 +23528,20 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ArchiveHistoryRequestPayload"] | null; + /** @description The name that the Archive will have (defaults to history name). */ + filename: string; + /** + * @deprecated + * @description Output format of the archive. + */ + format: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["ArchivedHistorySummary"] - | components["schemas"]["ArchivedHistoryDetailed"] - | Record; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -22123,21 +23606,19 @@ export interface operations { }; }; }; - restore_archived_history_api_histories__history_id__archive_restore_put: { + bulk_operation_api_histories__history_id__contents_bulk_put: { /** - * Restore an archived history. - * @description Restores an archived history and returns it. - * - * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). + * Executes an operation on a set of items contained in the given History. + * @description Executes an operation on a set of items contained in the given History. * - * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them - * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export - * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. + * The items to be processed can be explicitly set or determined by a dynamic query. */ parameters: { query?: { - /** @description If true, the history will be un-archived even if it has an associated archive export record and was purged. */ - force?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; }; header?: { /** @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. */ @@ -22148,14 +23629,16 @@ export interface operations { history_id: string; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["HistoryContentBulkOperationPayload"]; + }; + }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["HistoryContentBulkOperationResult"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -22220,25 +23703,27 @@ export interface operations { }; }; }; - citations_api_histories__history_id__citations_get: { - /** Return all the citations for the tools used to produce the datasets in the history. */ + history_contents__download_collection: { + /** + * Download the content of a dataset collection as a `zip` archive. + * @description Download the content of a history dataset collection as a `zip` archive + * while maintaining approximate collection structure. + */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { + /** @description The ID of the `HDCA`. */ + id: string; /** @description The encoded database identifier of the History. */ - history_id: string; + history_id: string | null; }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": Record[]; - }; - }; + 200: never; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { @@ -22301,62 +23786,9 @@ export interface operations { }; }; }; - history_contents__index: { - /** - * Returns the contents of the given history. - * @description Return a list of `HDA`/`HDCA` data for the history with the given ``ID``. - * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ + materialize_dataset_api_histories__history_id__contents_datasets__id__materialize_post: { + /** Materialize a deferred dataset into real, usable dataset. */ parameters: { - query?: { - /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ - v?: string | null; - /** - * @deprecated - * @description Legacy name for the `dataset_details` parameter. - */ - details?: string | null; - /** - * @deprecated - * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. - */ - ids?: string | null; - /** - * @deprecated - * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. - */ - types?: string[] | null; - /** - * @deprecated - * @description Whether to return deleted or undeleted datasets only. Leave unset for both. - */ - deleted?: boolean | null; - /** - * @deprecated - * @description Whether to return visible or hidden datasets only. Leave unset for both. - */ - visible?: boolean | null; - /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ - shareable?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -22364,14 +23796,15 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; }; }; responses: { - /** @description The contents of the history that match the query. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["HistoryContentsResult"]; - "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -22436,21 +23869,12 @@ export interface operations { }; }; }; - update_batch_api_histories__history_id__contents_put: { + update_permissions_api_histories__history_id__contents__dataset_id__permissions_put: { /** - * Batch update specific properties of a set items contained in the given History. - * @description Batch update specific properties of a set items contained in the given History. - * - * If you provide an invalid/unknown property key the request will not fail, but no changes - * will be made to the items. + * Set permissions of the given history dataset to the given role ids. + * @description Set permissions of the given history dataset to the given role ids. */ parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -22458,18 +23882,20 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + dataset_id: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["UpdateHistoryContentsBatchPayload"]; + "application/json": Record; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["HistoryContentsResult"]; + "application/json": components["schemas"]["DatasetAssociationRoles"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -22534,54 +23960,39 @@ export interface operations { }; }; }; - history_contents__create: { + history_contents_display_api_histories__history_id__contents__history_content_id__display_get: { /** - * Create a new `HDA` or `HDCA` in the given History. - * @deprecated - * @description Create a new `HDA` or `HDCA` in the given History. + * Displays (preview) or downloads dataset content. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. */ parameters: { query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"] | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ + offset?: number | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryContentPayload"]; + /** @description The ID of the History Dataset. */ + history_content_id: string; + history_id: string | null; }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - | ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; - }; - }; + 200: never; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { @@ -22644,37 +24055,34 @@ export interface operations { }; }; }; - history_contents__archive: { + history_contents_display_api_histories__history_id__contents__history_content_id__display_head: { /** - * Build and return a compressed archive of the selected history contents. - * @description Build and return a compressed archive of the selected history contents. - * - * **Note**: this is a volatile endpoint and settings and behavior may change. + * Check if dataset content can be previewed or downloaded. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. */ parameters: { query?: { - /** @description The name that the Archive will have (defaults to history name). */ + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ filename?: string | null; - /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ - dry_run?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; + history_id: string | null; }; }; responses: { @@ -22746,28 +24154,9 @@ export interface operations { }; }; }; - history_contents__archive_named: { - /** - * Build and return a compressed archive of the selected history contents. - * @description Build and return a compressed archive of the selected history contents. - * - * **Note**: this is a volatile endpoint and settings and behavior may change. - */ + extra_files_history_api_histories__history_id__contents__history_content_id__extra_files_get: { + /** Get the list of extra files/directories associated with a dataset. */ parameters: { - query?: { - /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ - dry_run?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -22775,20 +24164,15 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The name that the Archive will have (defaults to history name). */ - filename: string; - /** - * @deprecated - * @description Output format of the archive. - */ - format: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["DatasetExtraFiles"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -22853,19 +24237,12 @@ export interface operations { }; }; }; - bulk_operation_api_histories__history_id__contents_bulk_put: { - /** - * Executes an operation on a set of items contained in the given History. - * @description Executes an operation on a set of items contained in the given History. - * - * The items to be processed can be explicitly set or determined by a dynamic query. - */ + history_contents__get_metadata_file: { + /** Returns the metadata file associated with this history item. */ parameters: { - query?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; + query: { + /** @description The name of the metadata file to retrieve. */ + metadata_file: string; }; header?: { /** @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. */ @@ -22874,20 +24251,13 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["HistoryContentBulkOperationPayload"]; + /** @description The ID of the History Dataset. */ + history_content_id: string; }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["HistoryContentBulkOperationResult"]; - }; - }; + 200: never; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { @@ -22950,27 +24320,25 @@ export interface operations { }; }; }; - history_contents__download_collection: { - /** - * Download the content of a dataset collection as a `zip` archive. - * @description Download the content of a history dataset collection as a `zip` archive - * while maintaining approximate collection structure. - */ + index_api_histories__history_id__contents__history_content_id__tags_get: { + /** Show tags based on history_content_id */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; - /** @description The encoded database identifier of the History. */ - history_id: string | null; + history_content_id: string; + history_id: string; }; }; responses: { /** @description Successful Response */ - 200: never; + 200: { + content: { + "application/json": components["schemas"]["ItemTagsListResponse"]; + }; + }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { @@ -23033,25 +24401,24 @@ export interface operations { }; }; }; - materialize_dataset_api_histories__history_id__contents_datasets__id__materialize_post: { - /** Materialize a deferred dataset into real, usable dataset. */ + show_api_histories__history_id__contents__history_content_id__tags__tag_name__get: { + /** Show tag based on history_content_id */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ + history_content_id: string; + tag_name: string; history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -23116,33 +24483,29 @@ export interface operations { }; }; }; - update_permissions_api_histories__history_id__contents__dataset_id__permissions_put: { - /** - * Set permissions of the given history dataset to the given role ids. - * @description Set permissions of the given history dataset to the given role ids. - */ + update_api_histories__history_id__contents__history_content_id__tags__tag_name__put: { + /** Update tag based on history_content_id */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ + history_content_id: string; + tag_name: string; history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - dataset_id: string; }; }; requestBody: { content: { - "application/json": Record; + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatasetAssociationRoles"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -23207,136 +24570,29 @@ export interface operations { }; }; }; - history_contents_display_api_histories__history_id__contents__history_content_id__display_get: { - /** - * Displays (preview) or downloads dataset content. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ + create_api_histories__history_id__contents__history_content_id__tags__tag_name__post: { + /** Create tag based on history_content_id */ parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ history_content_id: string; - history_id: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + tag_name: string; + history_id: string; }; }; - }; - history_contents_display_api_histories__history_id__contents__history_content_id__display_head: { - /** - * Check if dataset content can be previewed or downloaded. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ - parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; - history_id: string | null; + requestBody?: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -23401,25 +24657,24 @@ export interface operations { }; }; }; - extra_files_history_api_histories__history_id__contents__history_content_id__extra_files_get: { - /** Get the list of extra files/directories associated with a dataset. */ + delete_api_histories__history_id__contents__history_content_id__tags__tag_name__delete: { + /** Delete tag based on history_content_id */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the History Dataset. */ history_content_id: string; + tag_name: string; + history_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatasetExtraFiles"]; + "application/json": boolean; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -23484,27 +24739,49 @@ export interface operations { }; }; }; - history_contents__get_metadata_file: { - /** Returns the metadata file associated with this history item. */ + history_contents__show_legacy: { + /** + * Return detailed information about an HDA within a history. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. + * @deprecated + * @description Return detailed information about an `HDA` or `HDCA` within a history. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ parameters: { - query: { - /** @description The name of the metadata file to retrieve. */ - metadata_file: string; + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; + /** @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. */ + fuzzy_count?: number | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the History Dataset. */ - history_content_id: string; }; }; responses: { /** @description Successful Response */ - 200: never; + 200: { + content: { + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; + }; + }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { @@ -23567,23 +24844,48 @@ export interface operations { }; }; }; - index_api_histories__history_id__contents__history_content_id__tags_get: { - /** Show tags based on history_content_id */ + history_contents__update_legacy: { + /** + * Updates the values for the history content item with the given ``ID`` and query specified type. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. + * @deprecated + * @description Updates the values for the history content item with the given ``ID``. + */ parameters: { + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - history_content_id: string; + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsListResponse"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -23648,30 +24950,64 @@ export interface operations { }; }; }; - show_api_histories__history_id__contents__history_content_id__tags__tag_name__get: { - /** Show tag based on history_content_id */ + history_contents__delete_legacy: { + /** + * Delete the history dataset with the given ``ID``. + * @description Delete the history content with the given ``ID`` and query specified type (defaults to dataset). + * + * **Note**: Currently does not stop any active jobs for which this dataset is an output. + */ parameters: { + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; + /** + * @deprecated + * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. + */ + purge?: boolean | null; + /** + * @deprecated + * @description When deleting a dataset collection, whether to also delete containing datasets. + */ + recursive?: boolean | null; + /** + * @deprecated + * @description Whether to stop the creating job if all outputs of the job have been deleted. + */ + stop_job?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - history_content_id: string; - tag_name: string; + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentPayload"]; }; }; responses: { - /** @description Successful Response */ + /** @description Request has been executed. */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + /** @description Request accepted, processing will finish later. */ 202: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; /** @description User does not have permissions to run jobs as another user. */ @@ -23730,29 +25066,28 @@ export interface operations { }; }; }; - update_api_histories__history_id__contents__history_content_id__tags__tag_name__put: { - /** Update tag based on history_content_id */ + validate_api_histories__history_id__contents__id__validate_put: { + /** + * Validates the metadata associated with a dataset within a History. + * @description Validates the metadata associated with a dataset within a History. + */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - history_content_id: string; - tag_name: string; + /** @description The encoded database identifier of the History. */ history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -23817,29 +25152,80 @@ export interface operations { }; }; }; - create_api_histories__history_id__contents__history_content_id__tags__tag_name__post: { - /** Create tag based on history_content_id */ + history_contents__index_typed: { + /** + * Returns the contents of the given history filtered by type. + * @description Return a list of either `HDA`/`HDCA` data for the history with the given ``ID``. + * + * - The contents can be filtered and queried using the appropriate parameters. + * - The amount of information returned for each item can be customized. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ parameters: { + query?: { + /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ + v?: string | null; + /** + * @deprecated + * @description Legacy name for the `dataset_details` parameter. + */ + details?: string | null; + /** + * @deprecated + * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. + */ + ids?: string | null; + /** + * @deprecated + * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. + */ + types?: string[] | null; + /** + * @deprecated + * @description Whether to return deleted or undeleted datasets only. Leave unset for both. + */ + deleted?: boolean | null; + /** + * @deprecated + * @description Whether to return visible or hidden datasets only. Leave unset for both. + */ + visible?: boolean | null; + /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ + shareable?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - history_content_id: string; - tag_name: string; + /** @description The encoded database identifier of the History. */ history_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": + | components["schemas"]["HistoryContentsResult"] + | components["schemas"]["HistoryContentsWithStatsResult"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -23904,24 +25290,53 @@ export interface operations { }; }; }; - delete_api_histories__history_id__contents__history_content_id__tags__tag_name__delete: { - /** Delete tag based on history_content_id */ + history_contents__create_typed: { + /** + * Create a new `HDA` or `HDCA` in the given History. + * @description Create a new `HDA` or `HDCA` in the given History. + */ parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - history_content_id: string; - tag_name: string; + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryContentPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": boolean; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + | ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -23986,18 +25401,15 @@ export interface operations { }; }; }; - history_contents__show_legacy: { + history_contents__show: { /** - * Return detailed information about an HDA within a history. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. - * @deprecated + * Return detailed information about a specific HDA or HDCA with the given `ID` within a history. * @description Return detailed information about an `HDA` or `HDCA` within a history. * * **Note**: Anonymous users are allowed to get their current history contents. */ parameters: { query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; /** @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. */ fuzzy_count?: number | null; /** @description View to be passed to the serializer */ @@ -24014,6 +25426,8 @@ export interface operations { id: string; /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; }; responses: { @@ -24024,6 +25438,7 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; @@ -24090,16 +25505,13 @@ export interface operations { }; }; }; - history_contents__update_legacy: { + history_contents__update_typed: { /** - * Updates the values for the history content item with the given ``ID`` and query specified type. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. - * @deprecated + * Updates the values for the history content item with the given ``ID`` and path specified type. * @description Updates the values for the history content item with the given ``ID``. */ parameters: { query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ @@ -24114,6 +25526,8 @@ export interface operations { history_id: string; /** @description The ID of the item (`HDA`/`HDCA`) */ id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; }; requestBody: { @@ -24129,6 +25543,7 @@ export interface operations { | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; @@ -24195,17 +25610,15 @@ export interface operations { }; }; }; - history_contents__delete_legacy: { + history_contents__delete_typed: { /** - * Delete the history dataset with the given ``ID``. - * @description Delete the history content with the given ``ID`` and query specified type (defaults to dataset). + * Delete the history content with the given ``ID`` and path specified type. + * @description Delete the history content with the given ``ID`` and path specified type. * * **Note**: Currently does not stop any active jobs for which this dataset is an output. */ parameters: { query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; /** * @deprecated * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. @@ -24235,6 +25648,8 @@ export interface operations { history_id: string; /** @description The ID of the item (`HDA`/`HDCA`) */ id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; }; requestBody?: { @@ -24311,10 +25726,15 @@ export interface operations { }; }; }; - validate_api_histories__history_id__contents__id__validate_put: { + show_jobs_summary_api_histories__history_id__contents__type_s__id__jobs_summary_get: { /** - * Validates the metadata associated with a dataset within a History. - * @description Validates the metadata associated with a dataset within a History. + * Return detailed information about an `HDA` or `HDCAs` jobs. + * @description Return detailed information about an `HDA` or `HDCAs` jobs. + * + * **Warning**: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. */ parameters: { header?: { @@ -24326,13 +25746,18 @@ export interface operations { history_id: string; /** @description The ID of the item (`HDA`/`HDCA`) */ id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": + | components["schemas"]["JobStateSummary"] + | components["schemas"]["ImplicitCollectionJobsStateSummary"] + | components["schemas"]["WorkflowInvocationStateSummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -24397,62 +25822,9 @@ export interface operations { }; }; }; - history_contents__index_typed: { - /** - * Returns the contents of the given history filtered by type. - * @description Return a list of either `HDA`/`HDCA` data for the history with the given ``ID``. - * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ + prepare_store_download_api_histories__history_id__contents__type_s__id__prepare_store_download_post: { + /** Prepare a dataset or dataset collection for export-style download. */ parameters: { - query?: { - /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ - v?: string | null; - /** - * @deprecated - * @description Legacy name for the `dataset_details` parameter. - */ - details?: string | null; - /** - * @deprecated - * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. - */ - ids?: string | null; - /** - * @deprecated - * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. - */ - types?: string[] | null; - /** - * @deprecated - * @description Whether to return deleted or undeleted datasets only. Leave unset for both. - */ - deleted?: boolean | null; - /** - * @deprecated - * @description Whether to return visible or hidden datasets only. Leave unset for both. - */ - visible?: boolean | null; - /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ - shareable?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -24460,17 +25832,22 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; /** @description The type of the target history element. */ type: components["schemas"]["HistoryContentType"]; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["StoreExportPayload"]; + }; + }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["HistoryContentsResult"] - | components["schemas"]["HistoryContentsWithStatsResult"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -24535,18 +25912,9 @@ export interface operations { }; }; }; - history_contents__create_typed: { - /** - * Create a new `HDA` or `HDCA` in the given History. - * @description Create a new `HDA` or `HDCA` in the given History. - */ + write_store_api_histories__history_id__contents__type_s__id__write_store_post: { + /** Prepare a dataset or dataset collection for export-style download and write to supplied URI. */ parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -24554,32 +25922,22 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; /** @description The type of the target history element. */ type: components["schemas"]["HistoryContentType"]; }; }; requestBody: { content: { - "application/json": components["schemas"]["CreateHistoryContentPayload"]; + "application/json": components["schemas"]["WriteStoreToPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - | ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -24644,17 +26002,16 @@ export interface operations { }; }; }; - history_contents__show: { + create_from_store_api_histories__history_id__contents_from_store_post: { /** - * Return detailed information about a specific HDA or HDCA with the given `ID` within a history. - * @description Return detailed information about an `HDA` or `HDCA` within a history. - * - * **Note**: Anonymous users are allowed to get their current history contents. + * Create contents from store. + * @description Create history contents from model store. + * Input can be a tarfile created with build_objects script distributed + * with galaxy-data, from an exported history with files stripped out, + * or hand-crafted JSON dictionary. */ parameters: { query?: { - /** @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. */ - fuzzy_count?: number | null; /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ @@ -24665,24 +26022,27 @@ export interface operations { "run-as"?: string | null; }; path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryContentFromStore"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": + "application/json": ( | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + | components["schemas"]["HDCASummary"] + )[]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -24747,18 +26107,9 @@ export interface operations { }; }; }; - history_contents__update_typed: { - /** - * Updates the values for the history content item with the given ``ID`` and path specified type. - * @description Updates the values for the history content item with the given ``ID``. - */ + get_custom_builds_metadata_api_histories__history_id__custom_builds_metadata_get: { + /** Returns meta data for custom builds. */ parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -24766,27 +26117,13 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + "application/json": components["schemas"]["CustomBuildsMetadataResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -24851,35 +26188,12 @@ export interface operations { }; }; }; - history_contents__delete_typed: { + disable_link_access_api_histories__history_id__disable_link_access_put: { /** - * Delete the history content with the given ``ID`` and path specified type. - * @description Delete the history content with the given ``ID`` and path specified type. - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. + * Makes this item inaccessible by a URL link. + * @description Makes this item inaccessible by a URL link and return the current sharing status. */ parameters: { - query?: { - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - purge?: boolean | null; - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - recursive?: boolean | null; - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - stop_job?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -24887,28 +26201,19 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentPayload"]; }; }; responses: { - /** @description Request has been executed. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Request accepted, processing will finish later. */ + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description User does not have permissions to run jobs as another user. */ @@ -24967,15 +26272,10 @@ export interface operations { }; }; }; - show_jobs_summary_api_histories__history_id__contents__type_s__id__jobs_summary_get: { + enable_link_access_api_histories__history_id__enable_link_access_put: { /** - * Return detailed information about an `HDA` or `HDCAs` jobs. - * @description Return detailed information about an `HDA` or `HDCAs` jobs. - * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. */ parameters: { header?: { @@ -24985,20 +26285,13 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["JobStateSummary"] - | components["schemas"]["ImplicitCollectionJobsStateSummary"] - | components["schemas"]["WorkflowInvocationStateSummary"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -25063,9 +26356,20 @@ export interface operations { }; }; }; - prepare_store_download_api_histories__history_id__contents__type_s__id__prepare_store_download_post: { - /** Prepare a dataset or dataset collection for export-style download. */ + get_history_exports_api_histories__history_id__exports_get: { + /** + * Get previous history exports. + * @description By default the legacy job-based history exports (jeha) are returned. + * + * Change the `accept` content type header to return the new task-based history exports. + */ parameters: { + query?: { + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + }; header?: { /** @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. */ "run-as"?: string | null; @@ -25073,22 +26377,14 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["StoreExportPayload"]; }; }; responses: { - /** @description Successful Response */ + /** @description A list of history exports */ 200: { content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": components["schemas"]["JobExportHistoryArchiveListResponse"]; + "application/vnd.galaxy.task.export+json": components["schemas"]["ExportTaskListResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -25153,8 +26449,23 @@ export interface operations { }; }; }; - write_store_api_histories__history_id__contents__type_s__id__write_store_post: { - /** Prepare a dataset or dataset collection for export-style download and write to supplied URI. */ + archive_export_api_histories__history_id__exports_put: { + /** + * Start job (if needed) to create history export for corresponding history. + * @deprecated + * @description This will start a job to create a history export archive. + * + * Calling this endpoint multiple times will return the 202 status code until the archive + * has been completely generated and is ready to download. When ready, it will return + * the 200 status code along with the download link information. + * + * If the history will be exported to a `directory_uri`, instead of returning the download + * link information, the Job ID will be returned so it can be queried to determine when + * the file has been written. + * + * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or + * `/api/histories/{id}/write_store` instead. + */ parameters: { header?: { /** @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. */ @@ -25163,24 +26474,106 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; }; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["WriteStoreToPayload"]; + "application/json": components["schemas"]["ExportHistoryArchivePayload"] | null; }; }; responses: { - /** @description Successful Response */ + /** @description Object containing url to fetch export from. */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": + | components["schemas"]["JobExportHistoryArchiveModel"] + | components["schemas"]["JobIdResponse"]; }; }; + /** @description The exported archive file is not ready yet. */ + 202: never; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + history_archive_download_api_histories__history_id__exports__jeha_id__get: { + /** + * If ready and available, return raw contents of exported history as a downloadable archive. + * @deprecated + * @description See ``PUT /api/histories/{id}/exports`` to initiate the creation + * of the history export - when ready, that route will return 200 status + * code (instead of 202) and this route can be used to download the archive. + * + * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or + * `/api/histories/{id}/write_store` instead. + */ + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the specific Job Export History Association or `latest` (default) to download the last generated archive. */ + jeha_id: string | "latest"; + }; + }; + responses: { + /** @description The archive file containing the History. */ + 200: never; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { @@ -25243,20 +26636,22 @@ export interface operations { }; }; }; - create_from_store_api_histories__history_id__contents_from_store_post: { + index_jobs_summary_api_histories__history_id__jobs_summary_get: { /** - * Create contents from store. - * @description Create history contents from model store. - * Input can be a tarfile created with build_objects script distributed - * with galaxy-data, from an exported history with files stripped out, - * or hand-crafted JSON dictionary. + * Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. + * @description Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. + * + * **Warning**: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. */ parameters: { query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description A comma-separated list of encoded ids of job summary objects to return - if `ids` is specified types must also be specified and have same length. */ + ids?: string | null; + /** @description A comma-separated list of type of object represented by elements in the `ids` array - any of `Job`, `ImplicitCollectionJob`, or `WorkflowInvocation`. */ + types?: string | null; }; header?: { /** @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. */ @@ -25267,21 +26662,14 @@ export interface operations { history_id: string; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryContentFromStore"]; - }; - }; responses: { /** @description Successful Response */ 200: { content: { "application/json": ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] + | components["schemas"]["JobStateSummary"] + | components["schemas"]["ImplicitCollectionJobsStateSummary"] + | components["schemas"]["WorkflowInvocationStateSummary"] )[]; }; }; @@ -25347,8 +26735,8 @@ export interface operations { }; }; }; - get_custom_builds_metadata_api_histories__history_id__custom_builds_metadata_get: { - /** Returns meta data for custom builds. */ + materialize_to_history_api_histories__history_id__materialize_post: { + /** Materialize a deferred library or HDA dataset into real, usable dataset in specified history. */ parameters: { header?: { /** @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. */ @@ -25359,11 +26747,16 @@ export interface operations { history_id: string; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["MaterializeDatasetInstanceAPIRequest"]; + }; + }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["CustomBuildsMetadataResponse"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -25428,11 +26821,8 @@ export interface operations { }; }; }; - disable_link_access_api_histories__history_id__disable_link_access_put: { - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ + prepare_store_download_api_histories__history_id__prepare_store_download_post: { + /** Return a short term storage token to monitor download of the history. */ parameters: { header?: { /** @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. */ @@ -25443,11 +26833,16 @@ export interface operations { history_id: string; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["StoreExportPayload"]; + }; + }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -25512,10 +26907,10 @@ export interface operations { }; }; }; - enable_link_access_api_histories__history_id__enable_link_access_put: { + publish_api_histories__history_id__publish_put: { /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. */ parameters: { header?: { @@ -25596,20 +26991,12 @@ export interface operations { }; }; }; - get_history_exports_api_histories__history_id__exports_get: { + share_with_users_api_histories__history_id__share_with_users_put: { /** - * Get previous history exports. - * @description By default the legacy job-based history exports (jeha) are returned. - * - * Change the `accept` content type header to return the new task-based history exports. + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. */ parameters: { - query?: { - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -25619,12 +27006,16 @@ export interface operations { history_id: string; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["ShareWithPayload"]; + }; + }; responses: { - /** @description A list of history exports */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobExportHistoryArchiveListResponse"]; - "application/vnd.galaxy.task.export+json": components["schemas"]["ExportTaskListResponse"]; + "application/json": components["schemas"]["ShareHistoryWithStatus"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -25689,22 +27080,10 @@ export interface operations { }; }; }; - archive_export_api_histories__history_id__exports_put: { + sharing_api_histories__history_id__sharing_get: { /** - * Start job (if needed) to create history export for corresponding history. - * @deprecated - * @description This will start a job to create a history export archive. - * - * Calling this endpoint multiple times will return the 202 status code until the archive - * has been completely generated and is ready to download. When ready, it will return - * the 200 status code along with the download link information. - * - * If the history will be exported to a `directory_uri`, instead of returning the download - * link information, the Job ID will be returned so it can be queried to determine when - * the file has been written. - * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. + * Get the current sharing status of the given item. + * @description Return the sharing status of the item. */ parameters: { header?: { @@ -25716,22 +27095,19 @@ export interface operations { history_id: string; }; }; - requestBody?: { - content: { - "application/json": components["schemas"]["ExportHistoryArchivePayload"] | null; - }; - }; responses: { - /** @description Object containing url to fetch export from. */ + /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["JobExportHistoryArchiveModel"] - | components["schemas"]["JobIdResponse"]; + "application/json": components["schemas"]["SharingStatus"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description The exported archive file is not ready yet. */ - 202: never; /** @description User does not have permissions to run jobs as another user. */ 400: { content: { @@ -25788,16 +27164,10 @@ export interface operations { }; }; }; - history_archive_download_api_histories__history_id__exports__jeha_id__get: { + set_slug_api_histories__history_id__slug_put: { /** - * If ready and available, return raw contents of exported history as a downloadable archive. - * @deprecated - * @description See ``PUT /api/histories/{id}/exports`` to initiate the creation - * of the history export - when ready, that route will return 200 status - * code (instead of 202) and this route can be used to download the archive. - * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. */ parameters: { header?: { @@ -25807,19 +27177,22 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the specific Job Export History Association or `latest` (default) to download the last generated archive. */ - jeha_id: string | "latest"; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetSlugPayload"]; }; }; responses: { - /** @description The archive file containing the History. */ - 200: never; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Successful Response */ + 204: never; /** @description User does not have permissions to run jobs as another user. */ 400: { content: { @@ -25876,29 +27249,14 @@ export interface operations { }; }; }; - index_jobs_summary_api_histories__history_id__jobs_summary_get: { - /** - * Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. - * @description Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. - * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ + index_api_histories__history_id__tags_get: { + /** Show tags based on history_id */ parameters: { - query?: { - /** @description A comma-separated list of encoded ids of job summary objects to return - if `ids` is specified types must also be specified and have same length. */ - ids?: string | null; - /** @description A comma-separated list of type of object represented by elements in the `ids` array - any of `Job`, `ImplicitCollectionJob`, or `WorkflowInvocation`. */ - types?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -25906,11 +27264,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["JobStateSummary"] - | components["schemas"]["ImplicitCollectionJobsStateSummary"] - | components["schemas"]["WorkflowInvocationStateSummary"] - )[]; + "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -25975,28 +27329,23 @@ export interface operations { }; }; }; - materialize_to_history_api_histories__history_id__materialize_post: { - /** Materialize a deferred library or HDA dataset into real, usable dataset in specified history. */ + show_api_histories__history_id__tags__tag_name__get: { + /** Show tag based on history_id */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["MaterializeDatasetInstanceAPIRequest"]; + tag_name: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -26061,28 +27410,28 @@ export interface operations { }; }; }; - prepare_store_download_api_histories__history_id__prepare_store_download_post: { - /** Return a short term storage token to monitor download of the history. */ + update_api_histories__history_id__tags__tag_name__put: { + /** Update tag based on history_id */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ history_id: string; + tag_name: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["StoreExportPayload"]; + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -26147,26 +27496,28 @@ export interface operations { }; }; }; - publish_api_histories__history_id__publish_put: { - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ + create_api_histories__history_id__tags__tag_name__post: { + /** Create tag based on history_id */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ history_id: string; + tag_name: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -26231,31 +27582,23 @@ export interface operations { }; }; }; - share_with_users_api_histories__history_id__share_with_users_put: { - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ + delete_api_histories__history_id__tags__tag_name__delete: { + /** Delete tag based on history_id */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ShareWithPayload"]; + tag_name: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ShareHistoryWithStatus"]; + "application/json": boolean; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -26320,10 +27663,10 @@ export interface operations { }; }; }; - sharing_api_histories__history_id__sharing_get: { + unpublish_api_histories__history_id__unpublish_put: { /** - * Get the current sharing status of the given item. - * @description Return the sharing status of the item. + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. */ parameters: { header?: { @@ -26404,11 +27747,8 @@ export interface operations { }; }; }; - set_slug_api_histories__history_id__slug_put: { - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ + write_store_api_histories__history_id__write_store_post: { + /** Prepare history for export-style download and write to supplied URI. */ parameters: { header?: { /** @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. */ @@ -26421,18 +27761,138 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["SetSlugPayload"]; + "application/json": components["schemas"]["WriteStoreToPayload"]; }; }; responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_invocations_api_invocations_get: { + /** Get the list of a user's workflow invocations. */ + 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?: { + /** @description Return only invocations for this Workflow ID */ + workflow_id?: string | null; + /** @description Return only invocations for this History ID */ + history_id?: string | null; + /** @description Return only invocations for this Job ID */ + job_id?: string | null; + /** @description Return invocations for this User ID. */ + user_id?: string | null; + /** @description Sort Workflow Invocations by this attribute */ + sort_by?: components["schemas"]["InvocationSortByEnum"] | null; + /** @description Sort in descending order? */ + sort_desc?: boolean; + /** @description Set to false to only include terminal Invocations. */ + include_terminal?: boolean | null; + /** @description Limit the number of invocations to return. */ + limit?: number | null; + /** @description Number of invocations to skip. */ + offset?: number | null; + /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ + instance?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + include_nested_invocations?: boolean; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { /** @description Successful Response */ - 204: never; + 200: { + content: { + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; /** @description User does not have permissions to run jobs as another user. */ 400: { content: { @@ -26489,22 +27949,28 @@ export interface operations { }; }; }; - index_api_histories__history_id__tags_get: { - /** Show tags based on history_id */ - parameters: { + create_invocations_from_store_api_invocations_from_store_post: { + /** + * Create Invocations From Store + * @description Create invocation(s) from a supplied model store. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - history_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInvocationsFromStorePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsListResponse"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -26569,23 +28035,23 @@ export interface operations { }; }; }; - show_api_histories__history_id__tags__tag_name__get: { - /** Show tag based on history_id */ + step_api_invocations_steps__step_id__get: { + /** Show details of workflow invocation step. */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - history_id: string; - tag_name: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -26650,114 +28116,34 @@ export interface operations { }; }; }; - update_api_histories__history_id__tags__tag_name__put: { - /** Update tag based on history_id */ + show_invocation_api_invocations__invocation_id__get: { + /** Get detailed description of a workflow invocation. */ parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_id: string; - tag_name: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ItemTagsResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + query?: { + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + /** + * @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. + */ + legacy_job_state?: boolean; }; - }; - }; - create_api_histories__history_id__tags__tag_name__post: { - /** Create tag based on history_id */ - parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - history_id: string; - tag_name: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -26822,23 +28208,34 @@ export interface operations { }; }; }; - delete_api_histories__history_id__tags__tag_name__delete: { - /** Delete tag based on history_id */ + cancel_invocation_api_invocations__invocation_id__delete: { + /** Cancel the specified workflow invocation. */ parameters: { + query?: { + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + /** + * @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. + */ + legacy_job_state?: boolean; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - history_id: string; - tag_name: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": boolean; + "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -26903,10 +28300,13 @@ export interface operations { }; }; }; - unpublish_api_histories__history_id__unpublish_put: { + invocation_jobs_summary_api_invocations__invocation_id__jobs_summary_get: { /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. + * Get job state summary info aggregated across all current jobs of the workflow invocation. + * @description Warning: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. */ parameters: { header?: { @@ -26914,15 +28314,15 @@ export interface operations { "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -26987,28 +28387,28 @@ export interface operations { }; }; }; - write_store_api_histories__history_id__write_store_post: { - /** Prepare history for export-style download and write to supplied URI. */ + prepare_store_download_api_invocations__invocation_id__prepare_store_download_post: { + /** Prepare a workflow invocation export-style download. */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["WriteStoreToPayload"]; + "application/json": components["schemas"]["PrepareStoreDownloadPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -27073,58 +28473,23 @@ export interface operations { }; }; }; - index_invocations_api_invocations_get: { - /** Get the list of a user's workflow invocations. */ - 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?: { - /** @description Return only invocations for this Workflow ID */ - workflow_id?: string | null; - /** @description Return only invocations for this History ID */ - history_id?: string | null; - /** @description Return only invocations for this Job ID */ - job_id?: string | null; - /** @description Return invocations for this User ID. */ - user_id?: string | null; - /** @description Sort Workflow Invocations by this attribute */ - sort_by?: components["schemas"]["InvocationSortByEnum"] | null; - /** @description Sort in descending order? */ - sort_desc?: boolean; - /** @description Set to false to only include terminal Invocations. */ - include_terminal?: boolean | null; - /** @description Limit the number of invocations to return. */ - limit?: number | null; - /** @description Number of invocations to skip. */ - offset?: number | null; - /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ - instance?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - include_nested_invocations?: boolean; - }; + show_invocation_report_api_invocations__invocation_id__report_get: { + /** Get JSON summarizing invocation for reporting. */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"][]; + "application/json": components["schemas"]["InvocationReport"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -27189,30 +28554,21 @@ export interface operations { }; }; }; - create_invocations_from_store_api_invocations_from_store_post: { - /** - * Create Invocations From Store - * @description Create invocation(s) from a supplied model store. - */ - parameters?: { - /** @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. */ + show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get: { + /** Get PDF summarizing invocation for reporting. */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInvocationsFromStorePayload"]; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"][]; - }; - }; + 200: never; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { @@ -27275,23 +28631,33 @@ export interface operations { }; }; }; - step_api_invocations_steps__step_id__get: { - /** Show details of workflow invocation step. */ + invocation_step_jobs_summary_api_invocations__invocation_id__step_jobs_summary_get: { + /** + * Get job state summary info aggregated per step of the workflow invocation. + * @description Warning: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationStep"]; + "application/json": ( + | components["schemas"]["InvocationStepJobsResponseStepModel"] + | components["schemas"]["InvocationStepJobsResponseJobModel"] + | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"] + )[]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -27356,20 +28722,12 @@ export interface operations { }; }; }; - show_invocation_api_invocations__invocation_id__get: { - /** Get detailed description of a workflow invocation. */ + invocation_step_api_invocations__invocation_id__steps__step_id__get: { + /** + * Show details of workflow invocation step. + * @description An alias for `GET /api/invocations/steps/{step_id}`. `invocation_id` is ignored. + */ parameters: { - query?: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ - legacy_job_state?: boolean; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -27377,13 +28735,15 @@ export interface operations { path: { /** @description The encoded database identifier of the Invocation. */ invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -27448,20 +28808,9 @@ export interface operations { }; }; }; - cancel_invocation_api_invocations__invocation_id__delete: { - /** Cancel the specified workflow invocation. */ + update_invocation_step_api_invocations__invocation_id__steps__step_id__put: { + /** Update state of running workflow step invocation - still very nebulous but this would be for stuff like confirming paused steps can proceed etc. */ parameters: { - query?: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ - legacy_job_state?: boolean; - }; header?: { /** @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. */ "run-as"?: string | null; @@ -27469,100 +28818,20 @@ export interface operations { path: { /** @description The encoded database identifier of the Invocation. */ invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; }; }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - invocation_jobs_summary_api_invocations__invocation_id__jobs_summary_get: { - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + requestBody: { + content: { + "application/json": components["schemas"]["InvocationUpdatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationJobsResponse"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -27627,8 +28896,8 @@ export interface operations { }; }; }; - prepare_store_download_api_invocations__invocation_id__prepare_store_download_post: { - /** Prepare a workflow invocation export-style download. */ + write_store_api_invocations__invocation_id__write_store_post: { + /** Prepare a workflow invocation export-style download and write to supplied URI. */ parameters: { header?: { /** @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. */ @@ -27641,14 +28910,14 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["PrepareStoreDownloadPayload"]; + "application/json": components["schemas"]["WriteInvocationStoreToPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -27713,23 +28982,23 @@ export interface operations { }; }; }; - show_invocation_report_api_invocations__invocation_id__report_get: { - /** Get JSON summarizing invocation for reporting. */ - parameters: { + job_lock_status_api_job_lock_get: { + /** + * Job Lock Status + * @description Get job lock status. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationReport"]; + "application/json": components["schemas"]["JobLock"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -27794,21 +29063,30 @@ export interface operations { }; }; }; - show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get: { - /** Get PDF summarizing invocation for reporting. */ - parameters: { + update_job_lock_api_job_lock_put: { + /** + * Update Job Lock + * @description Set job lock status. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["JobLock"]; }; }; responses: { /** @description Successful Response */ - 200: never; + 200: { + content: { + "application/json": components["schemas"]["JobLock"]; + }; + }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { @@ -27871,32 +29149,96 @@ export interface operations { }; }; }; - invocation_step_jobs_summary_api_invocations__invocation_id__step_jobs_summary_get: { - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - parameters: { + index_api_jobs_get: { + /** Index */ + parameters?: { + /** @description If true, and requester is an admin, will return external job id and user email. This is only available to admins. */ + /** @description an encoded user id to restrict query to, must be own id if not admin user */ + /** @description Determines columns to return. Defaults to 'collection'. */ + /** @description Limit listing of jobs to those that are updated after specified date (e.g. '2014-01-01') */ + /** @description Limit listing of jobs to those that are updated before specified date (e.g. '2014-01-01') */ + /** @description Limit listing of jobs to those that match the history_id. If none, jobs from any history may be returned. */ + /** @description Limit listing of jobs to those that match the specified workflow ID. If none, jobs from any workflow (or from no workflows) may be returned. */ + /** @description Limit listing of jobs to those that match the specified workflow invocation ID. If none, jobs from any workflow invocation (or from no workflows) may be returned. */ + /** @description Limit listing of jobs to those that match the specified implicit collection job ID. If none, jobs from any implicit collection execution (or from no implicit collection execution) may be returned. */ + /** @description Sort results by specified field. */ + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `user` + * : The user email of the user that executed the Job. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tool_id` + * : The tool ID corresponding to the job. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `runner` + * : The job runner name used to execute the job. (The tag `r` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. + * + * `handler` + * : The job handler name used to execute the job. (The tag `h` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Jobs: `user`, `tool`, `handler`, `runner`. + */ + /** @description Maximum number of jobs to return. */ + /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ + /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ + /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ + /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ + query?: { + user_details?: boolean; + user_id?: string | null; + view?: components["schemas"]["JobIndexViewEnum"]; + date_range_min?: string | string | null; + date_range_max?: string | string | null; + history_id?: string | null; + workflow_id?: string | null; + invocation_id?: string | null; + implicit_collection_jobs_id?: string | null; + order_by?: components["schemas"]["JobIndexSortByEnum"]; + search?: string | null; + /** @description Maximum number of jobs to return. */ + limit?: number; + /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ + offset?: number; + /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ + state?: string[] | null; + /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ + tool_id?: string[] | null; + /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ + tool_id_like?: string[] | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { "application/json": ( - | components["schemas"]["InvocationStepJobsResponseStepModel"] - | components["schemas"]["InvocationStepJobsResponseJobModel"] - | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"] + | components["schemas"]["ShowFullJobResponse"] + | components["schemas"]["EncodedJobDetails"] + | components["schemas"]["JobSummary"] )[]; }; }; @@ -27962,28 +29304,30 @@ export interface operations { }; }; }; - invocation_step_api_invocations__invocation_id__steps__step_id__get: { + search_jobs_api_jobs_search_post: { /** - * Show details of workflow invocation step. - * @description An alias for `GET /api/invocations/steps/{step_id}`. `invocation_id` is ignored. + * Return jobs for current user + * @description This method is designed to scan the list of previously run jobs and find records of jobs that had + * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply + * recycle the old results. */ - parameters: { + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SearchJobsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationStep"]; + "application/json": components["schemas"]["EncodedJobDetails"][]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -28048,30 +29392,29 @@ export interface operations { }; }; }; - update_invocation_step_api_invocations__invocation_id__steps__step_id__put: { - /** Update state of running workflow step invocation - still very nebulous but this would be for stuff like confirming paused steps can proceed etc. */ + show_job_api_jobs__job_id__get: { + /** Return dictionary containing description of job data. */ parameters: { + query?: { + /** @description Show extra information. */ + full?: boolean | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["InvocationUpdatePayload"]; + /** @description The ID of the job */ + job_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationStep"]; + "application/json": + | components["schemas"]["ShowFullJobResponse"] + | components["schemas"]["EncodedJobDetails"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -28136,28 +29479,28 @@ export interface operations { }; }; }; - write_store_api_invocations__invocation_id__write_store_post: { - /** Prepare a workflow invocation export-style download and write to supplied URI. */ + cancel_job_api_jobs__job_id__delete: { + /** Cancels specified job */ parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description The ID of the job */ + job_id: string; }; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["WriteInvocationStoreToPayload"]; + "application/json": components["schemas"]["DeleteJobPayload"] | null; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": boolean; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -28222,23 +29565,23 @@ export interface operations { }; }; }; - job_lock_status_api_job_lock_get: { - /** - * Job Lock Status - * @description Get job lock status. - */ - parameters?: { - /** @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. */ + check_common_problems_api_jobs__job_id__common_problems_get: { + /** Check inputs and job for common potential problems to aid in error reporting */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the job */ + job_id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobLock"]; + "application/json": components["schemas"]["JobInputSummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -28303,28 +29646,23 @@ export interface operations { }; }; }; - update_job_lock_api_job_lock_put: { - /** - * Update Job Lock - * @description Set job lock status. - */ - parameters?: { - /** @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. */ + destination_params_job_api_jobs__job_id__destination_params_get: { + /** Return destination parameters for specified job. */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["JobLock"]; + path: { + /** @description The ID of the job */ + job_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobLock"]; + "application/json": components["schemas"]["JobDestinationParams"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -28389,97 +29727,28 @@ export interface operations { }; }; }; - index_api_jobs_get: { - /** Index */ - parameters?: { - /** @description If true, and requester is an admin, will return external job id and user email. This is only available to admins. */ - /** @description an encoded user id to restrict query to, must be own id if not admin user */ - /** @description Determines columns to return. Defaults to 'collection'. */ - /** @description Limit listing of jobs to those that are updated after specified date (e.g. '2014-01-01') */ - /** @description Limit listing of jobs to those that are updated before specified date (e.g. '2014-01-01') */ - /** @description Limit listing of jobs to those that match the history_id. If none, jobs from any history may be returned. */ - /** @description Limit listing of jobs to those that match the specified workflow ID. If none, jobs from any workflow (or from no workflows) may be returned. */ - /** @description Limit listing of jobs to those that match the specified workflow invocation ID. If none, jobs from any workflow invocation (or from no workflows) may be returned. */ - /** @description Limit listing of jobs to those that match the specified implicit collection job ID. If none, jobs from any implicit collection execution (or from no implicit collection execution) may be returned. */ - /** @description Sort results by specified field. */ - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `user` - * : The user email of the user that executed the Job. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tool_id` - * : The tool ID corresponding to the job. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `runner` - * : The job runner name used to execute the job. (The tag `r` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. - * - * `handler` - * : The job handler name used to execute the job. (The tag `h` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Jobs: `user`, `tool`, `handler`, `runner`. - */ - /** @description Maximum number of jobs to return. */ - /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ - /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ - /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ - /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ - query?: { - user_details?: boolean; - user_id?: string | null; - view?: components["schemas"]["JobIndexViewEnum"]; - date_range_min?: string | string | null; - date_range_max?: string | string | null; - history_id?: string | null; - workflow_id?: string | null; - invocation_id?: string | null; - implicit_collection_jobs_id?: string | null; - order_by?: components["schemas"]["JobIndexSortByEnum"]; - search?: string | null; - /** @description Maximum number of jobs to return. */ - limit?: number; - /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ - offset?: number; - /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ - state?: string[] | null; - /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ - tool_id?: string[] | null; - /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ - tool_id_like?: string[] | null; - }; + report_error_api_jobs__job_id__error_post: { + /** Submits a bug report via the API. */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ReportJobErrorPayload"]; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["ShowFullJobResponse"] - | components["schemas"]["EncodedJobDetails"] - | components["schemas"]["JobSummary"] - )[]; + "application/json": components["schemas"]["JobErrorSummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -28544,30 +29813,23 @@ export interface operations { }; }; }; - search_jobs_api_jobs_search_post: { - /** - * Return jobs for current user - * @description This method is designed to scan the list of previously run jobs and find records of jobs that had - * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply - * recycle the old results. - */ - parameters?: { - /** @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. */ + get_inputs_api_jobs__job_id__inputs_get: { + /** Returns input datasets created by a job. */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["SearchJobsPayload"]; + path: { + /** @description The ID of the job */ + job_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["EncodedJobDetails"][]; + "application/json": components["schemas"]["JobInputAssociation"][]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -28632,12 +29894,15 @@ export interface operations { }; }; }; - show_job_api_jobs__job_id__get: { - /** Return dictionary containing description of job data. */ + get_metrics_api_jobs__job_id__metrics_get: { + /** Return job metrics for specified job. */ parameters: { query?: { - /** @description Show extra information. */ - full?: boolean | null; + /** + * @deprecated + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + */ + hda_ldda?: components["schemas"]["DatasetSourceType"] | null; }; header?: { /** @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. */ @@ -28652,9 +29917,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["ShowFullJobResponse"] - | components["schemas"]["EncodedJobDetails"]; + "application/json": (components["schemas"]["JobMetric"] | null)[]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -28719,94 +29982,97 @@ export interface operations { }; }; }; - cancel_job_api_jobs__job_id__delete: { - /** Cancels specified job */ + get_token_api_jobs__job_id__oidc_tokens_get: { + /** + * Get a fresh OIDC token + * @description Allows remote job running mechanisms to get a fresh OIDC token that can be used on remote side to authorize user. It is not meant to represent part of Galaxy's stable, user facing API + */ parameters: { + query: { + /** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job */ + job_key: string; + /** @description OIDC provider name */ + provider: string; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ job_id: string; }; }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteJobPayload"] | null; - }; - }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": boolean; + "text/plain": string; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; /** @description User does not have permissions to run jobs as another user. */ 400: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Authentication failed, invalid credentials supplied. */ 401: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Authentication required for this request */ 403: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; /** @description No such object found. */ 404: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Database conflict prevented fulfilling the request. */ 409: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; /** @description This API method or call signature has been deprecated and is no longer available */ 410: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation error */ 422: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Internal server error. */ 500: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Method is not implemented. */ 501: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - check_common_problems_api_jobs__job_id__common_problems_get: { - /** Check inputs and job for common potential problems to aid in error reporting */ + get_outputs_api_jobs__job_id__outputs_get: { + /** Returns output datasets created by a job. */ parameters: { header?: { /** @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. */ @@ -28821,7 +30087,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobInputSummary"]; + "application/json": components["schemas"]["JobOutputAssociation"][]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -28886,9 +30152,21 @@ export interface operations { }; }; }; - destination_params_job_api_jobs__job_id__destination_params_get: { - /** Return destination parameters for specified job. */ + resolve_parameters_display_api_jobs__job_id__parameters_display_get: { + /** + * Resolve parameters as a list for nested display. + * @description Resolve parameters as a list for nested display. + * This API endpoint is unstable and tied heavily to Galaxy's JS client code, + * this endpoint will change frequently. + */ parameters: { + query?: { + /** + * @deprecated + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + */ + hda_ldda?: components["schemas"]["DatasetSourceType"] | null; + }; header?: { /** @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. */ "run-as"?: string | null; @@ -28902,7 +30180,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobDestinationParams"]; + "application/json": components["schemas"]["JobDisplayParametersSummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -28967,8 +30245,8 @@ export interface operations { }; }; }; - report_error_api_jobs__job_id__error_post: { - /** Submits a bug report via the API. */ + resume_paused_job_api_jobs__job_id__resume_put: { + /** Resumes a paused job. */ parameters: { header?: { /** @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. */ @@ -28979,16 +30257,11 @@ export interface operations { job_id: string; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["ReportJobErrorPayload"]; - }; - }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobErrorSummary"]; + "application/json": components["schemas"]["JobOutputAssociation"][]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29053,23 +30326,27 @@ export interface operations { }; }; }; - get_inputs_api_jobs__job_id__inputs_get: { - /** Returns input datasets created by a job. */ - parameters: { + index_api_libraries_get: { + /** + * Returns a list of summary data for all libraries. + * @description Returns a list of summary data for all libraries. + */ + parameters?: { + /** @description Whether to include deleted libraries in the result. */ + query?: { + /** @description Whether to include deleted libraries in the result. */ + deleted?: boolean | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the job */ - job_id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobInputAssociation"][]; + "application/json": components["schemas"]["LibrarySummaryList"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29134,30 +30411,28 @@ export interface operations { }; }; }; - get_metrics_api_jobs__job_id__metrics_get: { - /** Return job metrics for specified job. */ - parameters: { - query?: { - /** - * @deprecated - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - */ - hda_ldda?: components["schemas"]["DatasetSourceType"] | null; - }; + create_api_libraries_post: { + /** + * Creates a new library and returns its summary information. + * @description Creates a new library and returns its summary information. Currently, only admin users can create libraries. + */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the job */ - job_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": (components["schemas"]["JobMetric"] | null)[]; + "application/json": components["schemas"]["LibrarySummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29222,112 +30497,106 @@ export interface operations { }; }; }; - get_token_api_jobs__job_id__oidc_tokens_get: { + index_deleted_api_libraries_deleted_get: { /** - * Get a fresh OIDC token - * @description Allows remote job running mechanisms to get a fresh OIDC token that can be used on remote side to authorize user. It is not meant to represent part of Galaxy's stable, user facing API + * Returns a list of summary data for all libraries marked as deleted. + * @description Returns a list of summary data for all libraries marked as deleted. */ - parameters: { - query: { - /** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job */ - job_key: string; - /** @description OIDC provider name */ - provider: string; - }; + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - job_id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "text/plain": string; + "application/json": components["schemas"]["LibrarySummaryList"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description User does not have permissions to run jobs as another user. */ 400: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Authentication failed, invalid credentials supplied. */ 401: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Authentication required for this request */ 403: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description No such object found. */ 404: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Database conflict prevented fulfilling the request. */ 409: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description This API method or call signature has been deprecated and is no longer available */ 410: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Validation error */ 422: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Internal server error. */ 500: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Method is not implemented. */ 501: { content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_outputs_api_jobs__job_id__outputs_get: { - /** Returns output datasets created by a job. */ - parameters: { + create_from_store_api_libraries_from_store_post: { + /** Create libraries from a model store. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the job */ - job_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibrariesFromStore"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobOutputAssociation"][]; + "application/json": components["schemas"]["LibrarySummary"][]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29392,35 +30661,26 @@ export interface operations { }; }; }; - resolve_parameters_display_api_jobs__job_id__parameters_display_get: { + show_api_libraries__id__get: { /** - * Resolve parameters as a list for nested display. - * @description Resolve parameters as a list for nested display. - * This API endpoint is unstable and tied heavily to Galaxy's JS client code, - * this endpoint will change frequently. + * Returns summary information about a particular library. + * @description Returns summary information about a particular library. */ parameters: { - query?: { - /** - * @deprecated - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - */ - hda_ldda?: components["schemas"]["DatasetSourceType"] | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + /** @description The ID of the Library. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobDisplayParametersSummary"]; + "application/json": components["schemas"]["LibrarySummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29485,23 +30745,36 @@ export interface operations { }; }; }; - resume_paused_job_api_jobs__job_id__resume_put: { - /** Resumes a paused job. */ + delete_api_libraries__id__delete: { + /** + * Marks the specified library as deleted (or undeleted). + * @description Marks the specified library as deleted (or undeleted). + * Currently, only admin users can delete or restore libraries. + */ parameters: { + query?: { + /** @description Whether to restore a deleted library. */ + undelete?: boolean | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + /** @description The ID of the Library. */ + id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteLibraryPayload"] | null; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["JobOutputAssociation"][]; + "application/json": components["schemas"]["LibrarySummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29566,27 +30839,31 @@ export interface operations { }; }; }; - index_api_libraries_get: { + update_api_libraries__id__patch: { /** - * Returns a list of summary data for all libraries. - * @description Returns a list of summary data for all libraries. + * Updates the information of an existing library. + * @description Updates the information of an existing library. */ - parameters?: { - /** @description Whether to include deleted libraries in the result. */ - query?: { - /** @description Whether to include deleted libraries in the result. */ - deleted?: boolean | null; - }; + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Library. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateLibraryPayload"]; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibrarySummaryList"]; + "application/json": components["schemas"]["LibrarySummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29651,28 +30928,41 @@ export interface operations { }; }; }; - create_api_libraries_post: { + get_permissions_api_libraries__id__permissions_get: { /** - * Creates a new library and returns its summary information. - * @description Creates a new library and returns its summary information. Currently, only admin users can create libraries. + * Gets the current or available permissions of a particular library. + * @description Gets the current or available permissions of a particular library. + * The results can be paginated and additionally filtered by a query. */ - parameters?: { - /** @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. */ + parameters: { + query?: { + /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ + scope?: components["schemas"]["LibraryPermissionScope"] | null; + /** @description Indicates whether the roles available for the library access are requested. */ + is_library_access?: boolean | null; + /** @description The page number to retrieve when paginating the available roles. */ + page?: number; + /** @description The maximum number of permissions per page when paginating. */ + page_limit?: number; + /** @description Optional search text to retrieve only the roles matching this query. */ + q?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibraryPayload"]; + path: { + /** @description The ID of the Library. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": + | components["schemas"]["LibraryCurrentPermissions"] + | components["schemas"]["LibraryAvailablePermissions"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29737,23 +31027,39 @@ export interface operations { }; }; }; - index_deleted_api_libraries_deleted_get: { + set_permissions_api_libraries__id__permissions_post: { /** - * Returns a list of summary data for all libraries marked as deleted. - * @description Returns a list of summary data for all libraries marked as deleted. + * Sets the permissions to access and manipulate a library. + * @description Sets the permissions to access and manipulate a library. */ - parameters?: { - /** @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. */ + parameters: { + query?: { + /** @description Indicates what action should be performed on the Library. */ + action?: components["schemas"]["LibraryPermissionAction"] | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Library. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": + | components["schemas"]["LibraryPermissionsPayload"] + | components["schemas"]["LegacyLibraryPermissionsPayload"]; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibrarySummaryList"]; + "application/json": + | components["schemas"]["LibraryLegacySummary"] + | components["schemas"]["LibraryCurrentPermissions"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29818,25 +31124,16 @@ export interface operations { }; }; }; - create_from_store_api_libraries_from_store_post: { - /** Create libraries from a model store. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibrariesFromStore"]; - }; - }; + index_api_licenses_get: { + /** + * Lists all available SPDX licenses + * @description Returns an index with all the available [SPDX licenses](https://spdx.org/licenses/). + */ responses: { - /** @description Successful Response */ + /** @description List of SPDX licenses */ 200: { content: { - "application/json": components["schemas"]["LibrarySummary"][]; + "application/json": components["schemas"]["LicenseMetadataModel"][]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29901,26 +31198,23 @@ export interface operations { }; }; }; - show_api_libraries__id__get: { + get_api_licenses__id__get: { /** - * Returns summary information about a particular library. - * @description Returns summary information about a particular library. + * Gets the SPDX license metadata associated with the short identifier + * @description Returns the license metadata associated with the given + * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). */ parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; path: { - /** @description The ID of the Library. */ - id: string; + /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ + id: unknown; }; }; responses: { - /** @description Successful Response */ + /** @description SPDX license metadata */ 200: { content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": components["schemas"]["LicenseMetadataModel"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -29985,36 +31279,28 @@ export interface operations { }; }; }; - delete_api_libraries__id__delete: { + create_api_metrics_post: { /** - * Marks the specified library as deleted (or undeleted). - * @description Marks the specified library as deleted (or undeleted). - * Currently, only admin users can delete or restore libraries. + * Records a collection of metrics. + * @description Record any metrics sent and return some status object. */ - parameters: { - query?: { - /** @description Whether to restore a deleted library. */ - undelete?: boolean | null; - }; + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Library. */ - id: string; - }; }; - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["DeleteLibraryPayload"] | null; + "application/json": components["schemas"]["CreateMetricsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": Record; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -30079,31 +31365,28 @@ export interface operations { }; }; }; - update_api_libraries__id__patch: { + get_user_notifications_api_notifications_get: { /** - * Updates the information of an existing library. - * @description Updates the information of an existing library. + * Returns the list of notifications associated with the user. + * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. + * + * You can use the `limit` and `offset` parameters to paginate through the notifications. */ - parameters: { + parameters?: { + query?: { + limit?: number | null; + offset?: number | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Library. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryPayload"]; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": components["schemas"]["UserNotificationListResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -30168,41 +31451,25 @@ export interface operations { }; }; }; - get_permissions_api_libraries__id__permissions_get: { - /** - * Gets the current or available permissions of a particular library. - * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. - */ - parameters: { - query?: { - /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ - scope?: components["schemas"]["LibraryPermissionScope"] | null; - /** @description Indicates whether the roles available for the library access are requested. */ - is_library_access?: boolean | null; - /** @description The page number to retrieve when paginating the available roles. */ - page?: number; - /** @description The maximum number of permissions per page when paginating. */ - page_limit?: number; - /** @description Optional search text to retrieve only the roles matching this query. */ - q?: string | null; - }; + update_user_notifications_api_notifications_put: { + /** Updates a list of notifications with the requested values in a single request. */ + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Library. */ - id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UserNotificationsBatchUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["LibraryCurrentPermissions"] - | components["schemas"]["LibraryAvailablePermissions"]; + "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -30267,30 +31534,21 @@ export interface operations { }; }; }; - set_permissions_api_libraries__id__permissions_post: { + send_notification_api_notifications_post: { /** - * Sets the permissions to access and manipulate a library. - * @description Sets the permissions to access and manipulate a library. + * Sends a notification to a list of recipients (users, groups or roles). + * @description Sends a notification to a list of recipients (users, groups or roles). */ - parameters: { - query?: { - /** @description Indicates what action should be performed on the Library. */ - action?: components["schemas"]["LibraryPermissionAction"] | null; - }; + parameters?: { + /** @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?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Library. */ - id: string; - }; }; requestBody: { content: { - "application/json": - | components["schemas"]["LibraryPermissionsPayload"] - | components["schemas"]["LegacyLibraryPermissionsPayload"]; + "application/json": components["schemas"]["NotificationCreateRequest"]; }; }; responses: { @@ -30298,8 +31556,8 @@ export interface operations { 200: { content: { "application/json": - | components["schemas"]["LibraryLegacySummary"] - | components["schemas"]["LibraryCurrentPermissions"]; + | components["schemas"]["NotificationCreatedResponse"] + | components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -30364,16 +31622,25 @@ export interface operations { }; }; }; - index_api_licenses_get: { - /** - * Lists all available SPDX licenses - * @description Returns an index with all the available [SPDX licenses](https://spdx.org/licenses/). - */ + delete_user_notifications_api_notifications_delete: { + /** Deletes a list of notifications received by the user in a single request. */ + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationsBatchRequest"]; + }; + }; responses: { - /** @description List of SPDX licenses */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LicenseMetadataModel"][]; + "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -30438,23 +31705,23 @@ export interface operations { }; }; }; - get_api_licenses__id__get: { + get_all_broadcasted_api_notifications_broadcast_get: { /** - * Gets the SPDX license metadata associated with the short identifier - * @description Returns the license metadata associated with the given - * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). + * Returns all currently active broadcasted notifications. + * @description Only Admin users can access inactive notifications (scheduled or recently expired). */ - parameters: { - path: { - /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ - id: unknown; + parameters?: { + /** @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?: { + /** @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. */ + "run-as"?: string | null; }; }; responses: { - /** @description SPDX license metadata */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["LicenseMetadataModel"]; + "application/json": components["schemas"]["BroadcastNotificationListResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -30519,10 +31786,21 @@ export interface operations { }; }; }; - create_api_metrics_post: { + broadcast_notification_api_notifications_broadcast_post: { /** - * Records a collection of metrics. - * @description Record any metrics sent and return some status object. + * Broadcasts a notification to every user in the system. + * @description Broadcasted notifications are a special kind of notification that are always accessible to all users, including anonymous users. + * They are typically used to display important information such as maintenance windows or new features. + * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. + * + * Broadcasted notifications can include action links that are displayed as buttons. + * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. + * + * Some key features of broadcasted notifications include: + * - They are not associated with a specific user, so they cannot be deleted or marked as read. + * - They can be scheduled to be displayed in the future or to expire after a certain time. + * - By default, broadcasted notifications are published immediately and expire six months after publication. + * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. */ parameters?: { /** @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. */ @@ -30533,14 +31811,14 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["CreateMetricsPayload"]; + "application/json": components["schemas"]["BroadcastNotificationCreateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["NotificationCreatedResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -30605,28 +31883,26 @@ export interface operations { }; }; }; - get_user_notifications_api_notifications_get: { + get_broadcasted_api_notifications_broadcast__notification_id__get: { /** - * Returns the list of notifications associated with the user. - * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. - * - * You can use the `limit` and `offset` parameters to paginate through the notifications. + * Returns the information of a specific broadcasted notification. + * @description Only Admin users can access inactive notifications (scheduled or recently expired). */ - parameters?: { - query?: { - limit?: number | null; - offset?: number | null; - }; + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Notification. */ + notification_id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserNotificationListResponse"]; + "application/json": components["schemas"]["BroadcastNotificationResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -30691,33 +31967,35 @@ export interface operations { }; }; }; - update_user_notifications_api_notifications_put: { - /** Updates a list of notifications with the requested values in a single request. */ - parameters?: { - /** @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. */ + update_broadcasted_notification_api_notifications_broadcast__notification_id__put: { + /** + * Updates the state of a broadcasted notification. + * @description Only Admins can update broadcasted notifications. This is useful to reschedule, edit or expire broadcasted notifications. + */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Notification. */ + notification_id: string; + }; }; requestBody: { content: { - "application/json": components["schemas"]["UserNotificationsBatchUpdateRequest"]; + "application/json": components["schemas"]["NotificationBroadcastUpdateRequest"]; }; }; responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; - }; - }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Successful Response */ + 204: never; /** @description User does not have permissions to run jobs as another user. */ 400: { content: { @@ -30774,10 +32052,13 @@ export interface operations { }; }; }; - send_notification_api_notifications_post: { + get_notification_preferences_api_notifications_preferences_get: { /** - * Sends a notification to a list of recipients (users, groups or roles). - * @description Sends a notification to a list of recipients (users, groups or roles). + * Returns the current user's preferences for notifications. + * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. + * + * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. + * The supported channels are returned in the `supported-channels` header. */ parameters?: { /** @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. */ @@ -30786,18 +32067,11 @@ export interface operations { "run-as"?: string | null; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["NotificationCreateRequest"]; - }; - }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["NotificationCreatedResponse"] - | components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -30862,8 +32136,14 @@ export interface operations { }; }; }; - delete_user_notifications_api_notifications_delete: { - /** Deletes a list of notifications received by the user in a single request. */ + update_notification_preferences_api_notifications_preferences_put: { + /** + * Updates the user's preferences for notifications. + * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. + * + * - Can be used to completely enable/disable notifications for a particular type (category) + * or to enable/disable a particular channel on each category. + */ parameters?: { /** @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?: { @@ -30873,14 +32153,14 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["NotificationsBatchRequest"]; + "application/json": components["schemas"]["UpdateUserNotificationPreferencesRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; + "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -30945,13 +32225,15 @@ export interface operations { }; }; }; - get_all_broadcasted_api_notifications_broadcast_get: { + get_notifications_status_api_notifications_status_get: { /** - * Returns all currently active broadcasted notifications. - * @description Only Admin users can access inactive notifications (scheduled or recently expired). + * Returns the current status summary of the user's notifications since a particular date. + * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. */ - parameters?: { - /** @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. */ + parameters: { + query: { + since: string; + }; header?: { /** @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. */ "run-as"?: string | null; @@ -30961,7 +32243,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["BroadcastNotificationListResponse"]; + "application/json": components["schemas"]["NotificationStatusSummary"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -31026,39 +32308,23 @@ export interface operations { }; }; }; - broadcast_notification_api_notifications_broadcast_post: { - /** - * Broadcasts a notification to every user in the system. - * @description Broadcasted notifications are a special kind of notification that are always accessible to all users, including anonymous users. - * They are typically used to display important information such as maintenance windows or new features. - * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. - * - * Broadcasted notifications can include action links that are displayed as buttons. - * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. - * - * Some key features of broadcasted notifications include: - * - They are not associated with a specific user, so they cannot be deleted or marked as read. - * - They can be scheduled to be displayed in the future or to expire after a certain time. - * - By default, broadcasted notifications are published immediately and expire six months after publication. - * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. - */ - parameters?: { - /** @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. */ + show_notification_api_notifications__notification_id__get: { + /** Displays information about a notification received by the user. */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["BroadcastNotificationCreateRequest"]; + path: { + /** @description The ID of the Notification. */ + notification_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["NotificationCreatedResponse"]; + "application/json": components["schemas"]["UserNotificationResponse"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -31123,11 +32389,8 @@ export interface operations { }; }; }; - get_broadcasted_api_notifications_broadcast__notification_id__get: { - /** - * Returns the information of a specific broadcasted notification. - * @description Only Admin users can access inactive notifications (scheduled or recently expired). - */ + update_user_notification_api_notifications__notification_id__put: { + /** Updates the state of a notification received by the user. */ parameters: { header?: { /** @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. */ @@ -31138,19 +32401,20 @@ export interface operations { notification_id: string; }; }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["BroadcastNotificationResponse"]; - }; + requestBody: { + content: { + "application/json": components["schemas"]["UserNotificationUpdateRequest"]; }; + }; + responses: { /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; + /** @description Successful Response */ + 204: never; /** @description User does not have permissions to run jobs as another user. */ 400: { content: { @@ -31207,10 +32471,14 @@ export interface operations { }; }; }; - update_broadcasted_notification_api_notifications_broadcast__notification_id__put: { + delete_user_notification_api_notifications__notification_id__delete: { /** - * Updates the state of a broadcasted notification. - * @description Only Admins can update broadcasted notifications. This is useful to reschedule, edit or expire broadcasted notifications. + * Deletes a notification received by the user. + * @description When a notification is deleted, it is not immediately removed from the database, but marked as deleted. + * + * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. + * - It will be eventually removed from the database by a background task after the expiration time. + * - Deleted notifications will be permanently deleted when the expiration time is reached. */ parameters: { header?: { @@ -31222,11 +32490,6 @@ export interface operations { notification_id: string; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["NotificationBroadcastUpdateRequest"]; - }; - }; responses: { /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { @@ -31292,18 +32555,11 @@ export interface operations { }; }; }; - get_notification_preferences_api_notifications_preferences_get: { - /** - * Returns the current user's preferences for notifications. - * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. - * - * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. - * The supported channels are returned in the `supported-channels` header. - */ + object_stores__instances_index: { + /** Get a list of persisted object store instances defined by the requesting user. */ parameters?: { /** @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?: { - /** @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. */ "run-as"?: string | null; }; }; @@ -31311,7 +32567,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserNotificationPreferences"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"][]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -31376,31 +32632,24 @@ export interface operations { }; }; }; - update_notification_preferences_api_notifications_preferences_put: { - /** - * Updates the user's preferences for notifications. - * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. - * - * - Can be used to completely enable/disable notifications for a particular type (category) - * or to enable/disable a particular channel on each category. - */ + object_stores__create_instance: { + /** Create a user-bound object store. */ parameters?: { /** @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?: { - /** @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. */ "run-as"?: string | null; }; }; requestBody: { content: { - "application/json": components["schemas"]["UpdateUserNotificationPreferencesRequest"]; + "application/json": components["schemas"]["CreateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserNotificationPreferences"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -31465,25 +32714,24 @@ export interface operations { }; }; }; - get_notifications_status_api_notifications_status_get: { - /** - * Returns the current status summary of the user's notifications since a particular date. - * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. - */ - parameters: { - query: { - since: string; - }; + object_stores__test_new_instance_configuration: { + /** Test payload for creating user-bound object store. */ + parameters?: { + /** @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?: { - /** @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. */ "run-as"?: string | null; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInstancePayload"]; + }; + }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["NotificationStatusSummary"]; + "application/json": components["schemas"]["PluginStatus"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -31548,23 +32796,23 @@ export interface operations { }; }; }; - show_notification_api_notifications__notification_id__get: { - /** Displays information about a notification received by the user. */ + object_stores__instances_get: { + /** Get a persisted user object store instance. */ parameters: { + /** @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?: { - /** @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. */ "run-as"?: string | null; }; + /** @description The UUID used to identify a persisted UserObjectStore object. */ path: { - /** @description The ID of the Notification. */ - notification_id: string; + user_object_store_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserNotificationResponse"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -31629,32 +32877,39 @@ export interface operations { }; }; }; - update_user_notification_api_notifications__notification_id__put: { - /** Updates the state of a notification received by the user. */ + object_stores__instances_update: { + /** Update or upgrade user object store instance. */ parameters: { + /** @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?: { - /** @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. */ "run-as"?: string | null; }; + /** @description The UUID used to identify a persisted UserObjectStore object. */ path: { - /** @description The ID of the Notification. */ - notification_id: string; + user_object_store_id: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["UserNotificationUpdateRequest"]; + "application/json": + | components["schemas"]["UpdateInstanceSecretPayload"] + | components["schemas"]["UpgradeInstancePayload"] + | components["schemas"]["UpdateInstancePayload"]; }; }; responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; + }; + }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ 202: { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Successful Response */ - 204: never; /** @description User does not have permissions to run jobs as another user. */ 400: { content: { @@ -31711,23 +32966,16 @@ export interface operations { }; }; }; - delete_user_notification_api_notifications__notification_id__delete: { - /** - * Deletes a notification received by the user. - * @description When a notification is deleted, it is not immediately removed from the database, but marked as deleted. - * - * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. - * - It will be eventually removed from the database by a background task after the expiration time. - * - Deleted notifications will be permanently deleted when the expiration time is reached. - */ + object_stores__instances_purge: { + /** Purge user object store instance. */ parameters: { + /** @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?: { - /** @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. */ "run-as"?: string | null; }; + /** @description The UUID used to identify a persisted UserObjectStore object. */ path: { - /** @description The ID of the Notification. */ - notification_id: string; + user_object_store_id: string; }; }; responses: { @@ -31795,6 +33043,83 @@ export interface operations { }; }; }; + object_stores__templates_index: { + /** Get a list of object store templates available to build user defined object stores from */ + parameters?: { + /** @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; + }; + }; + responses: { + /** @description A list of the configured object store templates. */ + 200: { + content: { + "application/json": components["schemas"]["ObjectStoreTemplateSummaries"]; + }; + }; + /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + 202: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description User does not have permissions to run jobs as another user. */ + 400: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication failed, invalid credentials supplied. */ + 401: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Authentication required for this request */ + 403: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description No such object found. */ + 404: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Database conflict prevented fulfilling the request. */ + 409: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description This API method or call signature has been deprecated and is no longer available */ + 410: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Internal server error. */ + 500: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Method is not implemented. */ + 501: { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; index_api_object_stores_get: { /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ parameters?: { @@ -31812,7 +33137,10 @@ export interface operations { /** @description A list of the configured object stores. */ 200: { content: { - "application/json": components["schemas"]["ConcreteObjectStoreModel"][]; + "application/json": ( + | components["schemas"]["ConcreteObjectStoreModel"] + | components["schemas"]["UserConcreteObjectStoreModel"] + )[]; }; }; /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ @@ -33946,6 +35274,8 @@ export interface operations { /** * Displays remote files available to the user. * @description Lists all remote files available to the user from different sources. + * + * The total count of files and directories is returned in the 'total_matches' header. */ parameters?: { /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ @@ -33953,6 +35283,10 @@ export interface operations { /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + /** @description Maximum number of entries to return. */ + /** @description Number of entries to skip. */ + /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ + /** @description Sort the entries by the specified field. */ query?: { /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ target?: string; @@ -33964,6 +35298,10 @@ export interface operations { disable?: components["schemas"]["RemoteFilesDisableMode"] | null; /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ writeable?: boolean | null; + limit?: number | null; + offset?: number | null; + query?: string | null; + sort_by?: string | null; }; header?: { /** @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. */ @@ -37623,6 +38961,10 @@ export interface operations { delete_user_api_users__user_id__delete: { /** Delete a user. Only admins can delete others or purge users. */ parameters: { + /** @description Whether to definitely remove this user. Only deleted users can be purged. */ + query?: { + purge?: 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?: { /** @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. */ From 2fb6f51471f3e6b899e18a1d8d17bdd114773dc5 Mon Sep 17 00:00:00 2001 From: Arash Date: Tue, 2 Jul 2024 16:16:26 +0200 Subject: [PATCH 12/17] Sort imports in api.py --- lib/galaxy/webapps/base/api.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/lib/galaxy/webapps/base/api.py b/lib/galaxy/webapps/base/api.py index 8e991bd19b8c..ad0ac2d8a781 100644 --- a/lib/galaxy/webapps/base/api.py +++ b/lib/galaxy/webapps/base/api.py @@ -37,9 +37,8 @@ Send, ) -from galaxy.schema.schema import MessageExceptionModel from galaxy.exceptions.error_codes import error_codes_by_int_code - +from galaxy.schema.schema import MessageExceptionModel log = getLogger(__name__) From ba3a24dc86908107e43f767071f5e9d01f7ea46e Mon Sep 17 00:00:00 2001 From: Arash Date: Tue, 9 Jul 2024 10:41:13 +0200 Subject: [PATCH 13/17] update with "4XX" and "5XX" --- lib/galaxy/webapps/base/api.py | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/lib/galaxy/webapps/base/api.py b/lib/galaxy/webapps/base/api.py index ad0ac2d8a781..38eb01d382ce 100644 --- a/lib/galaxy/webapps/base/api.py +++ b/lib/galaxy/webapps/base/api.py @@ -239,19 +239,15 @@ def add_request_id_middleware(app: FastAPI): def include_all_package_routers(app: FastAPI, package_name: str): responses: typing.Dict[typing.Union[int, str], typing.Dict[str, typing.Any]] = { - 422: { - "description": "Validation error", + "4XX": { + "description": "Client Error", "model": MessageExceptionModel, }, - } - for code, error in error_codes_by_int_code.items(): - code_int = int(str(code)[:3]) - if code_int in [0, 204] or code_int in responses: - continue - responses[code_int] = { - "description": str(error), + "5XX": { + "description": "Server Error", "model": MessageExceptionModel, - } + }, + } for _, module in walk_controller_modules(package_name): router = getattr(module, "router", None) if router: From ba989fe425fd7df52af3969d3799decc6181c822 Mon Sep 17 00:00:00 2001 From: Arash Date: Thu, 11 Jul 2024 14:27:23 +0200 Subject: [PATCH 14/17] updating schema --- client/src/api/schema/schema.ts | 34009 ++++------------ lib/galaxy/schema/schema.py | 13 - .../webapp/frontend/src/schema/schema.ts | 3540 +- 3 files changed, 8932 insertions(+), 28630 deletions(-) diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index 7cfef6966937..e97e66099548 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -3133,7 +3133,7 @@ export interface components { name: string; /** Secrets */ secrets: { - [key: string]: string | undefined; + [key: string]: string; }; /** Template Id */ template_id: string; @@ -3141,7 +3141,7 @@ export interface components { template_version: number; /** Variables */ variables: { - [key: string]: (string | boolean | number) | undefined; + [key: string]: string | boolean | number; }; }; /** CreateInvocationsFromStorePayload */ @@ -12341,7 +12341,7 @@ export interface components { name?: string | null; /** Variables */ variables?: { - [key: string]: (string | boolean | number) | undefined; + [key: string]: string | boolean | number; } | null; }; /** UpdateInstanceSecretPayload */ @@ -12536,13 +12536,13 @@ export interface components { UpgradeInstancePayload: { /** Secrets */ secrets: { - [key: string]: string | undefined; + [key: string]: string; }; /** Template Version */ template_version: number; /** Variables */ variables: { - [key: string]: (string | boolean | number) | undefined; + [key: string]: string | boolean | number; }; }; /** UpgradeSubworkflowAction */ @@ -12682,7 +12682,7 @@ export interface components { uuid: string; /** Variables */ variables: { - [key: string]: (string | boolean | number) | undefined; + [key: string]: string | boolean | number; } | null; }; /** UserCreationPayload */ @@ -12756,7 +12756,7 @@ export interface components { uuid: string; /** Variables */ variables: { - [key: string]: (string | boolean | number) | undefined; + [key: string]: string | boolean | number; } | null; }; /** @@ -13416,80 +13416,30 @@ export interface operations { "application/json": components["schemas"]["APIKeyResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Return an object containing exposable configuration settings + * @description Return an object containing exposable configuration settings. + * + * A more complete list is returned if the user is an admin. + * Pass in `view` and a comma-seperated list of keys to control which + * configuration settings are returned. + */ index_api_configuration_get: { - /** - * Return an object containing exposable configuration settings - * @description Return an object containing exposable configuration settings. - * - * A more complete list is returned if the user is an admin. - * Pass in `view` and a comma-seperated list of keys to control which - * 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 */ + parameters: { query?: { /** @description View to be passed to the serializer */ view?: string | null; @@ -13508,73 +13458,25 @@ export interface operations { "application/json": Record; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Decode a given id + * @description Decode a given id. + */ decode_id_api_configuration_decode__encoded_id__get: { - /** - * Decode a given id - * @description Decode a given id. - */ parameters: { header?: { /** @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. */ @@ -13594,75 +13496,26 @@ export interface operations { }; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Return dynamic tool configuration files + * @description Return dynamic tool configuration files. + */ dynamic_tool_confs_api_configuration_dynamic_tool_confs_get: { - /** - * Return dynamic tool configuration files - * @description Return dynamic tool configuration files. - */ - parameters?: { - /** @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. */ + parameters: { header?: { /** @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. */ "run-as"?: string | null; @@ -13677,73 +13530,25 @@ export interface operations { }[]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Encode a given id + * @description Decode a given id. + */ encode_id_api_configuration_encode__decoded_id__get: { - /** - * Encode a given id - * @description Decode a given id. - */ parameters: { header?: { /** @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. */ @@ -13763,406 +13568,391 @@ export interface operations { }; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Return tool lineages for tools that have them + * @description Return tool lineages for tools that have them. + */ + tool_lineages_api_configuration_tool_lineages_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { + }; + responses: { + /** @description Tool lineages for tools that have them */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": { + [key: string]: Record; + }[]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Reload the Galaxy toolbox (but not individual tools) + * @description Reload the Galaxy toolbox (but not individual tools). + */ + reload_toolbox_api_configuration_toolbox_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - tool_lineages_api_configuration_tool_lineages_get: { - /** - * Return tool lineages for tools that have them - * @description Return tool lineages for tools that have them. - */ - parameters?: { - /** @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. */ + /** Content */ + content_api_dataset_collection_element__dce_id__get: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded ID of the dataset collection element. */ + dce_id: string; + }; }; responses: { - /** @description Tool lineages for tools that have them */ + /** @description Successful Response */ 200: { content: { - "application/json": { - [key: string]: Record; - }[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DCESummary"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Create a new dataset collection instance. */ + create_api_dataset_collections_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateNewCollectionPayload"]; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["HDCADetailed"]; }; }; - /** @description Validation error */ - 422: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - reload_toolbox_api_configuration_toolbox_put: { - /** - * Reload the Galaxy toolbox (but not individual tools) - * @description Reload the Galaxy toolbox (but not individual tools). - */ - parameters?: { - /** @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. */ + /** Returns direct child contents of indicated dataset collection parent ID. */ + contents_dataset_collection_api_dataset_collections__hdca_id__contents__parent_id__get: { + parameters: { + query?: { + /** @description The type of collection instance. Either `history` (default) or `library`. */ + instance_type?: "history" | "library"; + /** @description The maximum number of content elements to return. */ + limit?: number | null; + /** @description The number of content elements that will be skipped before returning. */ + offset?: number | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the `HDCA`. */ + hdca_id: string; + /** @description Parent collection ID describing what collection the contents belongs to. */ + parent_id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatasetCollectionContentElements"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Returns detailed information about the given collection. */ + show_api_dataset_collections__id__get: { + parameters: { + query?: { + /** @description The type of collection instance. Either `history` (default) or `library`. */ + instance_type?: "history" | "library"; + /** @description The view of collection instance to return. */ + view?: string; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - content_api_dataset_collection_element__dce_id__get: { - /** Content */ + /** Returns `dbkey`/`extension` attributes for all the collection elements. */ + attributes_api_dataset_collections__id__attributes_get: { parameters: { + query?: { + /** @description The type of collection instance. Either `history` (default) or `library`. */ + instance_type?: "history" | "library"; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded ID of the dataset collection element. */ - dce_id: string; + /** @description The ID of the `HDCA`. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DCESummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatasetCollectionAttributesResult"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Copy the given collection datasets to a new collection using a new `dbkey` attribute. */ + copy_api_dataset_collections__id__copy_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateCollectionAttributePayload"]; }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + responses: { + /** @description Successful Response */ + 204: { + content: never; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_api_dataset_collections_post: { - /** Create a new dataset collection instance. */ - parameters?: { - /** @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. */ + /** + * Download the content of a dataset collection as a `zip` archive. + * @description Download the content of a history dataset collection as a `zip` archive + * while maintaining approximate collection structure. + */ + dataset_collections__download: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateNewCollectionPayload"]; + path: { + /** @description The ID of the `HDCA`. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { - content: { - "application/json": components["schemas"]["HDCADetailed"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + content: never; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Prepare an short term storage object that the collection will be downloaded to. + * @description The history dataset collection will be written as a `zip` archive to the + * returned short term storage object. Progress tracking this file's creation + * can be tracked with the short_term_storage API. + */ + prepare_collection_download_api_dataset_collections__id__prepare_download_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + }; + responses: { + /** @description Short term storage reference for async monitoring of this download. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + /** @description Required asynchronous tasks required for this operation not available. */ + 501: { + content: never; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - contents_dataset_collection_api_dataset_collections__hdca_id__contents__parent_id__get: { - /** Returns direct child contents of indicated dataset collection parent ID. */ + /** Returns a list of applicable converters for all datatypes in the given collection. */ + suitable_converters_api_dataset_collections__id__suitable_converters_get: { parameters: { query?: { /** @description The type of collection instance. Either `history` (default) or `library`. */ instance_type?: "history" | "library"; - /** @description The maximum number of content elements to return. */ - limit?: number | null; - /** @description The number of content elements that will be skipped before returning. */ - offset?: number | null; }; header?: { /** @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. */ @@ -14170,26427 +13960,9168 @@ export interface operations { }; path: { /** @description The ID of the `HDCA`. */ - hdca_id: string; - /** @description Parent collection ID describing what collection the contents belongs to. */ - parent_id: string; + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatasetCollectionContentElements"]; + "application/json": components["schemas"]["SuitableConverters"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Search datasets or collections using a query system. */ + index_api_datasets_get: { + parameters: { + query?: { + /** @description Optional identifier of a History. Use it to restrict the search within a particular History. */ + history_id?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + }; + }; + /** + * Deletes or purges a batch of datasets. + * @description Deletes or purges a batch of datasets. + * **Warning**: only the ownership of the datasets (and upload state for HDAs) is checked, + * no other checks or restrictions are made. + */ + delete_batch_api_datasets_delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["DeleteDatasetBatchPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DeleteDatasetBatchResult"]; }; }; - /** @description Validation error */ - 422: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_api_dataset_collections__id__get: { - /** Returns detailed information about the given collection. */ + /** + * Displays information about and/or content of a dataset. + * @description **Note**: Due to the multipurpose nature of this endpoint, which can receive a wild variety of parameters + * and return different kinds of responses, the documentation here will be limited. + * To get more information please check the source code. + */ + show_api_datasets__dataset_id__get: { parameters: { query?: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ - instance_type?: "history" | "library"; - /** @description The view of collection instance to return. */ - view?: string; + /** @description The type of information about the dataset to be requested. */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + /** @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. */ + data_type?: components["schemas"]["RequestDataType"] | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; + /** @description The ID of the History Dataset. */ + dataset_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Updates the values for the history dataset (HDA) item with the given ``ID``. + * @description Updates the values for the history content item with the given ``ID``. + */ + datasets__update_dataset: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the item (`HDA`/`HDCA`) */ + dataset_id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - attributes_api_dataset_collections__id__attributes_get: { - /** Returns `dbkey`/`extension` attributes for all the collection elements. */ + /** + * Delete the history dataset content with the given ``ID``. + * @description Delete the history content with the given ``ID`` and path specified type. + * + * **Note**: Currently does not stop any active jobs for which this dataset is an output. + */ + datasets__delete: { parameters: { query?: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ - instance_type?: "history" | "library"; + /** + * @deprecated + * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. + */ + purge?: boolean | null; + /** + * @deprecated + * @description When deleting a dataset collection, whether to also delete containing datasets. + */ + recursive?: boolean | null; + /** + * @deprecated + * @description Whether to stop the creating job if all outputs of the job have been deleted. + */ + stop_job?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + dataset_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentPayload"]; }; }; responses: { - /** @description Successful Response */ + /** @description Request has been executed. */ 200: { content: { - "application/json": components["schemas"]["DatasetCollectionAttributesResult"]; + "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + /** @description Request accepted, processing will finish later. */ 202: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Retrieve information about the content of a dataset. */ + get_structured_content_api_datasets__dataset_id__content__content_type__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + content_type: components["schemas"]["DatasetContentType"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Return a a map with all the existing converted datasets associated with this instance. + * @description Return a map of ` : ` containing all the *existing* converted datasets. + */ + converted_api_datasets__dataset_id__converted_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ConvertedDatasetsMap"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - copy_api_dataset_collections__id__copy_post: { - /** Copy the given collection datasets to a new collection using a new `dbkey` attribute. */ + /** + * Return information about datasets made by converting this dataset to a new format. + * @description Return information about datasets made by converting this dataset to a new format. + * + * If there is no existing converted dataset for the format in `ext`, one will be created. + * + * **Note**: `view` and `keys` are also available to control the serialization of the dataset. + */ + converted_ext_api_datasets__dataset_id__converted__ext__get: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateCollectionAttributePayload"]; + /** @description The ID of the History Dataset. */ + dataset_id: string; + /** @description File extension of the new format to convert this dataset to. */ + ext: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Get the list of extra files/directories associated with a dataset. */ + extra_files_api_datasets__dataset_id__extra_files_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the dataset. */ + dataset_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatasetExtraFiles"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Returns dataset content as Text. */ + get_content_as_text_api_datasets__dataset_id__get_content_as_text_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatasetTextContentDetails"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - dataset_collections__download: { - /** - * Download the content of a dataset collection as a `zip` archive. - * @description Download the content of a history dataset collection as a `zip` archive - * while maintaining approximate collection structure. - */ + /** Compute dataset hash for dataset and update model */ + compute_hash_api_datasets__dataset_id__hash_put: { parameters: { + query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ComputeDatasetHashPayload"]; }; }; responses: { /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** For internal use, this endpoint may change without warning. */ + show_inheritance_chain_api_datasets__dataset_id__inheritance_chain_get: { + parameters: { + query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatasetInheritanceChain"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - prepare_collection_download_api_dataset_collections__id__prepare_download_post: { - /** - * Prepare an short term storage object that the collection will be downloaded to. - * @description The history dataset collection will be written as a `zip` archive to the - * returned short term storage object. Progress tracking this file's creation - * can be tracked with the short_term_storage API. - */ + /** + * Return job metrics for specified job. + * @deprecated + */ + get_metrics_api_datasets__dataset_id__metrics_get: { parameters: { + query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; + /** @description The ID of the dataset */ + dataset_id: string; }; }; responses: { - /** @description Short term storage reference for async monitoring of this download. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncFile"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": (components["schemas"]["JobMetric"] | null)[]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Update an object store ID for a dataset you own. */ + datasets__update_object_store_id: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateObjectStoreIdPayload"]; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Validation error */ - 422: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Required asynchronous tasks required for this operation not available. */ - 501: { - content: never; - }; }; }; - /** Returns a list of applicable converters for all datatypes in the given collection. */ - suitable_converters_api_dataset_collections__id__suitable_converters_get: { + /** + * Resolve parameters as a list for nested display. + * @deprecated + * @description Resolve parameters as a list for nested display. + * This API endpoint is unstable and tied heavily to Galaxy's JS client code, + * this endpoint will change frequently. + */ + resolve_parameters_display_api_datasets__dataset_id__parameters_display_get: { parameters: { query?: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ - instance_type?: "history" | "library"; + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; + /** @description The ID of the dataset */ + dataset_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SuitableConverters"]; + "application/json": components["schemas"]["JobDisplayParametersSummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Set permissions of the given history dataset to the given role ids. + * @description Set permissions of the given history dataset to the given role ids. + */ + update_permissions_api_datasets__dataset_id__permissions_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + }; + requestBody: { + content: { + "application/json": Record; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatasetAssociationRoles"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Display user-facing storage details related to the objectstore a dataset resides in. */ + show_storage_api_datasets__dataset_id__storage_get: { + parameters: { + query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatasetStorageDetails"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_datasets_get: { - /** 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. */ - /** @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. */ + /** + * Displays (preview) or downloads dataset content. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. + */ + display_api_datasets__history_content_id__display_get: { + parameters: { query?: { - /** @description Optional identifier of a History. Use it to restrict the search within a particular History. */ - history_id?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; }; header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; + }; }; responses: { /** @description Successful Response */ 200: { - content: { - "application/json": ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + content: never; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Check if dataset content can be previewed or downloaded. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. + */ + display_api_datasets__history_content_id__display_head: { + parameters: { + query?: { + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ + offset?: number | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - delete_batch_api_datasets_delete: { - /** - * Deletes or purges a batch of datasets. - * @description Deletes or purges a batch of datasets. - * **Warning**: only the ownership of the datasets (and upload state for HDAs) is checked, - * no other checks or restrictions are made. - */ - parameters?: { - /** @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. */ + /** Returns the metadata file associated with this history item. */ + datasets__get_metadata_file: { + parameters: { + query: { + /** @description The name of the metadata file to retrieve. */ + metadata_file: string; + }; header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["DeleteDatasetBatchPayload"]; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; }; }; responses: { /** @description Successful Response */ 200: { + content: never; + }; + /** @description Client Error */ + "4XX": { content: { - "application/json": components["schemas"]["DeleteDatasetBatchResult"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + }; + }; + /** Check if metadata file can be downloaded. */ + get_metadata_file_datasets_api_datasets__history_content_id__metadata_file_head: { + parameters: { + query: { + /** @description The name of the metadata file to retrieve. */ + metadata_file: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + }; + }; + /** + * Lists all available data types + * @description Gets the list of all available data types. + */ + index_api_datatypes_get: { + parameters: { + query?: { + /** @description Whether to return only the datatype's extension rather than the datatype's details */ + extension_only?: boolean | null; + /** @description Whether to return only datatypes which can be uploaded */ + upload_only?: boolean | null; + }; + }; + responses: { + /** @description List of data types */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatatypeDetails"][] | string[]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Returns the list of all installed converters + * @description Gets the list of all installed converters. + */ + converters_api_datatypes_converters_get: { + responses: { + /** @description List of all datatype converters */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatatypeConverterList"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_api_datasets__dataset_id__get: { - /** - * Displays information about and/or content of a dataset. - * @description **Note**: Due to the multipurpose nature of this endpoint, which can receive a wild variety of parameters - * and return different kinds of responses, the documentation here will be limited. - * To get more information please check the source code. - */ - parameters: { - query?: { - /** @description The type of information about the dataset to be requested. */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - /** @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. */ - data_type?: components["schemas"]["RequestDataType"] | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - }; - }; + /** + * Returns a dictionary/map of datatypes and EDAM data + * @description Gets a map of datatypes and their corresponding EDAM data. + */ + edam_data_api_datatypes_edam_data_get: { responses: { - /** @description Successful Response */ + /** @description Dictionary/map of datatypes and EDAM data */ 200: { content: { - "application/json": Record; + "application/json": { + [key: string]: string; + }; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + }; + }; + /** + * Returns a dictionary of datatypes and EDAM data details + * @description Gets a map of datatypes and their corresponding EDAM data. + * EDAM data contains the EDAM iri, label, and definition. + */ + edam_data_detailed_api_datatypes_edam_data_detailed_get: { + responses: { + /** @description Dictionary of EDAM data details containing the EDAM iri, label, and definition */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + }; + }; + /** + * Returns a dictionary/map of datatypes and EDAM formats + * @description Gets a map of datatypes and their corresponding EDAM formats. + */ + edam_formats_api_datatypes_edam_formats_get: { + responses: { + /** @description Dictionary/map of datatypes and EDAM formats */ + 200: { + content: { + "application/json": { + [key: string]: string; + }; + }; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Returns a dictionary of datatypes and EDAM format details + * @description Gets a map of datatypes and their corresponding EDAM formats. + * EDAM formats contain the EDAM iri, label, and definition. + */ + edam_formats_detailed_api_datatypes_edam_formats_detailed_get: { + responses: { + /** @description Dictionary of EDAM format details containing the EDAM iri, label, and definition */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - datasets__update_dataset: { - /** - * Updates the values for the history dataset (HDA) item with the given ``ID``. - * @description Updates the values for the history content item with the given ``ID``. - */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; + /** + * Returns mappings for data types and their implementing classes + * @description Gets mappings for data types. + */ + mapping_api_datatypes_mapping_get: { + responses: { + /** @description Dictionary to map data types with their classes */ + 200: { + content: { + "application/json": components["schemas"]["DatatypesMap"]; + }; }; - path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - dataset_id: string; + /** @description Client Error */ + "4XX": { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; + /** @description Server Error */ + "5XX": { + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; }; + }; + /** + * Returns the list of all installed sniffers + * @description Gets the list of all installed data type sniffers. + */ + sniffers_api_datatypes_sniffers_get: { responses: { - /** @description Successful Response */ + /** @description List of datatype sniffers */ 200: { content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + "application/json": string[]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + }; + }; + /** + * Returns all the data types extensions and their mappings + * @description Combines the datatype information from (/api/datatypes) and the + * mapping information from (/api/datatypes/mapping) into a single + * response. + */ + types_and_mapping_api_datatypes_types_and_mapping_get: { + parameters: { + query?: { + /** @description Whether to return only the datatype's extension rather than the datatype's details */ + extension_only?: boolean | null; + /** @description Whether to return only datatypes which can be uploaded */ + upload_only?: boolean | null; + }; + }; + responses: { + /** @description Dictionary to map data types with their classes */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatatypesCombinedMap"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + }; + }; + /** + * Returns the list of display applications. + * @description Returns the list of display applications. + */ + display_applications_index_api_display_applications_get: { + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DisplayApplication"][]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { + }; + }; + /** + * Reloads the list of display applications. + * @description Reloads the list of display applications. + */ + display_applications_reload_api_display_applications_reload_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody?: { + content: { + "application/json": { + [key: string]: string[]; + } | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["ReloadFeedback"]; + }; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - datasets__delete: { - /** - * Delete the history dataset content with the given ``ID``. - * @description Delete the history content with the given ``ID`` and path specified type. - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. - */ + /** Download */ + download_api_drs_download__object_id__get: { parameters: { - query?: { - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - purge?: boolean | null; - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - recursive?: boolean | null; - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - stop_job?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - dataset_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentPayload"]; + /** @description The ID of the group */ + object_id: string; }; }; responses: { - /** @description Request has been executed. */ + /** @description Successful Response */ 200: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; - }; - }; - /** @description Request accepted, processing will finish later. */ - 202: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + content: never; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Get a list of persisted file source instances defined by the requesting user. */ + file_sources__instances_index: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserFileSourceModel"][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_structured_content_api_datasets__dataset_id__content__content_type__get: { - /** Retrieve information about the content of a dataset. */ + /** Create a user-bound file source. */ + file_sources__create_instance: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - content_type: components["schemas"]["DatasetContentType"]; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["UserFileSourceModel"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Test payload for creating user-bound file source. */ + file_sources__test_new_instance_configuration: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInstancePayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["PluginStatus"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Get a persisted user file source instance. */ + file_sources__instances_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The UUID index for a persisted UserFileSourceStore object. */ + user_file_source_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserFileSourceModel"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - converted_api_datasets__dataset_id__converted_get: { - /** - * Return a a map with all the existing converted datasets associated with this instance. - * @description Return a map of ` : ` containing all the *existing* converted datasets. - */ + /** Update or upgrade user file source instance. */ + file_sources__instances_update: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; + /** @description The UUID index for a persisted UserFileSourceStore object. */ + user_file_source_id: string; + }; + }; + requestBody: { + content: { + "application/json": + | components["schemas"]["UpdateInstanceSecretPayload"] + | components["schemas"]["UpgradeInstancePayload"] + | components["schemas"]["UpdateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ConvertedDatasetsMap"]; + "application/json": components["schemas"]["UserFileSourceModel"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Purge user file source instance. */ + file_sources__instances_purge: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The UUID index for a persisted UserFileSourceStore object. */ + user_file_source_id: string; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + responses: { + /** @description Successful Response */ + 204: { + content: never; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Get a list of file source templates available to build user defined file sources from */ + file_sources__templates_index: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description A list of the configured file source templates. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["FileSourceTemplateSummaries"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - converted_ext_api_datasets__dataset_id__converted__ext__get: { - /** - * Return information about datasets made by converting this dataset to a new format. - * @description Return information about datasets made by converting this dataset to a new format. - * - * If there is no existing converted dataset for the format in `ext`, one will be created. - * - * **Note**: `view` and `keys` are also available to control the serialization of the dataset. - */ + /** + * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. + * @description Returns a list of a folder's contents (files and sub-folders). + * + * Additional metadata for the folder is provided in the response as a separate object containing data + * for breadcrumb path building, permissions and other folder's details. + * + * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). + * + * **Security note**: + * - Accessing a library folder or sub-folder requires only access to the parent library. + * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. + * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. + */ + index_api_folders__folder_id__contents_get: { parameters: { query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description Maximum number of contents to return. */ + limit?: number; + /** @description Return contents from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, contents between position 200-299 will be returned. */ + offset?: number; + /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ + search_text?: string | null; + /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ + include_deleted?: boolean | null; + /** @description Sort results by specified field. */ + order_by?: "name" | "description" | "type" | "size" | "update_time"; + /** @description Sort results in descending order. */ + sort_desc?: boolean | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - /** @description File extension of the new format to convert this dataset to. */ - ext: string; + /** @description The encoded identifier of the library folder. */ + folder_id: string; }; }; responses: { - /** @description Successful Response */ + /** @description The contents of the folder that match the query parameters. */ 200: { content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"]; + "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Creates a new library file from an existing HDA/HDCA. */ + add_history_datasets_to_library_api_folders__folder_id__contents_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded identifier of the library folder. */ + folder_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryFilePayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - extra_files_api_datasets__dataset_id__extra_files_get: { - /** Get the list of extra files/directories associated with a dataset. */ + /** + * Displays information about a particular library folder. + * @description Returns detailed information about the library folder with the given ID. + */ + show_api_folders__id__get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the dataset. */ - dataset_id: string; + /** @description The encoded identifier of the library folder. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatasetExtraFiles"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Updates the information of an existing library folder. + * @description Updates the information of an existing library folder. + */ + update_api_folders__id__put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_content_as_text_api_datasets__dataset_id__get_content_as_text_get: { - /** Returns dataset content as Text. */ + /** + * Create a new library folder underneath the one specified by the ID. + * @description Returns detailed information about the newly created library folder. + */ + create_api_folders__id__post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; + /** @description The encoded identifier of the library folder. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryFolderPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatasetTextContentDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Marks the specified library folder as deleted (or undeleted). + * @description Marks the specified library folder as deleted (or undeleted). + */ + delete_api_folders__id__delete: { + parameters: { + query?: { + /** @description Whether to restore a deleted library folder. */ + undelete?: boolean | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - compute_hash_api_datasets__dataset_id__hash_put: { - /** Compute dataset hash for dataset and update model */ + /** + * Update + * @description Updates the information of an existing library folder. + */ + update_api_folders__id__patch: { parameters: { - query?: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; + /** @description The encoded identifier of the library folder. */ + id: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["ComputeDatasetHashPayload"]; + "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Gets the current or available permissions of a particular library folder. + * @description Gets the current or available permissions of a particular library. + * The results can be paginated and additionally filtered by a query. + */ + get_permissions_api_folders__id__permissions_get: { + parameters: { + query?: { + /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ + scope?: components["schemas"]["LibraryPermissionScope"] | null; + /** @description The page number to retrieve when paginating the available roles. */ + page?: number; + /** @description The maximum number of permissions per page when paginating. */ + page_limit?: number; + /** @description Optional search text to retrieve only the roles matching this query. */ + q?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["LibraryFolderCurrentPermissions"] + | components["schemas"]["LibraryAvailablePermissions"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_inheritance_chain_api_datasets__dataset_id__inheritance_chain_get: { - /** For internal use, this endpoint may change without warning. */ + /** + * Sets the permissions to manage a library folder. + * @description Sets the permissions to manage a library folder. + */ + set_permissions_api_folders__id__permissions_post: { parameters: { query?: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; + /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ + action?: components["schemas"]["LibraryFolderPermissionAction"] | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; + /** @description The encoded identifier of the library folder. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["LibraryFolderPermissionsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatasetInheritanceChain"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibraryFolderCurrentPermissions"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Delete */ + delete_api_forms__id__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_metrics_api_datasets__dataset_id__metrics_get: { - /** - * Return job metrics for specified job. - * @deprecated - */ + /** Undelete */ + undelete_api_forms__id__undelete_post: { parameters: { - query?: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the dataset */ - dataset_id: string; + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": (components["schemas"]["JobMetric"] | null)[]; + "application/json": unknown; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Displays remote files available to the user. Please use /api/remote_files instead. + * @deprecated + * @description Lists all remote files available to the user from different sources. + * + * The total count of files and directories is returned in the 'total_matches' header. + */ + index_api_ftp_files_get: { + parameters: { + query?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + target?: string; + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + format?: components["schemas"]["RemoteFilesFormat"] | null; + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + recursive?: boolean | null; + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + disable?: components["schemas"]["RemoteFilesDisableMode"] | null; + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + writeable?: boolean | null; + /** @description Maximum number of entries to return. */ + limit?: number | null; + /** @description Number of entries to skip. */ + offset?: number | null; + /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ + query?: string | null; + /** @description Sort the entries by the specified field. */ + sort_by?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["ListUriResponse"] + | components["schemas"]["ListJstreeResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Return a list of installed genomes */ + index_api_genomes_get: { + parameters: { + query?: { + /** @description If true, return genome keys with chromosome lengths */ + chrom_info?: boolean; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Installed genomes */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": string[][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - datasets__update_object_store_id: { - /** Update an object store ID for a dataset you own. */ + /** Return information about build */ + show_api_genomes__id__get: { parameters: { + query?: { + /** @description If true, return reference data */ + reference?: boolean; + /** @description Limits size of returned data */ + num?: number; + /** @description Limits size of returned data */ + chrom?: string; + /** @description Limits size of returned data */ + low?: number; + /** @description Limits size of returned data */ + high?: number; + /** @description Format */ + format?: string; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateObjectStoreIdPayload"]; + /** @description Genome ID */ + id: string; }; }; responses: { - /** @description Successful Response */ + /** @description Information about genome build */ 200: { content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Return all available indexes for a genome id for provided type */ + indexes_api_genomes__id__indexes_get: { + parameters: { + query?: { + /** @description Index type */ + type?: string; + /** @description Format */ + format?: string; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description Genome ID */ + id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Indexes for a genome id for provided type */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - resolve_parameters_display_api_datasets__dataset_id__parameters_display_get: { - /** - * Resolve parameters as a list for nested display. - * @deprecated - * @description Resolve parameters as a list for nested display. - * This API endpoint is unstable and tied heavily to Galaxy's JS client code, - * this endpoint will change frequently. - */ + /** Return raw sequence data */ + sequences_api_genomes__id__sequences_get: { parameters: { query?: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; + /** @description If true, return reference data */ + reference?: boolean; + /** @description Limits size of returned data */ + chrom?: string; + /** @description Limits size of returned data */ + low?: number; + /** @description Limits size of returned data */ + high?: number; + /** @description Format */ + format?: string; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the dataset */ - dataset_id: string; + /** @description Genome ID */ + id: string; }; }; responses: { - /** @description Successful Response */ + /** @description Raw sequence data */ 200: { content: { - "application/json": components["schemas"]["JobDisplayParametersSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Displays a collection (list) of groups. */ + index_api_groups_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupListResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_permissions_api_datasets__dataset_id__permissions_put: { - /** - * Set permissions of the given history dataset to the given role ids. - * @description Set permissions of the given history dataset to the given role ids. - */ + /** Creates a new group. */ + create_api_groups_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - }; }; requestBody: { content: { - "application/json": Record; + "application/json": components["schemas"]["GroupCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatasetAssociationRoles"]; + "application/json": components["schemas"]["GroupListResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Displays information about a group. */ + show_group_api_groups__group_id__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + group_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Modifies a group. */ + update_api_groups__group_id__put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + group_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["GroupUpdatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_storage_api_datasets__dataset_id__storage_get: { - /** Display user-facing storage details related to the objectstore a dataset resides in. */ + /** Delete */ + delete_api_groups__group_id__delete: { parameters: { - query?: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; + group_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatasetStorageDetails"]; + "application/json": unknown; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Purge */ + purge_api_groups__group_id__purge_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + group_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Displays a collection (list) of groups. */ + group_roles_api_groups__group_id__roles_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupRoleListResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - display_api_datasets__history_content_id__display_get: { - /** - * Displays (preview) or downloads dataset content. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ + /** Displays information about a group role. */ + group_role_api_groups__group_id__roles__role_id__get: { parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the role. */ + role_id: string; }; }; responses: { /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupRoleResponse"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Adds a role to a group */ + update_api_groups__group_id__roles__role_id__put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the role. */ + role_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupRoleResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - display_api_datasets__history_content_id__display_head: { - /** - * Check if dataset content can be previewed or downloaded. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ + /** Removes a role from a group */ + delete_api_groups__group_id__roles__role_id__delete: { parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the role. */ + role_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["GroupRoleResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Undelete */ + undelete_api_groups__group_id__undelete_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + group_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Displays information about a group user. + * @description Displays information about a group user. + */ + group_user_api_groups__group_id__user__user_id__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - datasets__get_metadata_file: { - /** Returns the metadata file associated with this history item. */ + /** + * Adds a user to a group + * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Adds a user to a group + */ + update_api_groups__group_id__user__user_id__put: { parameters: { - query: { - /** @description The name of the metadata file to retrieve. */ - metadata_file: string; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Removes a user from a group + * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Removes a user from a group + */ + delete_api_groups__group_id__user__user_id__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Displays a collection (list) of groups. + * @description GET /api/groups/{encoded_group_id}/users + * Displays a collection (list) of groups. + */ + group_users_api_groups__group_id__users_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupUserListResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_metadata_file_datasets_api_datasets__history_content_id__metadata_file_head: { - /** Check if metadata file can be downloaded. */ + /** + * Displays information about a group user. + * @description Displays information about a group user. + */ + group_user_api_groups__group_id__users__user_id__get: { parameters: { - query: { - /** @description The name of the metadata file to retrieve. */ - metadata_file: string; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Adds a user to a group + * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Adds a user to a group + */ + update_api_groups__group_id__users__user_id__put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Removes a user from a group + * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} + * Removes a user from a group + */ + delete_api_groups__group_id__users__user_id__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_datatypes_get: { - /** - * Lists all available data types - * @description Gets the list of all available data types. - */ - parameters?: { - /** @description Whether to return only the datatype's extension rather than the datatype's details */ - /** @description Whether to return only datatypes which can be uploaded */ - query?: { - /** @description Whether to return only the datatype's extension rather than the datatype's details */ - extension_only?: boolean | null; - /** @description Whether to return only datatypes which can be uploaded */ - upload_only?: boolean | null; + /** + * Search the Galaxy Help forum. + * @description Search the Galaxy Help forum using the Discourse API. + * + * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. + */ + search_forum_api_help_forum_search_get: { + parameters: { + query: { + /** @description Search query to use for searching the Galaxy Help forum. */ + query: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; }; }; responses: { - /** @description List of data types */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatatypeDetails"][] | string[]; + "application/json": components["schemas"]["HelpForumSearchResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Returns histories available to the current user. */ + index_api_histories_get: { + parameters: { + query?: { + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + show_own?: boolean; + show_published?: boolean; + show_shared?: boolean; + /** @description Whether to include archived histories. */ + show_archived?: boolean | null; + /** @description Sort index by this specified attribute */ + sort_by?: "create_time" | "name" | "update_time" | "username"; + /** @description Sort in descending order? */ + sort_desc?: boolean; + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `name` + * : The history's name. + * + * `annotation` + * : The history's annotation. (The tag `a` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The history's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Historys: `title`, `description`, `slug`, `tag`. + */ + search?: string | null; + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + all?: boolean | null; + /** + * @deprecated + * @description Whether to return only deleted items. + */ + deleted?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Creates a new history. + * @description The new history can also be copied form a existing history or imported from an archive or URL. + */ + create_api_histories_post: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": components["schemas"]["Body_create_api_histories_post"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["JobImportHistoryResponse"] + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - converters_api_datatypes_converters_get: { - /** - * Returns the list of all installed converters - * @description Gets the list of all installed converters. - */ + /** + * Get a list of all archived histories for the current user. + * @description Get a list of all archived histories for the current user. + * + * Archived histories are histories are not part of the active histories of the user but they can be accessed using this endpoint. + */ + get_archived_histories_api_histories_archived_get: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; responses: { - /** @description List of all datatype converters */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatatypeConverterList"]; + "application/json": unknown[]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Marks several histories with the given IDs as deleted. */ + batch_delete_api_histories_batch_delete_put: { + parameters: { + query?: { + purge?: boolean; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description Authentication required for this request */ - 403: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["DeleteHistoriesPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + }; + }; + /** Marks several histories with the given IDs as undeleted. */ + batch_undelete_api_histories_batch_undelete_put: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UndeleteHistoriesPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; - /** @description Validation error */ - 422: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - edam_data_api_datatypes_edam_data_get: { - /** - * Returns a dictionary/map of datatypes and EDAM data - * @description Gets a map of datatypes and their corresponding EDAM data. - */ + /** Returns number of histories for the current user. */ + count_api_histories_count_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; responses: { - /** @description Dictionary/map of datatypes and EDAM data */ + /** @description Successful Response */ 200: { content: { - "application/json": { - [key: string]: string; - }; + "application/json": number; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Returns deleted histories for the current user. */ + index_deleted_api_histories_deleted_get: { + parameters: { + query?: { + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + all?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Restores a deleted history with the given ID (that hasn't been purged). */ + undelete_api_histories_deleted__history_id__undelete_post: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; }; - }; - edam_data_detailed_api_datatypes_edam_data_detailed_get: { - /** - * Returns a dictionary of datatypes and EDAM data details - * @description Gets a map of datatypes and their corresponding EDAM data. - * EDAM data contains the EDAM iri, label, and definition. - */ responses: { - /** @description Dictionary of EDAM data details containing the EDAM iri, label, and definition */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Create histories from a model store. */ + create_from_store_api_histories_from_store_post: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryFromStore"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Launch a task to create histories from a model store. */ + create_from_store_async_api_histories_from_store_async_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryFromStore"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - edam_formats_api_datatypes_edam_formats_get: { - /** - * Returns a dictionary/map of datatypes and EDAM formats - * @description Gets a map of datatypes and their corresponding EDAM formats. - */ + /** Returns the most recently used history of the user. */ + show_recent_api_histories_most_recently_used_get: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; responses: { - /** @description Dictionary/map of datatypes and EDAM formats */ + /** @description Successful Response */ 200: { content: { - "application/json": { - [key: string]: string; - }; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Return all histories that are published. */ + published_api_histories_published_get: { + parameters: { + query?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + }; + }; + /** Return all histories that are shared with the current user. */ + shared_with_me_api_histories_shared_with_me_get: { + parameters: { + query?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; - /** @description Validation error */ - 422: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - edam_formats_detailed_api_datatypes_edam_formats_detailed_get: { - /** - * Returns a dictionary of datatypes and EDAM format details - * @description Gets a map of datatypes and their corresponding EDAM formats. - * EDAM formats contain the EDAM iri, label, and definition. - */ - responses: { - /** @description Dictionary of EDAM format details containing the EDAM iri, label, and definition */ - 200: { - content: { - "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + /** Returns the history with the given ID. */ + history_api_histories__history_id__get: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description Authentication required for this request */ - 403: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Updates the values for the history with the given ID. */ + update_api_histories__history_id__put: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": unknown; }; }; - }; - mapping_api_datatypes_mapping_get: { - /** - * Returns mappings for data types and their implementing classes - * @description Gets mappings for data types. - */ responses: { - /** @description Dictionary to map data types with their classes */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatatypesMap"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Marks the history with the given ID as deleted. */ + delete_api_histories__history_id__delete: { + parameters: { + query?: { + purge?: boolean; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryPayload"] | null; }; }; - }; - sniffers_api_datatypes_sniffers_get: { - /** - * Returns the list of all installed sniffers - * @description Gets the list of all installed data type sniffers. - */ responses: { - /** @description List of datatype sniffers */ + /** @description Successful Response */ 200: { content: { - "application/json": string[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Archive a history. + * @description Marks the given history as 'archived' and returns the history. + * + * Archiving a history will remove it from the list of active histories of the user but it will still be + * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. + * + * Associating an export record: + * + * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the + * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and + * must be in the ready state. + * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. + * + * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. + * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. + */ + archive_history_api_histories__history_id__archive_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ArchiveHistoryRequestPayload"] | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - types_and_mapping_api_datatypes_types_and_mapping_get: { - /** - * Returns all the data types extensions and their mappings - * @description Combines the datatype information from (/api/datatypes) and the - * mapping information from (/api/datatypes/mapping) into a single - * response. - */ - parameters?: { - /** @description Whether to return only the datatype's extension rather than the datatype's details */ - /** @description Whether to return only datatypes which can be uploaded */ + /** + * Restore an archived history. + * @description Restores an archived history and returns it. + * + * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). + * + * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them + * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export + * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. + */ + restore_archived_history_api_histories__history_id__archive_restore_put: { + parameters: { query?: { - /** @description Whether to return only the datatype's extension rather than the datatype's details */ - extension_only?: boolean | null; - /** @description Whether to return only datatypes which can be uploaded */ - upload_only?: boolean | null; + /** @description If true, the history will be un-archived even if it has an associated archive export record and was purged. */ + force?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; }; responses: { - /** @description Dictionary to map data types with their classes */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DatatypesCombinedMap"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Return all the citations for the tools used to produce the datasets in the history. */ + citations_api_histories__history_id__citations_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown[]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Returns the contents of the given history. + * @description Return a list of `HDA`/`HDCA` data for the history with the given ``ID``. + * + * - The contents can be filtered and queried using the appropriate parameters. + * - The amount of information returned for each item can be customized. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ + history_contents__index: { + parameters: { + query?: { + /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ + v?: string | null; + /** + * @deprecated + * @description Legacy name for the `dataset_details` parameter. + */ + details?: string | null; + /** + * @deprecated + * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. + */ + ids?: string | null; + /** + * @deprecated + * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. + */ + types?: string[] | null; + /** + * @deprecated + * @description Whether to return deleted or undeleted datasets only. Leave unset for both. + */ + deleted?: boolean | null; + /** + * @deprecated + * @description Whether to return visible or hidden datasets only. Leave unset for both. + */ + visible?: boolean | null; + /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ + shareable?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; }; - }; - display_applications_index_api_display_applications_get: { - /** - * Returns the list of display applications. - * @description Returns the list of display applications. - */ responses: { - /** @description Successful Response */ + /** @description The contents of the history that match the query. */ 200: { content: { - "application/json": components["schemas"]["DisplayApplication"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["HistoryContentsResult"]; + "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Batch update specific properties of a set items contained in the given History. + * @description Batch update specific properties of a set items contained in the given History. + * + * If you provide an invalid/unknown property key the request will not fail, but no changes + * will be made to the items. + */ + update_batch_api_histories__history_id__contents_put: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryContentsBatchPayload"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["HistoryContentsResult"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - display_applications_reload_api_display_applications_reload_post: { - /** - * Reloads the list of display applications. - * @description Reloads the list of display applications. - */ - parameters?: { - /** @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. */ + /** + * Create a new `HDA` or `HDCA` in the given History. + * @deprecated + * @description Create a new `HDA` or `HDCA` in the given History. + */ + history_contents__create: { + parameters: { + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"] | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; }; - requestBody?: { + requestBody: { content: { - "application/json": { - [key: string]: string[]; - } | null; + "application/json": components["schemas"]["CreateHistoryContentPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ReloadFeedback"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + | ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Build and return a compressed archive of the selected history contents. + * @description Build and return a compressed archive of the selected history contents. + * + * **Note**: this is a volatile endpoint and settings and behavior may change. + */ + history_contents__archive: { + parameters: { + query?: { + /** @description The name that the Archive will have (defaults to history name). */ + filename?: string | null; + /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ + dry_run?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - download_api_drs_download__object_id__get: { - /** Download */ + /** + * Build and return a compressed archive of the selected history contents. + * @description Build and return a compressed archive of the selected history contents. + * + * **Note**: this is a volatile endpoint and settings and behavior may change. + */ + history_contents__archive_named: { parameters: { + query?: { + /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ + dry_run?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group */ - object_id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The name that the Archive will have (defaults to history name). */ + filename: string; + /** + * @deprecated + * @description Output format of the archive. + */ + format: string; }; }; responses: { /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Executes an operation on a set of items contained in the given History. + * @description Executes an operation on a set of items contained in the given History. + * + * The items to be processed can be explicitly set or determined by a dynamic query. + */ + bulk_operation_api_histories__history_id__contents_bulk_put: { + parameters: { + query?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["HistoryContentBulkOperationPayload"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["HistoryContentBulkOperationResult"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - file_sources__instances_index: { - /** Get a list of persisted file source instances defined by the requesting user. */ - parameters?: { - /** @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. */ + /** + * Download the content of a dataset collection as a `zip` archive. + * @description Download the content of a history dataset collection as a `zip` archive + * while maintaining approximate collection structure. + */ + history_contents__download_collection: { + parameters: { header?: { + /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; + /** @description The encoded database identifier of the History. */ + history_id: string | null; + }; }; responses: { /** @description Successful Response */ 200: { - content: { - "application/json": components["schemas"]["UserFileSourceModel"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + content: never; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Materialize a deferred dataset into real, usable dataset. */ + materialize_dataset_api_histories__history_id__contents_datasets__id__materialize_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - file_sources__create_instance: { - /** Create a user-bound file source. */ - parameters?: { - /** @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. */ + /** + * Set permissions of the given history dataset to the given role ids. + * @description Set permissions of the given history dataset to the given role ids. + */ + update_permissions_api_histories__history_id__contents__dataset_id__permissions_put: { + parameters: { header?: { + /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + dataset_id: string; + }; }; requestBody: { content: { - "application/json": components["schemas"]["CreateInstancePayload"]; + "application/json": Record; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserFileSourceModel"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatasetAssociationRoles"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Displays (preview) or downloads dataset content. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. + */ + history_contents_display_api_histories__history_id__contents__history_content_id__display_get: { + parameters: { + query?: { + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ + offset?: number | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; + history_id: string | null; }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: never; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - file_sources__test_new_instance_configuration: { - /** Test payload for creating user-bound file source. */ - parameters?: { - /** @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. */ + /** + * Check if dataset content can be previewed or downloaded. + * @description Streams the dataset for download or the contents preview to be displayed in a browser. + */ + history_contents_display_api_histories__history_id__contents__history_content_id__display_head: { + parameters: { + query?: { + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ + offset?: number | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; + }; header?: { + /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInstancePayload"]; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; + history_id: string | null; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["PluginStatus"]; + "application/json": unknown; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Get the list of extra files/directories associated with a dataset. */ + extra_files_history_api_histories__history_id__contents__history_content_id__extra_files_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DatasetExtraFiles"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Returns the metadata file associated with this history item. */ + history_contents__get_metadata_file: { + parameters: { + query: { + /** @description The name of the metadata file to retrieve. */ + metadata_file: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: never; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - file_sources__instances_get: { - /** Get a persisted user file source instance. */ + /** Show tags based on history_content_id */ + index_api_histories__history_id__contents__history_content_id__tags_get: { parameters: { - /** @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?: { + /** @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. */ "run-as"?: string | null; }; - /** @description The UUID index for a persisted UserFileSourceStore object. */ path: { - user_file_source_id: string; + history_content_id: string; + history_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserFileSourceModel"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Show tag based on history_content_id */ + show_api_histories__history_id__contents__history_content_id__tags__tag_name__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + history_content_id: string; + tag_name: string; + history_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - file_sources__instances_update: { - /** Update or upgrade user file source instance. */ + /** Update tag based on history_content_id */ + update_api_histories__history_id__contents__history_content_id__tags__tag_name__put: { parameters: { - /** @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?: { + /** @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. */ "run-as"?: string | null; }; - /** @description The UUID index for a persisted UserFileSourceStore object. */ path: { - user_file_source_id: string; + history_content_id: string; + tag_name: string; + history_id: string; }; }; requestBody: { content: { - "application/json": - | components["schemas"]["UpdateInstanceSecretPayload"] - | components["schemas"]["UpgradeInstancePayload"] - | components["schemas"]["UpdateInstancePayload"]; + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserFileSourceModel"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Create tag based on history_content_id */ + create_api_histories__history_id__contents__history_content_id__tags__tag_name__post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + history_content_id: string; + tag_name: string; + history_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Delete tag based on history_content_id */ + delete_api_histories__history_id__contents__history_content_id__tags__tag_name__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_content_id: string; + tag_name: string; + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": boolean; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - file_sources__instances_purge: { - /** Purge user file source instance. */ + /** + * Return detailed information about an HDA within a history. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. + * @deprecated + * @description Return detailed information about an `HDA` or `HDCA` within a history. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ + history_contents__show_legacy: { parameters: { - /** @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. */ + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; + /** @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. */ + fuzzy_count?: number | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { + /** @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. */ "run-as"?: string | null; }; - /** @description The UUID index for a persisted UserFileSourceStore object. */ path: { - user_file_source_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; }; }; responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Updates the values for the history content item with the given ``ID`` and query specified type. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. + * @deprecated + * @description Updates the values for the history content item with the given ``ID``. + */ + history_contents__update_legacy: { + parameters: { + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - file_sources__templates_index: { - /** Get a list of file source templates available to build user defined file sources from */ - parameters?: { - /** @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. */ + /** + * Delete the history dataset with the given ``ID``. + * @description Delete the history content with the given ``ID`` and query specified type (defaults to dataset). + * + * **Note**: Currently does not stop any active jobs for which this dataset is an output. + */ + history_contents__delete_legacy: { + parameters: { + query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; + /** + * @deprecated + * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. + */ + purge?: boolean | null; + /** + * @deprecated + * @description When deleting a dataset collection, whether to also delete containing datasets. + */ + recursive?: boolean | null; + /** + * @deprecated + * @description Whether to stop the creating job if all outputs of the job have been deleted. + */ + stop_job?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { + /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentPayload"]; + }; }; responses: { - /** @description A list of the configured file source templates. */ + /** @description Request has been executed. */ 200: { content: { - "application/json": components["schemas"]["FileSourceTemplateSummaries"]; + "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + /** @description Request accepted, processing will finish later. */ 202: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Validates the metadata associated with a dataset within a History. + * @description Validates the metadata associated with a dataset within a History. + */ + validate_api_histories__history_id__contents__id__validate_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": Record; }; }; - /** @description Validation error */ - 422: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_folders__folder_id__contents_get: { - /** - * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. - * @description Returns a list of a folder's contents (files and sub-folders). - * - * Additional metadata for the folder is provided in the response as a separate object containing data - * for breadcrumb path building, permissions and other folder's details. - * - * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). - * - * **Security note**: - * - Accessing a library folder or sub-folder requires only access to the parent library. - * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. - * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. - */ + /** + * Returns the contents of the given history filtered by type. + * @description Return a list of either `HDA`/`HDCA` data for the history with the given ``ID``. + * + * - The contents can be filtered and queried using the appropriate parameters. + * - The amount of information returned for each item can be customized. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ + history_contents__index_typed: { parameters: { query?: { - /** @description Maximum number of contents to return. */ - limit?: number; - /** @description Return contents from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, contents between position 200-299 will be returned. */ - offset?: number; - /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ - search_text?: string | null; - /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ - include_deleted?: boolean | null; - /** @description Sort results by specified field. */ - order_by?: "name" | "description" | "type" | "size" | "update_time"; - /** @description Sort results in descending order. */ - sort_desc?: boolean | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - folder_id: string; - }; - }; - responses: { - /** @description The contents of the folder that match the query parameters. */ - 200: { - content: { - "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - add_history_datasets_to_library_api_folders__folder_id__contents_post: { - /** Creates a new library file from an existing HDA/HDCA. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - folder_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibraryFilePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ + v?: string | null; + /** + * @deprecated + * @description Legacy name for the `dataset_details` parameter. + */ + details?: string | null; + /** + * @deprecated + * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. + */ + ids?: string | null; + /** + * @deprecated + * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. + */ + types?: string[] | null; + /** + * @deprecated + * @description Whether to return deleted or undeleted datasets only. Leave unset for both. + */ + deleted?: boolean | null; + /** + * @deprecated + * @description Whether to return visible or hidden datasets only. Leave unset for both. + */ + visible?: boolean | null; + /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ + shareable?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @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. */ + order?: string | null; }; - }; - }; - show_api_folders__id__get: { - /** - * Displays information about a particular library folder. - * @description Returns detailed information about the library folder with the given ID. - */ - parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_folders__id__put: { - /** - * Updates the information of an existing library folder. - * @description Updates the information of an existing library folder. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_folders__id__post: { - /** - * Create a new library folder underneath the one specified by the ID. - * @description Returns detailed information about the newly created library folder. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibraryFolderPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_folders__id__delete: { - /** - * Marks the specified library folder as deleted (or undeleted). - * @description Marks the specified library folder as deleted (or undeleted). - */ - parameters: { - query?: { - /** @description Whether to restore a deleted library folder. */ - undelete?: boolean | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_folders__id__patch: { - /** - * Update - * @description Updates the information of an existing library folder. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_permissions_api_folders__id__permissions_get: { - /** - * Gets the current or available permissions of a particular library folder. - * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. - */ - parameters: { - query?: { - /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ - scope?: components["schemas"]["LibraryPermissionScope"] | null; - /** @description The page number to retrieve when paginating the available roles. */ - page?: number; - /** @description The maximum number of permissions per page when paginating. */ - page_limit?: number; - /** @description Optional search text to retrieve only the roles matching this query. */ - q?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["LibraryFolderCurrentPermissions"] - | components["schemas"]["LibraryAvailablePermissions"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - set_permissions_api_folders__id__permissions_post: { - /** - * Sets the permissions to manage a library folder. - * @description Sets the permissions to manage a library folder. - */ - parameters: { - query?: { - /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ - action?: components["schemas"]["LibraryFolderPermissionAction"] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["LibraryFolderPermissionsPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibraryFolderCurrentPermissions"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_forms__id__delete: { - /** Delete */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - undelete_api_forms__id__undelete_post: { - /** Undelete */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_ftp_files_get: { - /** - * Displays remote files available to the user. Please use /api/remote_files instead. - * @deprecated - * @description Lists all remote files available to the user from different sources. - * - * The total count of files and directories is returned in the 'total_matches' header. - */ - parameters?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - /** @description Maximum number of entries to return. */ - /** @description Number of entries to skip. */ - /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ - /** @description Sort the entries by the specified field. */ - query?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - target?: string; - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - format?: components["schemas"]["RemoteFilesFormat"] | null; - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - recursive?: boolean | null; - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - disable?: components["schemas"]["RemoteFilesDisableMode"] | null; - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - writeable?: boolean | null; - limit?: number | null; - offset?: number | null; - query?: string | null; - sort_by?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["ListUriResponse"] - | components["schemas"]["ListJstreeResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_genomes_get: { - /** Return a list of installed genomes */ - parameters?: { - /** @description If true, return genome keys with chromosome lengths */ - query?: { - /** @description If true, return genome keys with chromosome lengths */ - chrom_info?: boolean; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Installed genomes */ - 200: { - content: { - "application/json": string[][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_api_genomes__id__get: { - /** Return information about build */ - parameters: { - query?: { - /** @description If true, return reference data */ - reference?: boolean; - /** @description Limits size of returned data */ - num?: number; - /** @description Limits size of returned data */ - chrom?: string; - /** @description Limits size of returned data */ - low?: number; - /** @description Limits size of returned data */ - high?: number; - /** @description Format */ - format?: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description Genome ID */ - id: string; - }; - }; - responses: { - /** @description Information about genome build */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - indexes_api_genomes__id__indexes_get: { - /** Return all available indexes for a genome id for provided type */ - parameters: { - query?: { - /** @description Index type */ - type?: string; - /** @description Format */ - format?: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description Genome ID */ - id: string; - }; - }; - responses: { - /** @description Indexes for a genome id for provided type */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - sequences_api_genomes__id__sequences_get: { - /** Return raw sequence data */ - parameters: { - query?: { - /** @description If true, return reference data */ - reference?: boolean; - /** @description Limits size of returned data */ - chrom?: string; - /** @description Limits size of returned data */ - low?: number; - /** @description Limits size of returned data */ - high?: number; - /** @description Format */ - format?: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description Genome ID */ - id: string; - }; - }; - responses: { - /** @description Raw sequence data */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_groups_get: { - /** Displays a collection (list) of groups. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_groups_post: { - /** Creates a new group. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["GroupCreatePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_group_api_groups__group_id__get: { - /** Displays information about a group. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - group_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_groups__group_id__put: { - /** Modifies a group. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - group_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["GroupUpdatePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_groups__group_id__delete: { - /** Delete */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - group_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - purge_api_groups__group_id__purge_post: { - /** Purge */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - group_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - group_roles_api_groups__group_id__roles_get: { - /** Displays a collection (list) of groups. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupRoleListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - group_role_api_groups__group_id__roles__role_id__get: { - /** Displays information about a group role. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the role. */ - role_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupRoleResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_groups__group_id__roles__role_id__put: { - /** Adds a role to a group */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the role. */ - role_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupRoleResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_groups__group_id__roles__role_id__delete: { - /** Removes a role from a group */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the role. */ - role_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupRoleResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - undelete_api_groups__group_id__undelete_post: { - /** Undelete */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - group_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - group_user_api_groups__group_id__user__user_id__get: { - /** - * Displays information about a group user. - * @description Displays information about a group user. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupUserResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_groups__group_id__user__user_id__put: { - /** - * Adds a user to a group - * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupUserResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_groups__group_id__user__user_id__delete: { - /** - * Removes a user from a group - * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupUserResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - group_users_api_groups__group_id__users_get: { - /** - * Displays a collection (list) of groups. - * @description GET /api/groups/{encoded_group_id}/users - * Displays a collection (list) of groups. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupUserListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - group_user_api_groups__group_id__users__user_id__get: { - /** - * Displays information about a group user. - * @description Displays information about a group user. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupUserResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_groups__group_id__users__user_id__put: { - /** - * Adds a user to a group - * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupUserResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_groups__group_id__users__user_id__delete: { - /** - * Removes a user from a group - * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["GroupUserResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - search_forum_api_help_forum_search_get: { - /** - * Search the Galaxy Help forum. - * @description Search the Galaxy Help forum using the Discourse API. - * - * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. - */ - parameters: { - query: { - /** @description Search query to use for searching the Galaxy Help forum. */ - query: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["HelpForumSearchResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_histories_get: { - /** Returns histories available to the current user. */ - parameters?: { - /** @description The maximum number of items to return. */ - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - /** @description Whether to include archived histories. */ - /** @description Sort index by this specified attribute */ - /** @description Sort in descending order? */ - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `name` - * : The history's name. - * - * `annotation` - * : The history's annotation. (The tag `a` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The history's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Historys: `title`, `description`, `slug`, `tag`. - */ - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - /** - * @deprecated - * @description Whether to return only deleted items. - */ - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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?: { - limit?: number | null; - offset?: number | null; - show_own?: boolean; - show_published?: boolean; - show_shared?: boolean; - show_archived?: boolean | null; - sort_by?: "create_time" | "name" | "update_time" | "username"; - sort_desc?: boolean; - search?: string | null; - all?: boolean | null; - deleted?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @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. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_histories_post: { - /** - * Creates a new history. - * @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?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": components["schemas"]["Body_create_api_histories_post"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["JobImportHistoryResponse"] - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_archived_histories_api_histories_archived_get: { - /** - * Get a list of all archived histories for the current user. - * @description Get a list of all archived histories for the current user. - * - * 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. */ - /** @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. */ - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["ArchivedHistorySummary"] - | components["schemas"]["ArchivedHistoryDetailed"] - | Record - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - batch_delete_api_histories_batch_delete_put: { - /** Marks several histories with the given IDs 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; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["DeleteHistoriesPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - batch_undelete_api_histories_batch_undelete_put: { - /** Marks several histories with the given IDs as undeleted. */ - parameters?: { - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UndeleteHistoriesPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - count_api_histories_count_get: { - /** Returns number of histories for the current user. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": number; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_deleted_api_histories_deleted_get: { - /** Returns deleted histories for the current user. */ - parameters?: { - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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?: { - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - all?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - undelete_api_histories_deleted__history_id__undelete_post: { - /** Restores a deleted history with the given ID (that hasn't been purged). */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - 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?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryFromStore"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_from_store_async_api_histories_from_store_async_post: { - /** Launch a task to create histories from a model store. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryFromStore"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - 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?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - published_api_histories_published_get: { - /** Return all histories that are published. */ - parameters?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - shared_with_me_api_histories_shared_with_me_get: { - /** Return all histories that are shared with the current user. */ - parameters?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_api_histories__history_id__get: { - /** Returns the history with the given ID. */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_histories__history_id__put: { - /** Updates the values for the history with the given ID. */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": unknown; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_histories__history_id__delete: { - /** Marks the history with the given ID as deleted. */ - parameters: { - query?: { - purge?: boolean; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryPayload"] | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - archive_history_api_histories__history_id__archive_post: { - /** - * Archive a history. - * @description Marks the given history as 'archived' and returns the history. - * - * Archiving a history will remove it from the list of active histories of the user but it will still be - * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. - * - * Associating an export record: - * - * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the - * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and - * must be in the ready state. - * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. - * - * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. - * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ArchiveHistoryRequestPayload"] | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["ArchivedHistorySummary"] - | components["schemas"]["ArchivedHistoryDetailed"] - | Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - restore_archived_history_api_histories__history_id__archive_restore_put: { - /** - * Restore an archived history. - * @description Restores an archived history and returns it. - * - * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). - * - * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them - * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export - * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. - */ - parameters: { - query?: { - /** @description If true, the history will be un-archived even if it has an associated archive export record and was purged. */ - force?: boolean | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - citations_api_histories__history_id__citations_get: { - /** Return all the citations for the tools used to produce the datasets in the history. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__index: { - /** - * Returns the contents of the given history. - * @description Return a list of `HDA`/`HDCA` data for the history with the given ``ID``. - * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - parameters: { - query?: { - /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ - v?: string | null; - /** - * @deprecated - * @description Legacy name for the `dataset_details` parameter. - */ - details?: string | null; - /** - * @deprecated - * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. - */ - ids?: string | null; - /** - * @deprecated - * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. - */ - types?: string[] | null; - /** - * @deprecated - * @description Whether to return deleted or undeleted datasets only. Leave unset for both. - */ - deleted?: boolean | null; - /** - * @deprecated - * @description Whether to return visible or hidden datasets only. Leave unset for both. - */ - visible?: boolean | null; - /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ - shareable?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description The contents of the history that match the query. */ - 200: { - content: { - "application/json": components["schemas"]["HistoryContentsResult"]; - "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_batch_api_histories__history_id__contents_put: { - /** - * Batch update specific properties of a set items contained in the given History. - * @description Batch update specific properties of a set items contained in the given History. - * - * If you provide an invalid/unknown property key the request will not fail, but no changes - * will be made to the items. - */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateHistoryContentsBatchPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["HistoryContentsResult"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__create: { - /** - * Create a new `HDA` or `HDCA` in the given History. - * @deprecated - * @description Create a new `HDA` or `HDCA` in the given History. - */ - parameters: { - query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"] | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryContentPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - | ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__archive: { - /** - * Build and return a compressed archive of the selected history contents. - * @description Build and return a compressed archive of the selected history contents. - * - * **Note**: this is a volatile endpoint and settings and behavior may change. - */ - parameters: { - query?: { - /** @description The name that the Archive will have (defaults to history name). */ - filename?: string | null; - /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ - dry_run?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__archive_named: { - /** - * Build and return a compressed archive of the selected history contents. - * @description Build and return a compressed archive of the selected history contents. - * - * **Note**: this is a volatile endpoint and settings and behavior may change. - */ - parameters: { - query?: { - /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ - dry_run?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The name that the Archive will have (defaults to history name). */ - filename: string; - /** - * @deprecated - * @description Output format of the archive. - */ - format: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - bulk_operation_api_histories__history_id__contents_bulk_put: { - /** - * Executes an operation on a set of items contained in the given History. - * @description Executes an operation on a set of items contained in the given History. - * - * The items to be processed can be explicitly set or determined by a dynamic query. - */ - parameters: { - query?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["HistoryContentBulkOperationPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["HistoryContentBulkOperationResult"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__download_collection: { - /** - * Download the content of a dataset collection as a `zip` archive. - * @description Download the content of a history dataset collection as a `zip` archive - * while maintaining approximate collection structure. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the `HDCA`. */ - id: string; - /** @description The encoded database identifier of the History. */ - history_id: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - materialize_dataset_api_histories__history_id__contents_datasets__id__materialize_post: { - /** Materialize a deferred dataset into real, usable dataset. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_permissions_api_histories__history_id__contents__dataset_id__permissions_put: { - /** - * Set permissions of the given history dataset to the given role ids. - * @description Set permissions of the given history dataset to the given role ids. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - dataset_id: string; - }; - }; - requestBody: { - content: { - "application/json": Record; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["DatasetAssociationRoles"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents_display_api_histories__history_id__contents__history_content_id__display_get: { - /** - * Displays (preview) or downloads dataset content. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ - parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; - history_id: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents_display_api_histories__history_id__contents__history_content_id__display_head: { - /** - * Check if dataset content can be previewed or downloaded. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ - parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; - history_id: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - extra_files_history_api_histories__history_id__contents__history_content_id__extra_files_get: { - /** Get the list of extra files/directories associated with a dataset. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the History Dataset. */ - history_content_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["DatasetExtraFiles"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__get_metadata_file: { - /** Returns the metadata file associated with this history item. */ - parameters: { - query: { - /** @description The name of the metadata file to retrieve. */ - metadata_file: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the History Dataset. */ - history_content_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_histories__history_id__contents__history_content_id__tags_get: { - /** Show tags based on history_content_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_content_id: string; - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ItemTagsListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_api_histories__history_id__contents__history_content_id__tags__tag_name__get: { - /** Show tag based on history_content_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_content_id: string; - tag_name: string; - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ItemTagsResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_histories__history_id__contents__history_content_id__tags__tag_name__put: { - /** Update tag based on history_content_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_content_id: string; - tag_name: string; - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ItemTagsResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_histories__history_id__contents__history_content_id__tags__tag_name__post: { - /** Create tag based on history_content_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_content_id: string; - tag_name: string; - history_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ItemTagsResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_histories__history_id__contents__history_content_id__tags__tag_name__delete: { - /** Delete tag based on history_content_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_content_id: string; - tag_name: string; - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": boolean; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__show_legacy: { - /** - * Return detailed information about an HDA within a history. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. - * @deprecated - * @description Return detailed information about an `HDA` or `HDCA` within a history. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - parameters: { - query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; - /** @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. */ - fuzzy_count?: number | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__update_legacy: { - /** - * Updates the values for the history content item with the given ``ID`` and query specified type. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. - * @deprecated - * @description Updates the values for the history content item with the given ``ID``. - */ - parameters: { - query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__delete_legacy: { - /** - * Delete the history dataset with the given ``ID``. - * @description Delete the history content with the given ``ID`` and query specified type (defaults to dataset). - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. - */ - parameters: { - query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - purge?: boolean | null; - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - recursive?: boolean | null; - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - stop_job?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentPayload"]; - }; - }; - responses: { - /** @description Request has been executed. */ - 200: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; - }; - }; - /** @description Request accepted, processing will finish later. */ - 202: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - validate_api_histories__history_id__contents__id__validate_put: { - /** - * Validates the metadata associated with a dataset within a History. - * @description Validates the metadata associated with a dataset within a History. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__index_typed: { - /** - * Returns the contents of the given history filtered by type. - * @description Return a list of either `HDA`/`HDCA` data for the history with the given ``ID``. - * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - parameters: { - query?: { - /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ - v?: string | null; - /** - * @deprecated - * @description Legacy name for the `dataset_details` parameter. - */ - details?: string | null; - /** - * @deprecated - * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. - */ - ids?: string | null; - /** - * @deprecated - * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. - */ - types?: string[] | null; - /** - * @deprecated - * @description Whether to return deleted or undeleted datasets only. Leave unset for both. - */ - deleted?: boolean | null; - /** - * @deprecated - * @description Whether to return visible or hidden datasets only. Leave unset for both. - */ - visible?: boolean | null; - /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ - shareable?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @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. */ - order?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["HistoryContentsResult"] - | components["schemas"]["HistoryContentsWithStatsResult"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__create_typed: { - /** - * Create a new `HDA` or `HDCA` in the given History. - * @description Create a new `HDA` or `HDCA` in the given History. - */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryContentPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - | ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__show: { - /** - * Return detailed information about a specific HDA or HDCA with the given `ID` within a history. - * @description Return detailed information about an `HDA` or `HDCA` within a history. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - parameters: { - query?: { - /** @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. */ - fuzzy_count?: number | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__update_typed: { - /** - * Updates the values for the history content item with the given ``ID`` and path specified type. - * @description Updates the values for the history content item with the given ``ID``. - */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_contents__delete_typed: { - /** - * Delete the history content with the given ``ID`` and path specified type. - * @description Delete the history content with the given ``ID`` and path specified type. - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. - */ - parameters: { - query?: { - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - purge?: boolean | null; - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - recursive?: boolean | null; - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - stop_job?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentPayload"]; - }; - }; - responses: { - /** @description Request has been executed. */ - 200: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; - }; - }; - /** @description Request accepted, processing will finish later. */ - 202: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_jobs_summary_api_histories__history_id__contents__type_s__id__jobs_summary_get: { - /** - * Return detailed information about an `HDA` or `HDCAs` jobs. - * @description Return detailed information about an `HDA` or `HDCAs` jobs. - * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["JobStateSummary"] - | components["schemas"]["ImplicitCollectionJobsStateSummary"] - | components["schemas"]["WorkflowInvocationStateSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - prepare_store_download_api_histories__history_id__contents__type_s__id__prepare_store_download_post: { - /** Prepare a dataset or dataset collection for export-style download. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["StoreExportPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["AsyncFile"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - write_store_api_histories__history_id__contents__type_s__id__write_store_post: { - /** Prepare a dataset or dataset collection for export-style download and write to supplied URI. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["WriteStoreToPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_from_store_api_histories__history_id__contents_from_store_post: { - /** - * Create contents from store. - * @description Create history contents from model store. - * Input can be a tarfile created with build_objects script distributed - * with galaxy-data, from an exported history with files stripped out, - * or hand-crafted JSON dictionary. - */ - parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryContentFromStore"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_custom_builds_metadata_api_histories__history_id__custom_builds_metadata_get: { - /** Returns meta data for custom builds. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["CustomBuildsMetadataResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - disable_link_access_api_histories__history_id__disable_link_access_put: { - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - enable_link_access_api_histories__history_id__enable_link_access_put: { - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_history_exports_api_histories__history_id__exports_get: { - /** - * Get previous history exports. - * @description By default the legacy job-based history exports (jeha) are returned. - * - * Change the `accept` content type header to return the new task-based history exports. - */ - parameters: { - query?: { - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description A list of history exports */ - 200: { - content: { - "application/json": components["schemas"]["JobExportHistoryArchiveListResponse"]; - "application/vnd.galaxy.task.export+json": components["schemas"]["ExportTaskListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - archive_export_api_histories__history_id__exports_put: { - /** - * Start job (if needed) to create history export for corresponding history. - * @deprecated - * @description This will start a job to create a history export archive. - * - * Calling this endpoint multiple times will return the 202 status code until the archive - * has been completely generated and is ready to download. When ready, it will return - * the 200 status code along with the download link information. - * - * If the history will be exported to a `directory_uri`, instead of returning the download - * link information, the Job ID will be returned so it can be queried to determine when - * the file has been written. - * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ExportHistoryArchivePayload"] | null; - }; - }; - responses: { - /** @description Object containing url to fetch export from. */ - 200: { - content: { - "application/json": - | components["schemas"]["JobExportHistoryArchiveModel"] - | components["schemas"]["JobIdResponse"]; - }; - }; - /** @description The exported archive file is not ready yet. */ - 202: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - history_archive_download_api_histories__history_id__exports__jeha_id__get: { - /** - * If ready and available, return raw contents of exported history as a downloadable archive. - * @deprecated - * @description See ``PUT /api/histories/{id}/exports`` to initiate the creation - * of the history export - when ready, that route will return 200 status - * code (instead of 202) and this route can be used to download the archive. - * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the specific Job Export History Association or `latest` (default) to download the last generated archive. */ - jeha_id: string | "latest"; - }; - }; - responses: { - /** @description The archive file containing the History. */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_jobs_summary_api_histories__history_id__jobs_summary_get: { - /** - * Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. - * @description Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. - * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - parameters: { - query?: { - /** @description A comma-separated list of encoded ids of job summary objects to return - if `ids` is specified types must also be specified and have same length. */ - ids?: string | null; - /** @description A comma-separated list of type of object represented by elements in the `ids` array - any of `Job`, `ImplicitCollectionJob`, or `WorkflowInvocation`. */ - types?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["JobStateSummary"] - | components["schemas"]["ImplicitCollectionJobsStateSummary"] - | components["schemas"]["WorkflowInvocationStateSummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - materialize_to_history_api_histories__history_id__materialize_post: { - /** Materialize a deferred library or HDA dataset into real, usable dataset in specified history. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["MaterializeDatasetInstanceAPIRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - prepare_store_download_api_histories__history_id__prepare_store_download_post: { - /** Return a short term storage token to monitor download of the history. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["StoreExportPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["AsyncFile"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - publish_api_histories__history_id__publish_put: { - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - share_with_users_api_histories__history_id__share_with_users_put: { - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ShareWithPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ShareHistoryWithStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - sharing_api_histories__history_id__sharing_get: { - /** - * Get the current sharing status of the given item. - * @description Return the sharing status of the item. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - set_slug_api_histories__history_id__slug_put: { - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["SetSlugPayload"]; - }; - }; - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_histories__history_id__tags_get: { - /** Show tags based on history_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ItemTagsListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_api_histories__history_id__tags__tag_name__get: { - /** Show tag based on history_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_id: string; - tag_name: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ItemTagsResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_histories__history_id__tags__tag_name__put: { - /** Update tag based on history_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_id: string; - tag_name: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ItemTagsResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_histories__history_id__tags__tag_name__post: { - /** Create tag based on history_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_id: string; - tag_name: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ItemTagsResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_histories__history_id__tags__tag_name__delete: { - /** Delete tag based on history_id */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - history_id: string; - tag_name: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": boolean; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - unpublish_api_histories__history_id__unpublish_put: { - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - write_store_api_histories__history_id__write_store_post: { - /** Prepare history for export-style download and write to supplied URI. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["WriteStoreToPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_invocations_api_invocations_get: { - /** Get the list of a user's workflow invocations. */ - 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?: { - /** @description Return only invocations for this Workflow ID */ - workflow_id?: string | null; - /** @description Return only invocations for this History ID */ - history_id?: string | null; - /** @description Return only invocations for this Job ID */ - job_id?: string | null; - /** @description Return invocations for this User ID. */ - user_id?: string | null; - /** @description Sort Workflow Invocations by this attribute */ - sort_by?: components["schemas"]["InvocationSortByEnum"] | null; - /** @description Sort in descending order? */ - sort_desc?: boolean; - /** @description Set to false to only include terminal Invocations. */ - include_terminal?: boolean | null; - /** @description Limit the number of invocations to return. */ - limit?: number | null; - /** @description Number of invocations to skip. */ - offset?: number | null; - /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ - instance?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - include_nested_invocations?: boolean; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_invocations_from_store_api_invocations_from_store_post: { - /** - * Create Invocations From Store - * @description Create invocation(s) from a supplied model store. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInvocationsFromStorePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - step_api_invocations_steps__step_id__get: { - /** Show details of workflow invocation step. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["InvocationStep"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_invocation_api_invocations__invocation_id__get: { - /** Get detailed description of a workflow invocation. */ - parameters: { - query?: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ - legacy_job_state?: boolean; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - cancel_invocation_api_invocations__invocation_id__delete: { - /** Cancel the specified workflow invocation. */ - parameters: { - query?: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ - legacy_job_state?: boolean; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - invocation_jobs_summary_api_invocations__invocation_id__jobs_summary_get: { - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["InvocationJobsResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - prepare_store_download_api_invocations__invocation_id__prepare_store_download_post: { - /** Prepare a workflow invocation export-style download. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["PrepareStoreDownloadPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["AsyncFile"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_invocation_report_api_invocations__invocation_id__report_get: { - /** Get JSON summarizing invocation for reporting. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["InvocationReport"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get: { - /** Get PDF summarizing invocation for reporting. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - invocation_step_jobs_summary_api_invocations__invocation_id__step_jobs_summary_get: { - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["InvocationStepJobsResponseStepModel"] - | components["schemas"]["InvocationStepJobsResponseJobModel"] - | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - invocation_step_api_invocations__invocation_id__steps__step_id__get: { - /** - * Show details of workflow invocation step. - * @description An alias for `GET /api/invocations/steps/{step_id}`. `invocation_id` is ignored. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["InvocationStep"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_invocation_step_api_invocations__invocation_id__steps__step_id__put: { - /** Update state of running workflow step invocation - still very nebulous but this would be for stuff like confirming paused steps can proceed etc. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["InvocationUpdatePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["InvocationStep"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - write_store_api_invocations__invocation_id__write_store_post: { - /** Prepare a workflow invocation export-style download and write to supplied URI. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["WriteInvocationStoreToPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - job_lock_status_api_job_lock_get: { - /** - * Job Lock Status - * @description Get job lock status. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["JobLock"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_job_lock_api_job_lock_put: { - /** - * Update Job Lock - * @description Set job lock status. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["JobLock"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["JobLock"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_jobs_get: { - /** Index */ - parameters?: { - /** @description If true, and requester is an admin, will return external job id and user email. This is only available to admins. */ - /** @description an encoded user id to restrict query to, must be own id if not admin user */ - /** @description Determines columns to return. Defaults to 'collection'. */ - /** @description Limit listing of jobs to those that are updated after specified date (e.g. '2014-01-01') */ - /** @description Limit listing of jobs to those that are updated before specified date (e.g. '2014-01-01') */ - /** @description Limit listing of jobs to those that match the history_id. If none, jobs from any history may be returned. */ - /** @description Limit listing of jobs to those that match the specified workflow ID. If none, jobs from any workflow (or from no workflows) may be returned. */ - /** @description Limit listing of jobs to those that match the specified workflow invocation ID. If none, jobs from any workflow invocation (or from no workflows) may be returned. */ - /** @description Limit listing of jobs to those that match the specified implicit collection job ID. If none, jobs from any implicit collection execution (or from no implicit collection execution) may be returned. */ - /** @description Sort results by specified field. */ - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `user` - * : The user email of the user that executed the Job. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tool_id` - * : The tool ID corresponding to the job. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `runner` - * : The job runner name used to execute the job. (The tag `r` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. - * - * `handler` - * : The job handler name used to execute the job. (The tag `h` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Jobs: `user`, `tool`, `handler`, `runner`. - */ - /** @description Maximum number of jobs to return. */ - /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ - /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ - /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ - /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ - query?: { - user_details?: boolean; - user_id?: string | null; - view?: components["schemas"]["JobIndexViewEnum"]; - date_range_min?: string | string | null; - date_range_max?: string | string | null; - history_id?: string | null; - workflow_id?: string | null; - invocation_id?: string | null; - implicit_collection_jobs_id?: string | null; - order_by?: components["schemas"]["JobIndexSortByEnum"]; - search?: string | null; - /** @description Maximum number of jobs to return. */ - limit?: number; - /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ - offset?: number; - /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ - state?: string[] | null; - /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ - tool_id?: string[] | null; - /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ - tool_id_like?: string[] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["ShowFullJobResponse"] - | components["schemas"]["EncodedJobDetails"] - | components["schemas"]["JobSummary"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - search_jobs_api_jobs_search_post: { - /** - * Return jobs for current user - * @description This method is designed to scan the list of previously run jobs and find records of jobs that had - * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply - * recycle the old results. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["SearchJobsPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["EncodedJobDetails"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_job_api_jobs__job_id__get: { - /** Return dictionary containing description of job data. */ - parameters: { - query?: { - /** @description Show extra information. */ - full?: boolean | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["ShowFullJobResponse"] - | components["schemas"]["EncodedJobDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - cancel_job_api_jobs__job_id__delete: { - /** Cancels specified job */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteJobPayload"] | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": boolean; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - check_common_problems_api_jobs__job_id__common_problems_get: { - /** Check inputs and job for common potential problems to aid in error reporting */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["JobInputSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - destination_params_job_api_jobs__job_id__destination_params_get: { - /** Return destination parameters for specified job. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["JobDestinationParams"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - report_error_api_jobs__job_id__error_post: { - /** Submits a bug report via the API. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ReportJobErrorPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["JobErrorSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_inputs_api_jobs__job_id__inputs_get: { - /** Returns input datasets created by a job. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["JobInputAssociation"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_metrics_api_jobs__job_id__metrics_get: { - /** Return job metrics for specified job. */ - parameters: { - query?: { - /** - * @deprecated - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - */ - hda_ldda?: components["schemas"]["DatasetSourceType"] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": (components["schemas"]["JobMetric"] | null)[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_token_api_jobs__job_id__oidc_tokens_get: { - /** - * Get a fresh OIDC token - * @description Allows remote job running mechanisms to get a fresh OIDC token that can be used on remote side to authorize user. It is not meant to represent part of Galaxy's stable, user facing API - */ - parameters: { - query: { - /** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job */ - job_key: string; - /** @description OIDC provider name */ - provider: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - job_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "text/plain": string; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_outputs_api_jobs__job_id__outputs_get: { - /** Returns output datasets created by a job. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["JobOutputAssociation"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - resolve_parameters_display_api_jobs__job_id__parameters_display_get: { - /** - * Resolve parameters as a list for nested display. - * @description Resolve parameters as a list for nested display. - * This API endpoint is unstable and tied heavily to Galaxy's JS client code, - * this endpoint will change frequently. - */ - parameters: { - query?: { - /** - * @deprecated - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - */ - hda_ldda?: components["schemas"]["DatasetSourceType"] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["JobDisplayParametersSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - resume_paused_job_api_jobs__job_id__resume_put: { - /** Resumes a paused job. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["JobOutputAssociation"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_libraries_get: { - /** - * Returns a list of summary data for all libraries. - * @description Returns a list of summary data for all libraries. - */ - parameters?: { - /** @description Whether to include deleted libraries in the result. */ - query?: { - /** @description Whether to include deleted libraries in the result. */ - deleted?: boolean | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibrarySummaryList"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_libraries_post: { - /** - * Creates a new library and returns its summary information. - * @description Creates a new library and returns its summary information. Currently, only admin users can create libraries. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibraryPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibrarySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_deleted_api_libraries_deleted_get: { - /** - * Returns a list of summary data for all libraries marked as deleted. - * @description Returns a list of summary data for all libraries marked as deleted. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibrarySummaryList"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_from_store_api_libraries_from_store_post: { - /** Create libraries from a model store. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibrariesFromStore"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibrarySummary"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_api_libraries__id__get: { - /** - * Returns summary information about a particular library. - * @description Returns summary information about a particular library. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Library. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibrarySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_libraries__id__delete: { - /** - * Marks the specified library as deleted (or undeleted). - * @description Marks the specified library as deleted (or undeleted). - * Currently, only admin users can delete or restore libraries. - */ - parameters: { - query?: { - /** @description Whether to restore a deleted library. */ - undelete?: boolean | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Library. */ - id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteLibraryPayload"] | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibrarySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_libraries__id__patch: { - /** - * Updates the information of an existing library. - * @description Updates the information of an existing library. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Library. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["LibrarySummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_permissions_api_libraries__id__permissions_get: { - /** - * Gets the current or available permissions of a particular library. - * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. - */ - parameters: { - query?: { - /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ - scope?: components["schemas"]["LibraryPermissionScope"] | null; - /** @description Indicates whether the roles available for the library access are requested. */ - is_library_access?: boolean | null; - /** @description The page number to retrieve when paginating the available roles. */ - page?: number; - /** @description The maximum number of permissions per page when paginating. */ - page_limit?: number; - /** @description Optional search text to retrieve only the roles matching this query. */ - q?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Library. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["LibraryCurrentPermissions"] - | components["schemas"]["LibraryAvailablePermissions"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - set_permissions_api_libraries__id__permissions_post: { - /** - * Sets the permissions to access and manipulate a library. - * @description Sets the permissions to access and manipulate a library. - */ - parameters: { - query?: { - /** @description Indicates what action should be performed on the Library. */ - action?: components["schemas"]["LibraryPermissionAction"] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Library. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": - | components["schemas"]["LibraryPermissionsPayload"] - | components["schemas"]["LegacyLibraryPermissionsPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["LibraryLegacySummary"] - | components["schemas"]["LibraryCurrentPermissions"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_licenses_get: { - /** - * Lists all available SPDX licenses - * @description Returns an index with all the available [SPDX licenses](https://spdx.org/licenses/). - */ - responses: { - /** @description List of SPDX licenses */ - 200: { - content: { - "application/json": components["schemas"]["LicenseMetadataModel"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_api_licenses__id__get: { - /** - * Gets the SPDX license metadata associated with the short identifier - * @description Returns the license metadata associated with the given - * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). - */ - parameters: { - path: { - /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ - id: unknown; - }; - }; - responses: { - /** @description SPDX license metadata */ - 200: { - content: { - "application/json": components["schemas"]["LicenseMetadataModel"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_metrics_post: { - /** - * Records a collection of metrics. - * @description Record any metrics sent and return some status object. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateMetricsPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_user_notifications_api_notifications_get: { - /** - * Returns the list of notifications associated with the user. - * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. - * - * You can use the `limit` and `offset` parameters to paginate through the notifications. - */ - parameters?: { - query?: { - limit?: number | null; - offset?: number | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserNotificationListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_user_notifications_api_notifications_put: { - /** Updates a list of notifications with the requested values in a single request. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UserNotificationsBatchUpdateRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - send_notification_api_notifications_post: { - /** - * Sends a notification to a list of recipients (users, groups or roles). - * @description Sends a notification to a list of recipients (users, groups or roles). - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["NotificationCreateRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["NotificationCreatedResponse"] - | components["schemas"]["AsyncTaskResultSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_user_notifications_api_notifications_delete: { - /** Deletes a list of notifications received by the user in a single request. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["NotificationsBatchRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_all_broadcasted_api_notifications_broadcast_get: { - /** - * Returns all currently active broadcasted notifications. - * @description Only Admin users can access inactive notifications (scheduled or recently expired). - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["BroadcastNotificationListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - broadcast_notification_api_notifications_broadcast_post: { - /** - * Broadcasts a notification to every user in the system. - * @description Broadcasted notifications are a special kind of notification that are always accessible to all users, including anonymous users. - * They are typically used to display important information such as maintenance windows or new features. - * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. - * - * Broadcasted notifications can include action links that are displayed as buttons. - * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. - * - * Some key features of broadcasted notifications include: - * - They are not associated with a specific user, so they cannot be deleted or marked as read. - * - They can be scheduled to be displayed in the future or to expire after a certain time. - * - By default, broadcasted notifications are published immediately and expire six months after publication. - * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["BroadcastNotificationCreateRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["NotificationCreatedResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_broadcasted_api_notifications_broadcast__notification_id__get: { - /** - * Returns the information of a specific broadcasted notification. - * @description Only Admin users can access inactive notifications (scheduled or recently expired). - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["BroadcastNotificationResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_broadcasted_notification_api_notifications_broadcast__notification_id__put: { - /** - * Updates the state of a broadcasted notification. - * @description Only Admins can update broadcasted notifications. This is useful to reschedule, edit or expire broadcasted notifications. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["NotificationBroadcastUpdateRequest"]; - }; - }; - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_notification_preferences_api_notifications_preferences_get: { - /** - * Returns the current user's preferences for notifications. - * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. - * - * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. - * The supported channels are returned in the `supported-channels` header. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserNotificationPreferences"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_notification_preferences_api_notifications_preferences_put: { - /** - * Updates the user's preferences for notifications. - * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. - * - * - Can be used to completely enable/disable notifications for a particular type (category) - * or to enable/disable a particular channel on each category. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateUserNotificationPreferencesRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserNotificationPreferences"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - get_notifications_status_api_notifications_status_get: { - /** - * Returns the current status summary of the user's notifications since a particular date. - * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. - */ - parameters: { - query: { - since: string; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["NotificationStatusSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_notification_api_notifications__notification_id__get: { - /** Displays information about a notification received by the user. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserNotificationResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_user_notification_api_notifications__notification_id__put: { - /** Updates the state of a notification received by the user. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UserNotificationUpdateRequest"]; - }; - }; - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_user_notification_api_notifications__notification_id__delete: { - /** - * Deletes a notification received by the user. - * @description When a notification is deleted, it is not immediately removed from the database, but marked as deleted. - * - * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. - * - It will be eventually removed from the database by a background task after the expiration time. - * - Deleted notifications will be permanently deleted when the expiration time is reached. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; - }; - }; - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - object_stores__instances_index: { - /** Get a list of persisted object store instances defined by the requesting user. */ - parameters?: { - /** @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; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - object_stores__create_instance: { - /** Create a user-bound object store. */ - parameters?: { - /** @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; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInstancePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - object_stores__test_new_instance_configuration: { - /** Test payload for creating user-bound object store. */ - parameters?: { - /** @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; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInstancePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["PluginStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - object_stores__instances_get: { - /** Get a persisted user object store instance. */ - parameters: { - /** @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 UUID used to identify a persisted UserObjectStore object. */ - path: { - user_object_store_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - object_stores__instances_update: { - /** Update or upgrade user object store instance. */ - parameters: { - /** @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 UUID used to identify a persisted UserObjectStore object. */ - path: { - user_object_store_id: string; - }; - }; - requestBody: { - content: { - "application/json": - | components["schemas"]["UpdateInstanceSecretPayload"] - | components["schemas"]["UpgradeInstancePayload"] - | components["schemas"]["UpdateInstancePayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - object_stores__instances_purge: { - /** Purge user object store instance. */ - parameters: { - /** @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 UUID used to identify a persisted UserObjectStore object. */ - path: { - user_object_store_id: string; - }; - }; - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - object_stores__templates_index: { - /** Get a list of object store templates available to build user defined object stores from */ - parameters?: { - /** @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; - }; - }; - responses: { - /** @description A list of the configured object store templates. */ - 200: { - content: { - "application/json": components["schemas"]["ObjectStoreTemplateSummaries"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_object_stores_get: { - /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ - parameters?: { - /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ - query?: { - /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ - selectable?: boolean; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description A list of the configured object stores. */ - 200: { - content: { - "application/json": ( - | components["schemas"]["ConcreteObjectStoreModel"] - | components["schemas"]["UserConcreteObjectStoreModel"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_info_api_object_stores__object_store_id__get: { - /** Get information about a concrete object store configured with Galaxy. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The concrete object store ID. */ - object_store_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ConcreteObjectStoreModel"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_pages_get: { - /** - * Lists all Pages viewable by the user. - * @description Get a list with summary information of all Pages available to the user. - */ - parameters?: { - /** @description Whether to include deleted pages in the result. */ - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `title` - * : The page's title. - * - * `slug` - * : The page's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The page's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `user` - * : The page's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Pages: `title`, `slug`, `tag`, `user`. - */ - /** @description Sort page index by this specified attribute on the page model */ - /** @description Sort in descending order? */ - query?: { - deleted?: boolean; - limit?: number; - offset?: number; - search?: string | null; - show_own?: boolean; - show_published?: boolean; - show_shared?: boolean; - /** @description Sort page index by this specified attribute on the page model */ - sort_by?: "create_time" | "title" | "update_time" | "username"; - /** @description Sort in descending order? */ - sort_desc?: boolean; - user_id?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description A list with summary page information. */ - 200: { - content: { - "application/json": components["schemas"]["PageSummaryList"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_pages_post: { - /** - * Create a page and return summary information. - * @description Get a list with details of all Pages available to the user. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreatePagePayload"]; - }; - }; - responses: { - /** @description The page summary information. */ - 200: { - content: { - "application/json": components["schemas"]["PageSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_api_pages__id__get: { - /** - * Return a page summary and the content of the last revision. - * @description Return summary information about a specific Page and the content of the last revision. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - responses: { - /** @description The page summary information. */ - 200: { - content: { - "application/json": components["schemas"]["PageDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_pages__id__delete: { - /** - * Marks the specific Page as deleted. - * @description Marks the Page with the given ID as deleted. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_pdf_api_pages__id__pdf_get: { - /** - * Return a PDF document of the last revision of the Page. - * @description Return a PDF document of the last revision of the Page. - * - * This feature may not be available in this Galaxy. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - responses: { - /** @description PDF document with the last revision of the page. */ - 200: { - content: { - "application/pdf": unknown; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description PDF conversion service not available. */ - 501: { - content: never; - }; - }; - }; - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ - disable_link_access_api_pages__id__disable_link_access_put: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - enable_link_access_api_pages__id__enable_link_access_put: { - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - prepare_pdf_api_pages__id__prepare_download_post: { - /** - * Return a PDF document of the last revision of the Page. - * @description Return a STS download link for this page to be downloaded as a PDF. - * - * This feature may not be available in this Galaxy. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - responses: { - /** @description Short term storage reference for async monitoring of this download. */ - 200: { - content: { - "application/json": components["schemas"]["AsyncFile"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description PDF conversion service not available. */ - 501: { - content: never; - }; - }; - }; - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ - publish_api_pages__id__publish_put: { - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - share_with_users_api_pages__id__share_with_users_put: { - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ShareWithPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ShareWithStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - sharing_api_pages__id__sharing_get: { - /** - * Get the current sharing status of the given Page. - * @description Return the sharing status of the item. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - set_slug_api_pages__id__slug_put: { - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["SetSlugPayload"]; - }; - }; - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - undelete_api_pages__id__undelete_put: { - /** - * Undelete the specific Page. - * @description Marks the Page with the given ID as undeleted. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - unpublish_api_pages__id__unpublish_put: { - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_quotas_get: { - /** - * Displays a list with information of quotas that are currently active. - * @description Displays a list with information of quotas that are currently active. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["QuotaSummaryList"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_quotas_post: { - /** - * Creates a new quota. - * @description Creates a new quota. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateQuotaParams"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["CreateQuotaResult"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_deleted_api_quotas_deleted_get: { - /** - * Displays a list with information of quotas that have been deleted. - * @description Displays a list with information of quotas that have been deleted. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["QuotaSummaryList"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - deleted_quota_api_quotas_deleted__id__get: { - /** - * Displays details on a particular quota that has been deleted. - * @description Displays details on a particular quota that has been deleted. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Quota. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["QuotaDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - undelete_api_quotas_deleted__id__undelete_post: { - /** - * Restores a previously deleted quota. - * @description Restores a previously deleted quota. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Quota. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": string; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - quota_api_quotas__id__get: { - /** - * Displays details on a particular active quota. - * @description Displays details on a particular active quota. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Quota. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["QuotaDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_quotas__id__put: { - /** - * Updates an existing quota. - * @description Updates an existing quota. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Quota. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateQuotaParams"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": string; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_quotas__id__delete: { - /** - * Deletes an existing quota. - * @description Deletes an existing quota. - */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Quota. */ - id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteQuotaPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": string; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - purge_api_quotas__id__purge_post: { - /** Purges a previously deleted quota. */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the Quota. */ - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": string; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_remote_files_get: { - /** - * Displays remote files available to the user. - * @description Lists all remote files available to the user from different sources. - * - * The total count of files and directories is returned in the 'total_matches' header. - */ - parameters?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - /** @description Maximum number of entries to return. */ - /** @description Number of entries to skip. */ - /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ - /** @description Sort the entries by the specified field. */ - query?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - target?: string; - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - format?: components["schemas"]["RemoteFilesFormat"] | null; - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - recursive?: boolean | null; - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - disable?: components["schemas"]["RemoteFilesDisableMode"] | null; - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - writeable?: boolean | null; - limit?: number | null; - offset?: number | null; - query?: string | null; - sort_by?: string | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description A list with details about the remote files available to the user. */ - 200: { - content: { - "application/json": - | components["schemas"]["ListUriResponse"] - | components["schemas"]["ListJstreeResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_entry_api_remote_files_post: { - /** - * Creates a new entry (directory/record) on the remote files source. - * @description Creates a new entry on the remote files source. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateEntryPayload"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["CreatedEntryResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - plugins_api_remote_files_plugins_get: { - /** - * Display plugin information for each of the gxfiles:// URI targets available. - * @description Display plugin information for each of the gxfiles:// URI targets available. - */ - parameters?: { - /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ - /** @description Whether to return **only** filesources of the specified kind. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ - /** @description Whether to exclude filesources of the specified kind from the list. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ - query?: { - /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ - browsable_only?: boolean | null; - /** @description Whether to return **only** filesources of the specified kind. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ - include_kind?: components["schemas"]["PluginKind"][] | null; - /** @description Whether to exclude filesources of the specified kind from the list. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ - exclude_kind?: components["schemas"]["PluginKind"][] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description A list with details about each plugin. */ - 200: { - content: { - "application/json": components["schemas"]["FilesSourcePluginList"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_roles_get: { - /** Index */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["RoleListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - create_api_roles_post: { - /** Create */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["RoleDefinitionModel"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["RoleModelResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - show_api_roles__id__get: { - /** Show */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["RoleModelResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - delete_api_roles__id__delete: { - /** Delete */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["RoleModelResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - purge_api_roles__id__purge_post: { - /** Purge */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["RoleModelResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - undelete_api_roles__id__undelete_post: { - /** Undelete */ - parameters: { - header?: { - /** @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. */ - "run-as"?: string | null; - }; - path: { - id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["RoleModelResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - serve_api_short_term_storage__storage_request_id__get: { - /** Serve the staged download specified by request ID. */ - parameters: { - path: { - storage_request_id: string; - }; - }; - responses: { - /** @description The archive file containing the History. */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Request was cancelled without an exception condition recorded. */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - is_ready_api_short_term_storage__storage_request_id__ready_get: { - /** Determine if specified storage request ID is ready for download. */ - parameters: { - path: { - storage_request_id: string; - }; - }; - responses: { - /** @description Boolean indicating if the storage is ready. */ - 200: { - content: { - "application/json": boolean; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - cleanup_datasets_api_storage_datasets_delete: { - /** - * Purges a set of datasets by ID from disk. The datasets must be owned by the user. - * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CleanupStorageItemsRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["StorageItemsCleanupResult"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - discarded_datasets_api_storage_datasets_discarded_get: { - /** Returns discarded datasets owned by the given user. The results can be paginated. */ - parameters?: { - /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ - query?: { - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ - order?: components["schemas"]["StoredItemOrderBy"] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["StoredItem"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - discarded_datasets_summary_api_storage_datasets_discarded_summary_get: { - /** Returns information with the total storage space taken by discarded datasets owned by the given user. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["CleanableItemsSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - cleanup_histories_api_storage_histories_delete: { - /** - * Purges a set of histories by ID. The histories must be owned by the user. - * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CleanupStorageItemsRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["StorageItemsCleanupResult"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - archived_histories_api_storage_histories_archived_get: { - /** Returns archived histories owned by the given user that are not purged. The results can be paginated. */ - parameters?: { - /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ - query?: { - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ - order?: components["schemas"]["StoredItemOrderBy"] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["StoredItem"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - archived_histories_summary_api_storage_histories_archived_summary_get: { - /** Returns information with the total storage space taken by non-purged archived histories associated with the given user. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["CleanableItemsSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - discarded_histories_api_storage_histories_discarded_get: { - /** Returns all discarded histories associated with the given user. */ - parameters?: { - /** @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 by '-asc' or '-dsc' for ascending and descending order respectively. */ - query?: { - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ - order?: components["schemas"]["StoredItemOrderBy"] | null; - }; - header?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["StoredItem"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - discarded_histories_summary_api_storage_histories_discarded_summary_get: { - /** Returns information with the total storage space taken by discarded histories associated with the given user. */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["CleanableItemsSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - update_api_tags_put: { - /** - * Apply a new set of tags to an item. - * @description Replaces the tags associated with an item with the new ones specified in the payload. - * - * - The previous tags will be __deleted__. - * - If no tags are provided in the request body, the currently associated tags will also be __deleted__. - */ - parameters?: { - /** @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?: { - /** @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. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsPayload"]; - }; - }; - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - state_api_tasks__task_id__state_get: { - /** Determine state of task ID */ - parameters: { - path: { - task_id: string; - }; - }; - responses: { - /** @description String indicating task state. */ - 200: { - content: { - "application/json": components["schemas"]["TaskState"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - }; - }; - index_api_tool_data_get: { - /** - * Lists all available data tables - * @description Get the list of all available data tables. - */ - responses: { - /** @description A list with details on individual data tables. */ - 200: { - content: { - "application/json": components["schemas"]["ToolDataEntryList"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["HistoryContentsResult"] + | components["schemas"]["HistoryContentsWithStatsResult"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_api_tool_data_post: { - /** Import a data manager bundle */ - parameters?: { + /** + * Create a new `HDA` or `HDCA` in the given History. + * @description Create a new `HDA` or `HDCA` in the given History. + */ + history_contents__create_typed: { + parameters: { query?: { - tool_data_file_path?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; }; requestBody: { content: { - "application/json": components["schemas"]["ImportToolDataBundle"]; + "application/json": components["schemas"]["CreateHistoryContentPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + | ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_api_tool_data__table_name__get: { - /** - * Get details of a given data table - * @description Get details of a given tool data table. - */ + /** + * Return detailed information about a specific HDA or HDCA with the given `ID` within a history. + * @description Return detailed information about an `HDA` or `HDCA` within a history. + * + * **Note**: Anonymous users are allowed to get their current history contents. + */ + history_contents__show: { parameters: { + query?: { + /** @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. */ + fuzzy_count?: number | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The name of the tool data table */ - table_name: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; }; responses: { - /** @description A description of the given data table and its content */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ToolDataDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - delete_api_tool_data__table_name__delete: { - /** - * Removes an item from a data table - * @description Removes an item from a data table and reloads it to return its updated details. - */ + /** + * Updates the values for the history content item with the given ``ID`` and path specified type. + * @description Updates the values for the history content item with the given ``ID``. + */ + history_contents__update_typed: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The name of the tool data table */ - table_name: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; }; requestBody: { content: { - "application/json": components["schemas"]["ToolDataItem"]; + "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; }; }; responses: { - /** @description A description of the affected data table and its content */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ToolDataDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_field_api_tool_data__table_name__fields__field_name__get: { - /** - * Get information about a particular field in a tool data table - * @description Reloads a data table and return its details. - */ + /** + * Delete the history content with the given ``ID`` and path specified type. + * @description Delete the history content with the given ``ID`` and path specified type. + * + * **Note**: Currently does not stop any active jobs for which this dataset is an output. + */ + history_contents__delete_typed: { parameters: { + query?: { + /** + * @deprecated + * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. + */ + purge?: boolean | null; + /** + * @deprecated + * @description When deleting a dataset collection, whether to also delete containing datasets. + */ + recursive?: boolean | null; + /** + * @deprecated + * @description Whether to stop the creating job if all outputs of the job have been deleted. + */ + stop_job?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The name of the tool data table */ - table_name: string; - /** @description The name of the tool data table field */ - field_name: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentPayload"]; }; }; responses: { - /** @description Information about a data table field */ + /** @description Request has been executed. */ 200: { content: { - "application/json": components["schemas"]["ToolDataField"]; + "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + /** @description Request accepted, processing will finish later. */ 202: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Return detailed information about an `HDA` or `HDCAs` jobs. + * @description Return detailed information about an `HDA` or `HDCAs` jobs. + * + * **Warning**: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ + show_jobs_summary_api_histories__history_id__contents__type_s__id__jobs_summary_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["JobStateSummary"] + | components["schemas"]["ImplicitCollectionJobsStateSummary"] + | components["schemas"]["WorkflowInvocationStateSummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - download_field_file_api_tool_data__table_name__fields__field_name__files__file_name__get: { - /** - * Get information about a particular field in a tool data table - * @description Download a file associated with the data table field. - */ + /** Prepare a dataset or dataset collection for export-style download. */ + prepare_store_download_api_histories__history_id__contents__type_s__id__prepare_store_download_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The name of the tool data table */ - table_name: string; - /** @description The name of the tool data table field */ - field_name: string; - /** @description The name of a file associated with this data table field */ - file_name: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; }; - responses: { - /** @description Information about a data table field */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + requestBody: { + content: { + "application/json": components["schemas"]["StoreExportPayload"]; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Prepare a dataset or dataset collection for export-style download and write to supplied URI. */ + write_store_api_histories__history_id__contents__type_s__id__write_store_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["WriteStoreToPayload"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - reload_api_tool_data__table_name__reload_get: { - /** - * Reloads a tool data table - * @description Reloads a data table and return its details. - */ + /** + * Create contents from store. + * @description Create history contents from model store. + * Input can be a tarfile created with build_objects script distributed + * with galaxy-data, from an exported history with files stripped out, + * or hand-crafted JSON dictionary. + */ + create_from_store_api_histories__history_id__contents_from_store_post: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The name of the tool data table */ - table_name: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryContentFromStore"]; }; }; responses: { - /** @description A description of the reloaded data table and its content */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ToolDataDetails"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Returns meta data for custom builds. */ + get_custom_builds_metadata_api_histories__history_id__custom_builds_metadata_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["CustomBuildsMetadataResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_tool_shed_repositories_get: { - /** Lists installed tool shed repositories. */ - parameters?: { - /** @description Filter by repository name. */ - /** @description Filter by repository owner. */ - /** @description Filter by changeset revision. */ - /** @description Filter by whether the repository has been deleted. */ - /** @description Filter by whether the repository has been uninstalled. */ - query?: { - /** @description Filter by repository name. */ - name?: string | null; - /** @description Filter by repository owner. */ - owner?: string | null; - /** @description Filter by changeset revision. */ - changeset?: string | null; - /** @description Filter by whether the repository has been deleted. */ - deleted?: boolean | null; - /** @description Filter by whether the repository has been uninstalled. */ - uninstalled?: boolean | null; + /** + * Makes this item inaccessible by a URL link. + * @description Makes this item inaccessible by a URL link and return the current sharing status. + */ + disable_link_access_api_histories__history_id__disable_link_access_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; }; responses: { - /** @description A list of installed tool shed repository objects. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InstalledToolShedRepository"][]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. + */ + enable_link_access_api_histories__history_id__enable_link_access_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Get previous history exports. + * @description By default the legacy job-based history exports (jeha) are returned. + * + * Change the `accept` content type header to return the new task-based history exports. + */ + get_history_exports_api_histories__history_id__exports_get: { + parameters: { + query?: { + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description A list of history exports */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["JobExportHistoryArchiveListResponse"]; + "application/vnd.galaxy.task.export+json": components["schemas"]["ExportTaskListResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - check_for_updates_api_tool_shed_repositories_check_for_updates_get: { - /** Check for updates to the specified repository, or all installed repositories. */ - parameters?: { - query?: { - id?: string | null; - }; + /** + * Start job (if needed) to create history export for corresponding history. + * @deprecated + * @description This will start a job to create a history export archive. + * + * Calling this endpoint multiple times will return the 202 status code until the archive + * has been completely generated and is ready to download. When ready, it will return + * the 200 status code along with the download link information. + * + * If the history will be exported to a `directory_uri`, instead of returning the download + * link information, the Job ID will be returned so it can be queried to determine when + * the file has been written. + * + * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or + * `/api/histories/{id}/write_store` instead. + */ + archive_export_api_histories__history_id__exports_put: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ExportHistoryArchivePayload"] | null; + }; }; responses: { - /** @description A description of the state and updates message. */ + /** @description Object containing url to fetch export from. */ 200: { content: { - "application/json": components["schemas"]["CheckForUpdatesResponse"]; + "application/json": + | components["schemas"]["JobExportHistoryArchiveModel"] + | components["schemas"]["JobIdResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ + /** @description The exported archive file is not ready yet. */ 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + content: never; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * If ready and available, return raw contents of exported history as a downloadable archive. + * @deprecated + * @description See ``PUT /api/histories/{id}/exports`` to initiate the creation + * of the history export - when ready, that route will return 200 status + * code (instead of 202) and this route can be used to download the archive. + * + * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or + * `/api/histories/{id}/write_store` instead. + */ + history_archive_download_api_histories__history_id__exports__jeha_id__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the specific Job Export History Association or `latest` (default) to download the last generated archive. */ + jeha_id: string | "latest"; + }; + }; + responses: { + /** @description The archive file containing the History. */ + 200: { + content: never; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. + * @description Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. + * + * **Warning**: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ + index_jobs_summary_api_histories__history_id__jobs_summary_get: { + parameters: { + query?: { + /** @description A comma-separated list of encoded ids of job summary objects to return - if `ids` is specified types must also be specified and have same length. */ + ids?: string | null; + /** @description A comma-separated list of type of object represented by elements in the `ids` array - any of `Job`, `ImplicitCollectionJob`, or `WorkflowInvocation`. */ + types?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["JobStateSummary"] + | components["schemas"]["ImplicitCollectionJobsStateSummary"] + | components["schemas"]["WorkflowInvocationStateSummary"] + )[]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_api_tool_shed_repositories__id__get: { - /** Show installed tool shed repository. */ + /** Materialize a deferred library or HDA dataset into real, usable dataset in specified history. */ + materialize_to_history_api_histories__history_id__materialize_post: { parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; path: { - /** @description The encoded database identifier of the installed Tool Shed Repository. */ - id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["MaterializeDatasetInstanceAPIRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InstalledToolShedRepository"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Return a short term storage token to monitor download of the history. */ + prepare_store_download_api_histories__history_id__prepare_store_download_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["StoreExportPayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. + */ + publish_api_histories__history_id__publish_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - fetch_form_api_tools_fetch_post: { - /** Upload files to Galaxy */ - parameters?: { - /** @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. */ + /** + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. + */ + share_with_users_api_histories__history_id__share_with_users_put: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; }; requestBody: { content: { - "multipart/form-data": components["schemas"]["Body_fetch_form_api_tools_fetch_post"]; + "application/json": components["schemas"]["ShareWithPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["ShareHistoryWithStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Get the current sharing status of the given item. + * @description Return the sharing status of the item. + */ + sharing_api_histories__history_id__sharing_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. + */ + set_slug_api_histories__history_id__slug_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetSlugPayload"]; }; }; - }; - index_api_tours_get: { - /** - * Index - * @description Return list of available tours. - */ responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["TourList"]; - }; + 204: { + content: never; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + }; + }; + /** Show tags based on history_id */ + index_api_histories__history_id__tags_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Show tag based on history_id */ + show_api_histories__history_id__tags__tag_name__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + history_id: string; + tag_name: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_api_tours__tour_id__get: { - /** - * Show - * @description Return a tour definition. - */ + /** Update tag based on history_id */ + update_api_histories__history_id__tags__tag_name__put: { parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; path: { - tour_id: string; + history_id: string; + tag_name: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["TourDetails"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Create tag based on history_id */ + create_api_histories__history_id__tags__tag_name__post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + history_id: string; + tag_name: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Delete tag based on history_id */ + delete_api_histories__history_id__tags__tag_name__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + history_id: string; + tag_name: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": boolean; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_tour_api_tours__tour_id__post: { - /** - * Update Tour - * @description Return a tour definition. - */ + /** + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. + */ + unpublish_api_histories__history_id__unpublish_put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - tour_id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["TourDetails"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Prepare history for export-style download and write to supplied URI. */ + write_store_api_histories__history_id__write_store_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["WriteStoreToPayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Get the list of a user's workflow invocations. */ + index_invocations_api_invocations_get: { + parameters: { + query?: { + /** @description Return only invocations for this Workflow ID */ + workflow_id?: string | null; + /** @description Return only invocations for this History ID */ + history_id?: string | null; + /** @description Return only invocations for this Job ID */ + job_id?: string | null; + /** @description Return invocations for this User ID. */ + user_id?: string | null; + /** @description Sort Workflow Invocations by this attribute */ + sort_by?: components["schemas"]["InvocationSortByEnum"] | null; + /** @description Sort in descending order? */ + sort_desc?: boolean; + /** @description Set to false to only include terminal Invocations. */ + include_terminal?: boolean | null; + /** @description Limit the number of invocations to return. */ + limit?: number | null; + /** @description Number of invocations to skip. */ + offset?: number | null; + /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ + instance?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + include_nested_invocations?: boolean; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_users_api_users_get: { - /** - * Get Users - * @description Return a collection of users. Filters will only work if enabled in config or user is admin. - */ - parameters?: { - /** @description Indicates if the collection will be about deleted users */ - /** @description An email address to filter on */ - /** @description An username address to filter on */ - /** @description Filter on username OR email */ - query?: { - /** @description Indicates if the collection will be about deleted users */ - deleted?: boolean; - /** @description An email address to filter on */ - f_email?: string | null; - /** @description An username address to filter on */ - f_name?: string | null; - /** @description Filter on username OR email */ - f_any?: string | null; - }; + /** + * Create Invocations From Store + * @description Create invocation(s) from a supplied model store. + */ + create_invocations_from_store_api_invocations_from_store_post: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInvocationsFromStorePayload"]; + }; + }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["UserModel"] - | components["schemas"]["LimitedUserModel"] - )[]; + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Show details of workflow invocation step. */ + step_api_invocations_steps__step_id__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Get detailed description of a workflow invocation. */ + show_invocation_api_invocations__invocation_id__get: { + parameters: { + query?: { + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + /** + * @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. + */ + legacy_job_state?: boolean; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_user_api_users_post: { - /** Create a new Galaxy user. Only admins can create users for now. */ - parameters?: { - /** @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. */ + /** Cancel the specified workflow invocation. */ + cancel_invocation_api_invocations__invocation_id__delete: { + parameters: { + query?: { + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + /** + * @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. + */ + legacy_job_state?: boolean; + }; header?: { /** @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. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": - | components["schemas"]["UserCreationPayload"] - | components["schemas"]["RemoteUserCreationPayload"]; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["CreatedUserModel"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Get job state summary info aggregated across all current jobs of the workflow invocation. + * @description Warning: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ + invocation_jobs_summary_api_invocations__invocation_id__jobs_summary_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - recalculate_disk_usage_api_users_current_recalculate_disk_usage_put: { - /** - * Triggers a recalculation of the current user disk usage. - * @description This route will be removed in a future version. - * - * Please use `/api/users/current/recalculate_disk_usage` instead. - */ - parameters?: { - /** @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. */ + /** Prepare a workflow invocation export-style download. */ + prepare_store_download_api_invocations__invocation_id__prepare_store_download_post: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["PrepareStoreDownloadPayload"]; + }; }; responses: { - /** @description The asynchronous task summary to track the task state. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description The background task was submitted but there is no status tracking ID available. */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Get JSON summarizing invocation for reporting. */ + show_invocation_report_api_invocations__invocation_id__report_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["InvocationReport"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Get PDF summarizing invocation for reporting. */ + show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: never; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_deleted_users_api_users_deleted_get: { - /** - * Get Deleted Users - * @description Return a collection of deleted users. Only admins can see deleted users. - */ - parameters?: { - /** @description An email address to filter on */ - /** @description An username address to filter on */ - /** @description Filter on username OR email */ - query?: { - /** @description An email address to filter on */ - f_email?: string | null; - /** @description An username address to filter on */ - f_name?: string | null; - /** @description Filter on username OR email */ - f_any?: string | null; - }; + /** + * Get job state summary info aggregated per step of the workflow invocation. + * @description Warning: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. + */ + invocation_step_jobs_summary_api_invocations__invocation_id__step_jobs_summary_get: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; }; responses: { /** @description Successful Response */ 200: { content: { "application/json": ( - | components["schemas"]["UserModel"] - | components["schemas"]["LimitedUserModel"] + | components["schemas"]["InvocationStepJobsResponseStepModel"] + | components["schemas"]["InvocationStepJobsResponseJobModel"] + | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"] )[]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Show details of workflow invocation step. + * @description An alias for `GET /api/invocations/steps/{step_id}`. `invocation_id` is ignored. + */ + invocation_step_api_invocations__invocation_id__steps__step_id__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_deleted_user_api_users_deleted__user_id__get: { - /** Return information about a deleted user. Only admins can see deleted users. */ + /** Update state of running workflow step invocation - still very nebulous but this would be for stuff like confirming paused steps can proceed etc. */ + update_invocation_step_api_invocations__invocation_id__steps__step_id__put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["InvocationUpdatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["DetailedUserModel"] - | components["schemas"]["AnonUserModel"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Prepare a workflow invocation export-style download and write to supplied URI. */ + write_store_api_invocations__invocation_id__write_store_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["WriteInvocationStoreToPayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Job Lock Status + * @description Get job lock status. + */ + job_lock_status_api_job_lock_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["JobLock"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - undelete_user_api_users_deleted__user_id__undelete_post: { - /** Restore a deleted user. Only admins can restore users. */ + /** + * Update Job Lock + * @description Set job lock status. + */ + update_job_lock_api_job_lock_put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the user. */ - user_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["JobLock"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DetailedUserModel"]; + "application/json": components["schemas"]["JobLock"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Index */ + index_api_jobs_get: { + parameters: { + query?: { + /** @description If true, and requester is an admin, will return external job id and user email. This is only available to admins. */ + user_details?: boolean; + /** @description an encoded user id to restrict query to, must be own id if not admin user */ + user_id?: string | null; + /** @description Determines columns to return. Defaults to 'collection'. */ + view?: components["schemas"]["JobIndexViewEnum"]; + /** @description Limit listing of jobs to those that are updated after specified date (e.g. '2014-01-01') */ + date_range_min?: string | null; + /** @description Limit listing of jobs to those that are updated before specified date (e.g. '2014-01-01') */ + date_range_max?: string | null; + /** @description Limit listing of jobs to those that match the history_id. If none, jobs from any history may be returned. */ + history_id?: string | null; + /** @description Limit listing of jobs to those that match the specified workflow ID. If none, jobs from any workflow (or from no workflows) may be returned. */ + workflow_id?: string | null; + /** @description Limit listing of jobs to those that match the specified workflow invocation ID. If none, jobs from any workflow invocation (or from no workflows) may be returned. */ + invocation_id?: string | null; + /** @description Limit listing of jobs to those that match the specified implicit collection job ID. If none, jobs from any implicit collection execution (or from no implicit collection execution) may be returned. */ + implicit_collection_jobs_id?: string | null; + /** @description Sort results by specified field. */ + order_by?: components["schemas"]["JobIndexSortByEnum"]; + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `user` + * : The user email of the user that executed the Job. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tool_id` + * : The tool ID corresponding to the job. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `runner` + * : The job runner name used to execute the job. (The tag `r` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. + * + * `handler` + * : The job handler name used to execute the job. (The tag `h` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Jobs: `user`, `tool`, `handler`, `runner`. + */ + search?: string | null; + /** @description Maximum number of jobs to return. */ + limit?: number; + /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ + offset?: number; + /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ + state?: string[] | null; + /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ + tool_id?: string[] | null; + /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ + tool_id_like?: string[] | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["ShowFullJobResponse"] + | components["schemas"]["EncodedJobDetails"] + | components["schemas"]["JobSummary"] + )[]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Return jobs for current user + * @description This method is designed to scan the list of previously run jobs and find records of jobs that had + * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply + * recycle the old results. + */ + search_jobs_api_jobs_search_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SearchJobsPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["EncodedJobDetails"][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - recalculate_disk_usage_api_users_recalculate_disk_usage_put: { - /** - * Triggers a recalculation of the current user disk usage. - * @deprecated - * @description This route will be removed in a future version. - * - * Please use `/api/users/current/recalculate_disk_usage` instead. - */ - parameters?: { - /** @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. */ + /** Return dictionary containing description of job data. */ + show_job_api_jobs__job_id__get: { + parameters: { + query?: { + /** @description Show extra information. */ + full?: boolean | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the job */ + job_id: string; + }; }; responses: { - /** @description The asynchronous task summary to track the task state. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": + | components["schemas"]["ShowFullJobResponse"] + | components["schemas"]["EncodedJobDetails"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description The background task was submitted but there is no status tracking ID available. */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Cancels specified job */ + cancel_job_api_jobs__job_id__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteJobPayload"] | null; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": boolean; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Check inputs and job for common potential problems to aid in error reporting */ + check_common_problems_api_jobs__job_id__common_problems_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["JobInputSummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_user_api_users__user_id__get: { - /** Return information about a specified or the current user. Only admin can see deleted or other users */ + /** Return destination parameters for specified job. */ + destination_params_job_api_jobs__job_id__destination_params_get: { parameters: { - query?: { - /** @description Indicates if the user is deleted */ - deleted?: boolean | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; + /** @description The ID of the job */ + job_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["DetailedUserModel"] - | components["schemas"]["AnonUserModel"]; + "application/json": components["schemas"]["JobDestinationParams"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Submits a bug report via the API. */ + report_error_api_jobs__job_id__error_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ReportJobErrorPayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["JobErrorSummary"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Returns input datasets created by a job. */ + get_inputs_api_jobs__job_id__inputs_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["JobInputAssociation"][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_user_api_users__user_id__put: { - /** Update the values of a user. Only admin can update others. */ + /** Return job metrics for specified job. */ + get_metrics_api_jobs__job_id__metrics_get: { parameters: { query?: { - /** @description Indicates if the user is deleted */ - deleted?: boolean | null; + /** + * @deprecated + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + */ + hda_ldda?: components["schemas"]["DatasetSourceType"] | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; - }; - }; - requestBody: { - content: { - "application/json": Record; + /** @description The ID of the job */ + job_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DetailedUserModel"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": (components["schemas"]["JobMetric"] | null)[]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + }; + }; + /** + * Get a fresh OIDC token + * @description Allows remote job running mechanisms to get a fresh OIDC token that can be used on remote side to authorize user. It is not meant to represent part of Galaxy's stable, user facing API + */ + get_token_api_jobs__job_id__oidc_tokens_get: { + parameters: { + query: { + /** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job */ + job_key: string; + /** @description OIDC provider name */ + provider: string; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": string; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Returns output datasets created by a job. */ + get_outputs_api_jobs__job_id__outputs_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["JobOutputAssociation"][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - delete_user_api_users__user_id__delete: { - /** Delete a user. Only admins can delete others or purge users. */ + /** + * Resolve parameters as a list for nested display. + * @description Resolve parameters as a list for nested display. + * This API endpoint is unstable and tied heavily to Galaxy's JS client code, + * this endpoint will change frequently. + */ + resolve_parameters_display_api_jobs__job_id__parameters_display_get: { parameters: { - /** @description Whether to definitely remove this user. Only deleted users can be purged. */ query?: { - purge?: boolean; + /** + * @deprecated + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + */ + hda_ldda?: components["schemas"]["DatasetSourceType"] | null; }; - /** @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?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["UserDeletionPayload"] | null; + /** @description The ID of the job */ + job_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DetailedUserModel"]; + "application/json": components["schemas"]["JobDisplayParametersSummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Resumes a paused job. */ + resume_paused_job_api_jobs__job_id__resume_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the job */ + job_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["JobOutputAssociation"][]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Returns a list of summary data for all libraries. + * @description Returns a list of summary data for all libraries. + */ + index_api_libraries_get: { + parameters: { + query?: { + /** @description Whether to include deleted libraries in the result. */ + deleted?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibrarySummaryList"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_or_create_api_key_api_users__user_id__api_key_get: { - /** Return the user's API key */ + /** + * Creates a new library and returns its summary information. + * @description Creates a new library and returns its summary information. Currently, only admin users can create libraries. + */ + create_api_libraries_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the user. */ - user_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": string; + "application/json": components["schemas"]["LibrarySummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Returns a list of summary data for all libraries marked as deleted. + * @description Returns a list of summary data for all libraries marked as deleted. + */ + index_deleted_api_libraries_deleted_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibrarySummaryList"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Create libraries from a model store. */ + create_from_store_api_libraries_from_store_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibrariesFromStore"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibrarySummary"][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_api_key_api_users__user_id__api_key_post: { - /** Create a new API key for the user */ + /** + * Returns summary information about a particular library. + * @description Returns summary information about a particular library. + */ + show_api_libraries__id__get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; + /** @description The ID of the Library. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": string; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibrarySummary"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Marks the specified library as deleted (or undeleted). + * @description Marks the specified library as deleted (or undeleted). + * Currently, only admin users can delete or restore libraries. + */ + delete_api_libraries__id__delete: { + parameters: { + query?: { + /** @description Whether to restore a deleted library. */ + undelete?: boolean | null; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the Library. */ + id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteLibraryPayload"] | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibrarySummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - delete_api_key_api_users__user_id__api_key_delete: { - /** Delete the current API key of the user */ + /** + * Updates the information of an existing library. + * @description Updates the information of an existing library. + */ + update_api_libraries__id__patch: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; + /** @description The ID of the Library. */ + id: string; }; }; - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateLibraryPayload"]; }; + }; + responses: { /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LibrarySummary"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Gets the current or available permissions of a particular library. + * @description Gets the current or available permissions of a particular library. + * The results can be paginated and additionally filtered by a query. + */ + get_permissions_api_libraries__id__permissions_get: { + parameters: { + query?: { + /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ + scope?: components["schemas"]["LibraryPermissionScope"] | null; + /** @description Indicates whether the roles available for the library access are requested. */ + is_library_access?: boolean | null; + /** @description The page number to retrieve when paginating the available roles. */ + page?: number; + /** @description The maximum number of permissions per page when paginating. */ + page_limit?: number; + /** @description Optional search text to retrieve only the roles matching this query. */ + q?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the Library. */ + id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["LibraryCurrentPermissions"] + | components["schemas"]["LibraryAvailablePermissions"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_api_key_detailed_api_users__user_id__api_key_detailed_get: { - /** Return the user's API key with extra information. */ + /** + * Sets the permissions to access and manipulate a library. + * @description Sets the permissions to access and manipulate a library. + */ + set_permissions_api_libraries__id__permissions_post: { parameters: { + query?: { + /** @description Indicates what action should be performed on the Library. */ + action?: components["schemas"]["LibraryPermissionAction"] | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; + /** @description The ID of the Library. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": + | components["schemas"]["LibraryPermissionsPayload"] + | components["schemas"]["LegacyLibraryPermissionsPayload"]; }; }; responses: { - /** @description The API key of the user. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["APIKeyModel"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["LibraryLegacySummary"] + | components["schemas"]["LibraryCurrentPermissions"]; }; }; - /** @description The user doesn't have an API key. */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + }; + }; + /** + * Lists all available SPDX licenses + * @description Returns an index with all the available [SPDX licenses](https://spdx.org/licenses/). + */ + index_api_licenses_get: { + responses: { + /** @description List of SPDX licenses */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LicenseMetadataModel"][]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Gets the SPDX license metadata associated with the short identifier + * @description Returns the license metadata associated with the given + * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). + */ + get_api_licenses__id__get: { + parameters: { + path: { + /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ + id: unknown; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description SPDX license metadata */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["LicenseMetadataModel"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_beacon_settings_api_users__user_id__beacon_get: { - /** - * Return information about beacon share settings - * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. - */ + /** + * Records a collection of metrics. + * @description Record any metrics sent and return some status object. + */ + create_api_metrics_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the user. */ - user_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateMetricsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserBeaconSetting"]; + "application/json": unknown; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Returns the list of notifications associated with the user. + * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. + * + * You can use the `limit` and `offset` parameters to paginate through the notifications. + */ + get_user_notifications_api_notifications_get: { + parameters: { + query?: { + limit?: number | null; + offset?: number | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserNotificationListResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Updates a list of notifications with the requested values in a single request. */ + update_user_notifications_api_notifications_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UserNotificationsBatchUpdateRequest"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - set_beacon_settings_api_users__user_id__beacon_post: { - /** - * Change beacon setting - * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. - */ + /** + * Sends a notification to a list of recipients (users, groups or roles). + * @description Sends a notification to a list of recipients (users, groups or roles). + */ + send_notification_api_notifications_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the user. */ - user_id: string; - }; }; requestBody: { content: { - "application/json": components["schemas"]["UserBeaconSetting"]; + "application/json": components["schemas"]["NotificationCreateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserBeaconSetting"]; + "application/json": + | components["schemas"]["NotificationCreatedResponse"] + | components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Deletes a list of notifications received by the user in a single request. */ + delete_user_notifications_api_notifications_delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationsBatchRequest"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Returns all currently active broadcasted notifications. + * @description Only Admin users can access inactive notifications (scheduled or recently expired). + */ + get_all_broadcasted_api_notifications_broadcast_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["BroadcastNotificationListResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_custom_builds_api_users__user_id__custom_builds_get: { - /** Returns collection of custom builds. */ + /** + * Broadcasts a notification to every user in the system. + * @description Broadcasted notifications are a special kind of notification that are always accessible to all users, including anonymous users. + * They are typically used to display important information such as maintenance windows or new features. + * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. + * + * Broadcasted notifications can include action links that are displayed as buttons. + * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. + * + * Some key features of broadcasted notifications include: + * - They are not associated with a specific user, so they cannot be deleted or marked as read. + * - They can be scheduled to be displayed in the future or to expire after a certain time. + * - By default, broadcasted notifications are published immediately and expire six months after publication. + * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. + */ + broadcast_notification_api_notifications_broadcast_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the user. */ - user_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["BroadcastNotificationCreateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["CustomBuildsCollection"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["NotificationCreatedResponse"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Returns the information of a specific broadcasted notification. + * @description Only Admin users can access inactive notifications (scheduled or recently expired). + */ + get_broadcasted_api_notifications_broadcast__notification_id__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the Notification. */ + notification_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["BroadcastNotificationResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - add_custom_builds_api_users__user_id__custom_builds__key__put: { - /** Add new custom build. */ + /** + * Updates the state of a broadcasted notification. + * @description Only Admins can update broadcasted notifications. This is useful to reschedule, edit or expire broadcasted notifications. + */ + update_broadcasted_notification_api_notifications_broadcast__notification_id__put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The key of the custom build to be deleted. */ - key: string; + /** @description The ID of the Notification. */ + notification_id: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["CustomBuildCreationPayload"]; + "application/json": components["schemas"]["NotificationBroadcastUpdateRequest"]; }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + 204: { + content: never; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Returns the current user's preferences for notifications. + * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. + * + * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. + * The supported channels are returned in the `supported-channels` header. + */ + get_notification_preferences_api_notifications_preferences_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - delete_custom_build_api_users__user_id__custom_builds__key__delete: { - /** Delete a custom build */ + /** + * Updates the user's preferences for notifications. + * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. + * + * - Can be used to completely enable/disable notifications for a particular type (category) + * or to enable/disable a particular channel on each category. + */ + update_notification_preferences_api_notifications_preferences_put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The key of the custom build to be deleted. */ - key: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateUserNotificationPreferencesRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["DeletedCustomBuild"]; + "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Returns the current status summary of the user's notifications since a particular date. + * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. + */ + get_notifications_status_api_notifications_status_get: { + parameters: { + query: { + since: string; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["NotificationStatusSummary"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Displays information about a notification received by the user. */ + show_notification_api_notifications__notification_id__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Notification. */ + notification_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserNotificationResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - set_favorite_api_users__user_id__favorites__object_type__put: { - /** Add the object to user's favorites */ + /** Updates the state of a notification received by the user. */ + update_user_notification_api_notifications__notification_id__put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The object type the user wants to favorite */ - object_type: components["schemas"]["FavoriteObjectType"]; + /** @description The ID of the Notification. */ + notification_id: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["FavoriteObject"]; + "application/json": components["schemas"]["UserNotificationUpdateRequest"]; }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["FavoriteObjectsSummary"]; - }; + 204: { + content: never; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + }; + }; + /** + * Deletes a notification received by the user. + * @description When a notification is deleted, it is not immediately removed from the database, but marked as deleted. + * + * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. + * - It will be eventually removed from the database by a background task after the expiration time. + * - Deleted notifications will be permanently deleted when the expiration time is reached. + */ + delete_user_notification_api_notifications__notification_id__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Notification. */ + notification_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 204: { + content: never; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + }; + }; + /** Get a list of persisted object store instances defined by the requesting user. */ + object_stores__instances_index: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"][]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Create a user-bound object store. */ + object_stores__create_instance: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInstancePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - remove_favorite_api_users__user_id__favorites__object_type___object_id__delete: { - /** Remove the object from user's favorites */ + /** Test payload for creating user-bound object store. */ + object_stores__test_new_instance_configuration: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The object type the user wants to favorite */ - object_type: components["schemas"]["FavoriteObjectType"]; - /** @description The ID of an object the user wants to remove from favorites */ - object_id: string; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["FavoriteObjectsSummary"]; + "application/json": components["schemas"]["PluginStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Get a persisted user object store instance. */ + object_stores__instances_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The UUID used to identify a persisted UserObjectStore object. */ + user_object_store_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Update or upgrade user object store instance. */ + object_stores__instances_update: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The UUID used to identify a persisted UserObjectStore object. */ + user_object_store_id: string; + }; + }; + requestBody: { + content: { + "application/json": + | components["schemas"]["UpdateInstanceSecretPayload"] + | components["schemas"]["UpgradeInstancePayload"] + | components["schemas"]["UpdateInstancePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_user_objectstore_usage_api_users__user_id__objectstore_usage_get: { - /** Return the user's object store usage summary broken down by object store ID */ + /** Purge user object store instance. */ + object_stores__instances_purge: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; + /** @description The UUID used to identify a persisted UserObjectStore object. */ + user_object_store_id: string; }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserObjectstoreUsage"][]; - }; + 204: { + content: never; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Get a list of object store templates available to build user defined object stores from */ + object_stores__templates_index: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { + }; + responses: { + /** @description A list of the configured object store templates. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ObjectStoreTemplateSummaries"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ + index_api_object_stores_get: { + parameters: { + query?: { + /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ + selectable?: boolean; + }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description A list of the configured object stores. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["ConcreteObjectStoreModel"] + | components["schemas"]["UserConcreteObjectStoreModel"] + )[]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - recalculate_disk_usage_by_user_id_api_users__user_id__recalculate_disk_usage_put: { - /** Triggers a recalculation of the current user disk usage. */ + /** Get information about a concrete object store configured with Galaxy. */ + show_info_api_object_stores__object_store_id__get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; + /** @description The concrete object store ID. */ + object_store_id: string; }; }; responses: { - /** @description The asynchronous task summary to track the task state. */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["ConcreteObjectStoreModel"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description The background task was submitted but there is no status tracking ID available. */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Lists all Pages viewable by the user. + * @description Get a list with summary information of all Pages available to the user. + */ + index_api_pages_get: { + parameters: { + query?: { + /** @description Whether to include deleted pages in the result. */ + deleted?: boolean; + limit?: number; + offset?: number; + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `title` + * : The page's title. + * + * `slug` + * : The page's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The page's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `user` + * : The page's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Pages: `title`, `slug`, `tag`, `user`. + */ + search?: string | null; + show_own?: boolean; + show_published?: boolean; + show_shared?: boolean; + /** @description Sort page index by this specified attribute on the page model */ + sort_by?: "create_time" | "title" | "update_time" | "username"; + /** @description Sort in descending order? */ + sort_desc?: boolean; + user_id?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description A list with summary page information. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["PageSummaryList"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Create a page and return summary information. + * @description Get a list with details of all Pages available to the user. + */ + create_api_pages_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreatePagePayload"]; + }; + }; + responses: { + /** @description The page summary information. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["PageSummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - send_activation_email_api_users__user_id__send_activation_email_post: { - /** Sends activation email to user. */ + /** + * Return a page summary and the content of the last revision. + * @description Return summary information about a specific Page and the content of the last revision. + */ + show_api_pages__id__get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; + /** @description The ID of the Page. */ + id: string; }; }; responses: { - /** @description Successful Response */ + /** @description The page summary information. */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["PageDetails"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Marks the specific Page as deleted. + * @description Marks the Page with the given ID as deleted. + */ + delete_api_pages__id__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the Page. */ + id: string; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + responses: { + /** @description Successful Response */ + 204: { + content: never; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Return a PDF document of the last revision of the Page. + * @description Return a PDF document of the last revision of the Page. + * + * This feature may not be available in this Galaxy. + */ + show_pdf_api_pages__id__pdf_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Page. */ + id: string; + }; + }; + responses: { + /** @description PDF document with the last revision of the page. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/pdf": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description PDF conversion service not available. */ + 501: { + content: never; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - set_theme_api_users__user_id__theme__theme__put: { - /** Set the user's theme choice */ + /** + * Makes this item inaccessible by a URL link. + * @description Makes this item inaccessible by a URL link and return the current sharing status. + */ + disable_link_access_api_pages__id__disable_link_access_put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The theme of the GUI */ - theme: string; + /** @description The ID of the Page. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": string; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. + */ + enable_link_access_api_pages__id__enable_link_access_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the Page. */ + id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Return a PDF document of the last revision of the Page. + * @description Return a STS download link for this page to be downloaded as a PDF. + * + * This feature may not be available in this Galaxy. + */ + prepare_pdf_api_pages__id__prepare_download_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Page. */ + id: string; + }; + }; + responses: { + /** @description Short term storage reference for async monitoring of this download. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description PDF conversion service not available. */ + 501: { + content: never; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_user_usage_api_users__user_id__usage_get: { - /** Return the user's quota usage summary broken down by quota source */ + /** + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. + */ + publish_api_pages__id__publish_put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; + /** @description The ID of the Page. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserQuotaUsage"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. + */ + share_with_users_api_pages__id__share_with_users_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the Page. */ + id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ShareWithPayload"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ShareWithStatus"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_user_usage_for_label_api_users__user_id__usage__label__get: { - /** Return the user's quota usage summary for a given quota source label */ + /** + * Get the current sharing status of the given Page. + * @description Return the sharing status of the item. + */ + sharing_api_pages__id__sharing_get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; - /** @description The label corresponding to the quota source to fetch usage information about. */ - label: string; + /** @description The ID of the Page. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserQuotaUsage"] | null; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. + */ + set_slug_api_pages__id__slug_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the Page. */ + id: string; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetSlugPayload"]; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + responses: { + /** @description Successful Response */ + 204: { + content: never; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { + }; + }; + /** + * Undelete the specific Page. + * @description Marks the Page with the given ID as undeleted. + */ + undelete_api_pages__id__undelete_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Page. */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 204: { + content: never; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - version_api_version_get: { - /** - * Return Galaxy version information: major/minor version, optional extra info - * @description Return Galaxy version information: major/minor version, optional extra info. - */ + /** + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. + */ + unpublish_api_pages__id__unpublish_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Page. */ + id: string; + }; + }; responses: { - /** @description Galaxy version information: major/minor version, optional extra info */ + /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Displays a list with information of quotas that are currently active. + * @description Displays a list with information of quotas that are currently active. + */ + index_api_quotas_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["QuotaSummaryList"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Creates a new quota. + * @description Creates a new quota. + */ + create_api_quotas_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateQuotaParams"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["CreateQuotaResult"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_visualizations_get: { - /** Returns visualizations for the current user. */ - parameters?: { - /** @description Whether to include deleted visualizations in the result. */ - /** @description The maximum number of items to return. */ - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - /** @description Sort visualization index by this specified attribute on the visualization model */ - /** @description Sort in descending order? */ - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `title` - * : The visualization's title. - * - * `slug` - * : The visualization's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The visualization's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `user` - * : The visualization's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Visualizations: `title`, `slug`, `tag`, `type`. - */ - query?: { - deleted?: boolean; - limit?: number | null; - offset?: number | null; - user_id?: string | null; - show_own?: boolean; - show_published?: boolean; - show_shared?: boolean; - sort_by?: "create_time" | "title" | "update_time" | "username"; - sort_desc?: boolean; - search?: string | null; - }; + /** + * Displays a list with information of quotas that have been deleted. + * @description Displays a list with information of quotas that have been deleted. + */ + index_deleted_api_quotas_deleted_get: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; @@ -40600,83 +23131,107 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["VisualizationSummaryList"]; + "application/json": components["schemas"]["QuotaSummaryList"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Displays details on a particular quota that has been deleted. + * @description Displays details on a particular quota that has been deleted. + */ + deleted_quota_api_quotas_deleted__id__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the Quota. */ + id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["QuotaDetails"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Restores a previously deleted quota. + * @description Restores a previously deleted quota. + */ + undelete_api_quotas_deleted__id__undelete_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Quota. */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": string; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - disable_link_access_api_visualizations__id__disable_link_access_put: { - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ + /** + * Displays details on a particular active quota. + * @description Displays details on a particular active quota. + */ + quota_api_quotas__id__get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Visualization. */ + /** @description The ID of the Quota. */ id: string; }; }; @@ -40684,83 +23239,114 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["QuotaDetails"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Updates an existing quota. + * @description Updates an existing quota. + */ + update_api_quotas__id__put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the Quota. */ + id: string; }; - /** @description No such object found. */ - 404: { + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateQuotaParams"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": string; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Deletes an existing quota. + * @description Deletes an existing quota. + */ + delete_api_quotas__id__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the Quota. */ + id: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteQuotaPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": string; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - enable_link_access_api_visualizations__id__enable_link_access_put: { - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ + /** Purges a previously deleted quota. */ + purge_api_quotas__id__purge_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Visualization. */ + /** @description The ID of the Quota. */ id: string; }; }; @@ -40768,256 +23354,323 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": string; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Displays remote files available to the user. + * @description Lists all remote files available to the user from different sources. + * + * The total count of files and directories is returned in the 'total_matches' header. + */ + index_api_remote_files_get: { + parameters: { + query?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + target?: string; + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + format?: components["schemas"]["RemoteFilesFormat"] | null; + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + recursive?: boolean | null; + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + disable?: components["schemas"]["RemoteFilesDisableMode"] | null; + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + writeable?: boolean | null; + /** @description Maximum number of entries to return. */ + limit?: number | null; + /** @description Number of entries to skip. */ + offset?: number | null; + /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ + query?: string | null; + /** @description Sort the entries by the specified field. */ + sort_by?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description A list with details about the remote files available to the user. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["ListUriResponse"] + | components["schemas"]["ListJstreeResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Creates a new entry (directory/record) on the remote files source. + * @description Creates a new entry on the remote files source. + */ + create_entry_api_remote_files_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateEntryPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["CreatedEntryResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - publish_api_visualizations__id__publish_put: { - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ + /** + * Display plugin information for each of the gxfiles:// URI targets available. + * @description Display plugin information for each of the gxfiles:// URI targets available. + */ + plugins_api_remote_files_plugins_get: { parameters: { + query?: { + /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ + browsable_only?: boolean | null; + /** @description Whether to return **only** filesources of the specified kind. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ + include_kind?: components["schemas"]["PluginKind"][] | null; + /** @description Whether to exclude filesources of the specified kind from the list. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ + exclude_kind?: components["schemas"]["PluginKind"][] | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Visualization. */ - id: string; - }; }; responses: { - /** @description Successful Response */ + /** @description A list with details about each plugin. */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["FilesSourcePluginList"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Index */ + index_api_roles_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["RoleListResponse"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Create */ + create_api_roles_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["RoleDefinitionModel"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - share_with_users_api_visualizations__id__share_with_users_put: { - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ + /** Show */ + show_api_roles__id__get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Visualization. */ id: string; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["ShareWithPayload"]; - }; - }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ShareWithStatus"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Delete */ + delete_api_roles__id__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Purge */ + purge_api_roles__id__purge_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - sharing_api_visualizations__id__sharing_get: { - /** - * Get the current sharing status of the given Visualization. - * @description Return the sharing status of the item. - */ + /** Undelete */ + undelete_api_roles__id__undelete_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Visualization. */ id: string; }; }; @@ -41025,1897 +23678,2234 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Serve the staged download specified by request ID. */ + serve_api_short_term_storage__storage_request_id__get: { + parameters: { + path: { + storage_request_id: string; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + responses: { + /** @description The archive file containing the History. */ + 200: { + content: never; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + /** @description Request was cancelled without an exception condition recorded. */ + 204: { + content: never; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Determine if specified storage request ID is ready for download. */ + is_ready_api_short_term_storage__storage_request_id__ready_get: { + parameters: { + path: { + storage_request_id: string; + }; + }; + responses: { + /** @description Boolean indicating if the storage is ready. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": boolean; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - set_slug_api_visualizations__id__slug_put: { - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ + /** + * Purges a set of datasets by ID from disk. The datasets must be owned by the user. + * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. + */ + cleanup_datasets_api_storage_datasets_delete: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Visualization. */ - id: string; - }; }; requestBody: { content: { - "application/json": components["schemas"]["SetSlugPayload"]; + "application/json": components["schemas"]["CleanupStorageItemsRequest"]; }; }; responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["StorageItemsCleanupResult"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Returns discarded datasets owned by the given user. The results can be paginated. */ + discarded_datasets_api_storage_datasets_discarded_get: { + parameters: { + query?: { + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ + order?: components["schemas"]["StoredItemOrderBy"] | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["StoredItem"][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - unpublish_api_visualizations__id__unpublish_put: { - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ + /** Returns information with the total storage space taken by discarded datasets owned by the given user. */ + discarded_datasets_summary_api_storage_datasets_discarded_summary_get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Visualization. */ - id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Purges a set of histories by ID. The histories must be owned by the user. + * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. + */ + cleanup_histories_api_storage_histories_delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CleanupStorageItemsRequest"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["StorageItemsCleanupResult"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Returns archived histories owned by the given user that are not purged. The results can be paginated. */ + archived_histories_api_storage_histories_archived_get: { + parameters: { + query?: { + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ + order?: components["schemas"]["StoredItemOrderBy"] | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["StoredItem"][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - whoami_api_whoami_get: { - /** - * Return information about the current authenticated user - * @description Return information about the current authenticated user. - */ - parameters?: { - /** @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. */ + /** Returns information with the total storage space taken by non-purged archived histories associated with the given user. */ + archived_histories_summary_api_storage_histories_archived_summary_get: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; }; responses: { - /** @description Information about the current authenticated user */ + /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserModel"] | null; + "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Returns all discarded histories associated with the given user. */ + discarded_histories_api_storage_histories_discarded_get: { + parameters: { + query?: { + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ + order?: components["schemas"]["StoredItemOrderBy"] | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["StoredItem"][]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Returns information with the total storage space taken by discarded histories associated with the given user. */ + discarded_histories_summary_api_storage_histories_discarded_summary_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_workflows_get: { - /** - * Lists stored workflows viewable by the user. - * @description Lists stored workflows viewable by the user. - */ - parameters?: { - /** @description Whether to restrict result to deleted workflows. */ - /** @description Whether to restrict result to hidden workflows. */ - /** @description Whether to include a list of missing tools per workflow entry */ - /** @description In unspecified, default ordering depends on other parameters but generally the user's own workflows appear first based on update time */ - /** @description Sort in descending order? */ - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `name` - * : The stored workflow's name. (The tag `n` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The workflow's tag, if the tag contains a colon an approach will be made to match the key and value of the tag separately. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `user` - * : The stored workflow's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * `is:published` - * : Include only published workflows in the final result. Be sure the query parameter `show_published` is set to `true` if to include all published workflows and not just the requesting user's. - * - * `is:share_with_me` - * : Include only workflows shared with the requesting user. Be sure the query parameter `show_shared` is set to `true` if to include shared workflows. - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Stored Workflows: `name`, `tag`, `user`. - */ - /** @description Set this to true to skip joining workflow step counts and optimize the resulting index query. Response objects will not contain step counts. */ - query?: { - show_deleted?: boolean; - show_hidden?: boolean; - missing_tools?: boolean; - show_published?: boolean | null; - show_shared?: boolean | null; - sort_by?: ("create_time" | "update_time" | "name") | null; - sort_desc?: boolean | null; - limit?: number | null; - offset?: number | null; - search?: string | null; - /** @description Set this to true to skip joining workflow step counts and optimize the resulting index query. Response objects will not contain step counts. */ - skip_step_counts?: boolean; - }; + /** + * Apply a new set of tags to an item. + * @description Replaces the tags associated with an item with the new ones specified in the payload. + * + * - The previous tags will be __deleted__. + * - If no tags are provided in the request body, the currently associated tags will also be __deleted__. + */ + update_api_tags_put: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; }; + requestBody: { + content: { + "application/json": components["schemas"]["ItemTagsPayload"]; + }; + }; responses: { - /** @description A list with summary stored workflow information per viewable entry. */ - 200: { + /** @description Successful Response */ + 204: { + content: never; + }; + /** @description Client Error */ + "4XX": { content: { - "application/json": Record[]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + }; + }; + /** Determine state of task ID */ + state_api_tasks__task_id__state_get: { + parameters: { + path: { + task_id: string; + }; + }; + responses: { + /** @description String indicating task state. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["TaskState"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + }; + }; + /** + * Lists all available data tables + * @description Get the list of all available data tables. + */ + index_api_tool_data_get: { + responses: { + /** @description A list with details on individual data tables. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ToolDataEntryList"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Import a data manager bundle */ + create_api_tool_data_post: { + parameters: { + query?: { + tool_data_file_path?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ImportToolDataBundle"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - get_workflow_menu_api_workflows_menu_get: { - /** Get workflows present in the tools panel. */ - parameters?: { - /** @description Whether to restrict result to deleted workflows. */ - /** @description Whether to restrict result to hidden workflows. */ - /** @description Whether to include a list of missing tools per workflow entry */ - query?: { - /** @description Whether to restrict result to deleted workflows. */ - show_deleted?: boolean | null; - /** @description Whether to restrict result to hidden workflows. */ - show_hidden?: boolean | null; - /** @description Whether to include a list of missing tools per workflow entry */ - missing_tools?: boolean | null; - show_published?: boolean | null; - show_shared?: boolean | null; - }; + /** + * Get details of a given data table + * @description Get details of a given tool data table. + */ + show_api_tool_data__table_name__get: { + parameters: { header?: { /** @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. */ "run-as"?: string | null; }; + path: { + /** @description The name of the tool data table */ + table_name: string; + }; }; responses: { - /** @description Successful Response */ + /** @description A description of the given data table and its content */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["ToolDataDetails"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + }; + }; + /** + * Removes an item from a data table + * @description Removes an item from a data table and reloads it to return its updated details. + */ + delete_api_tool_data__table_name__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The name of the tool data table */ + table_name: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ToolDataItem"]; + }; + }; + responses: { + /** @description A description of the affected data table and its content */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ToolDataDetails"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + }; + }; + /** + * Get information about a particular field in a tool data table + * @description Reloads a data table and return its details. + */ + show_field_api_tool_data__table_name__fields__field_name__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The name of the tool data table */ + table_name: string; + /** @description The name of the tool data table field */ + field_name: string; + }; + }; + responses: { + /** @description Information about a data table field */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ToolDataField"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { + }; + }; + /** + * Get information about a particular field in a tool data table + * @description Download a file associated with the data table field. + */ + download_field_file_api_tool_data__table_name__fields__field_name__files__file_name__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The name of the tool data table */ + table_name: string; + /** @description The name of the tool data table field */ + field_name: string; + /** @description The name of a file associated with this data table field */ + file_name: string; + }; + }; + responses: { + /** @description Information about a data table field */ + 200: { + content: never; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_workflow_api_workflows__workflow_id__get: { - /** Displays information needed to run a workflow. */ + /** + * Reloads a tool data table + * @description Reloads a data table and return its details. + */ + reload_api_tool_data__table_name__reload_get: { parameters: { - query?: { - instance?: boolean | null; - /** @description Use the legacy workflow format. */ - legacy?: boolean | null; - /** @description The version of the workflow to fetch. */ - version?: number | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; + /** @description The name of the tool data table */ + table_name: string; }; }; responses: { - /** @description Successful Response */ + /** @description A description of the reloaded data table and its content */ 200: { content: { - "application/json": components["schemas"]["StoredWorkflowDetailed"]; + "application/json": components["schemas"]["ToolDataDetails"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + }; + }; + /** Lists installed tool shed repositories. */ + index_api_tool_shed_repositories_get: { + parameters: { + query?: { + /** @description Filter by repository name. */ + name?: string | null; + /** @description Filter by repository owner. */ + owner?: string | null; + /** @description Filter by changeset revision. */ + changeset?: string | null; + /** @description Filter by whether the repository has been deleted. */ + deleted?: boolean | null; + /** @description Filter by whether the repository has been uninstalled. */ + uninstalled?: boolean | null; + }; + }; + responses: { + /** @description A list of installed tool shed repository objects. */ + 200: { + content: { + "application/json": components["schemas"]["InstalledToolShedRepository"][]; + }; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + }; + }; + /** Check for updates to the specified repository, or all installed repositories. */ + check_for_updates_api_tool_shed_repositories_check_for_updates_get: { + parameters: { + query?: { + id?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description A description of the state and updates message. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["CheckForUpdatesResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Show installed tool shed repository. */ + show_api_tool_shed_repositories__id__get: { + parameters: { + path: { + /** @description The encoded database identifier of the installed Tool Shed Repository. */ + id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["InstalledToolShedRepository"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - delete_workflow_api_workflows__workflow_id__delete: { - /** Add the deleted flag to a workflow. */ + /** Upload files to Galaxy */ + fetch_form_api_tools_fetch_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; + }; + requestBody: { + content: { + "multipart/form-data": components["schemas"]["Body_fetch_form_api_tools_fetch_post"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + }; + }; + /** + * Index + * @description Return list of available tours. + */ + index_api_tours_get: { + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["TourList"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Show + * @description Return a tour definition. + */ + show_api_tours__tour_id__get: { + parameters: { + path: { + tour_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["TourDetails"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - workflows__invocation_counts: { - /** Get state counts for accessible workflow. */ + /** + * Update Tour + * @description Return a tour definition. + */ + update_tour_api_tours__tour_id__post: { parameters: { - query?: { - /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ - instance?: boolean | null; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; + tour_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["RootModel_Dict_str__int__"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["TourDetails"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Get Users + * @description Return a collection of users. Filters will only work if enabled in config or user is admin. + */ + get_users_api_users_get: { + parameters: { + query?: { + /** @description Indicates if the collection will be about deleted users */ + deleted?: boolean; + /** @description An email address to filter on */ + f_email?: string | null; + /** @description An username address to filter on */ + f_name?: string | null; + /** @description Filter on username OR email */ + f_any?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["UserModel"] + | components["schemas"]["LimitedUserModel"] + )[]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - disable_link_access_api_workflows__workflow_id__disable_link_access_put: { - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ + /** Create a new Galaxy user. Only admins can create users for now. */ + create_user_api_users_post: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; + }; + requestBody: { + content: { + "application/json": + | components["schemas"]["UserCreationPayload"] + | components["schemas"]["RemoteUserCreationPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["CreatedUserModel"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Triggers a recalculation of the current user disk usage. + * @description This route will be removed in a future version. + * + * Please use `/api/users/current/recalculate_disk_usage` instead. + */ + recalculate_disk_usage_api_users_current_recalculate_disk_usage_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { + }; + responses: { + /** @description The asynchronous task summary to track the task state. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + /** @description The background task was submitted but there is no status tracking ID available. */ + 204: { + content: never; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Get Deleted Users + * @description Return a collection of deleted users. Only admins can see deleted users. + */ + get_deleted_users_api_users_deleted_get: { + parameters: { + query?: { + /** @description An email address to filter on */ + f_email?: string | null; + /** @description An username address to filter on */ + f_name?: string | null; + /** @description Filter on username OR email */ + f_any?: string | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["UserModel"] + | components["schemas"]["LimitedUserModel"] + )[]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - enable_link_access_api_workflows__workflow_id__enable_link_access_put: { - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ + /** Return information about a deleted user. Only admins can see deleted users. */ + get_deleted_user_api_users_deleted__user_id__get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": + | components["schemas"]["DetailedUserModel"] + | components["schemas"]["AnonUserModel"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Restore a deleted user. Only admins can restore users. */ + undelete_user_api_users_deleted__user_id__undelete_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the user. */ + user_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DetailedUserModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Triggers a recalculation of the current user disk usage. + * @deprecated + * @description This route will be removed in a future version. + * + * Please use `/api/users/current/recalculate_disk_usage` instead. + */ + recalculate_disk_usage_api_users_recalculate_disk_usage_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + }; + responses: { + /** @description The asynchronous task summary to track the task state. */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description The background task was submitted but there is no status tracking ID available. */ + 204: { + content: never; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_invocations_api_workflows__workflow_id__invocations_get: { - /** Get the list of a user's workflow invocations. */ + /** Return information about a specified or the current user. Only admin can see deleted or other users */ + get_user_api_users__user_id__get: { parameters: { query?: { - /** @description Return only invocations for this History ID */ - history_id?: string | null; - /** @description Return only invocations for this Job ID */ - job_id?: string | null; - /** @description Return invocations for this User ID. */ - user_id?: string | null; - /** @description Sort Workflow Invocations by this attribute */ - sort_by?: components["schemas"]["InvocationSortByEnum"] | null; - /** @description Sort in descending order? */ - sort_desc?: boolean; - /** @description Set to false to only include terminal Invocations. */ - include_terminal?: boolean | null; - /** @description Limit the number of invocations to return. */ - limit?: number | null; - /** @description Number of invocations to skip. */ - offset?: number | null; - /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ - instance?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; + /** @description Indicates if the user is deleted */ + deleted?: boolean | null; }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"][]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["DetailedUserModel"] + | components["schemas"]["AnonUserModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Update the values of a user. Only admin can update others. */ + update_user_api_users__user_id__put: { + parameters: { + query?: { + /** @description Indicates if the user is deleted */ + deleted?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; + }; + }; + requestBody: { + content: { + "application/json": Record; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DetailedUserModel"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - Invoke_workflow_api_workflows__workflow_id__invocations_post: { - /** Schedule the workflow specified by `workflow_id` to run. */ + /** Delete a user. Only admins can delete others or purge users. */ + delete_user_api_users__user_id__delete: { parameters: { + query?: { + /** @description Whether to definitely remove this user. Only deleted users can be purged. */ + purge?: boolean; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The database identifier - UUID or encoded - of the Workflow. */ - workflow_id: string; + /** @description The ID of the user. */ + user_id: string; }; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["InvokeWorkflowPayload"]; + "application/json": components["schemas"]["UserDeletionPayload"] | null; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["WorkflowInvocationResponse"] - | components["schemas"]["WorkflowInvocationResponse"][]; + "application/json": components["schemas"]["DetailedUserModel"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + }; + }; + /** Return the user's API key */ + get_or_create_api_key_api_users__user_id__api_key_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": string; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + }; + }; + /** Create a new API key for the user */ + create_api_key_api_users__user_id__api_key_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": string; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Internal server error. */ - 500: { + }; + }; + /** Delete the current API key of the user */ + delete_api_key_api_users__user_id__api_key_delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 204: { + content: never; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__get: { - /** - * Get detailed description of a workflow invocation. - * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ + /** Return the user's API key with extra information. */ + get_api_key_detailed_api_users__user_id__api_key_detailed_get: { parameters: { - query?: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ - legacy_job_state?: boolean; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { - /** @description Successful Response */ + /** @description The API key of the user. */ 200: { content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; + "application/json": components["schemas"]["APIKeyModel"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + /** @description The user doesn't have an API key. */ + 204: { + content: never; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Return information about beacon share settings + * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. + */ + get_beacon_settings_api_users__user_id__beacon_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user. */ + user_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserBeaconSetting"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Change beacon setting + * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. + */ + set_beacon_settings_api_users__user_id__beacon_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UserBeaconSetting"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserBeaconSetting"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - cancel_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__delete: { - /** - * Cancel the specified workflow invocation. - * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ + /** Returns collection of custom builds. */ + get_custom_builds_api_users__user_id__custom_builds_get: { parameters: { - query?: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ - legacy_job_state?: boolean; - }; header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; + "application/json": components["schemas"]["CustomBuildsCollection"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Add new custom build. */ + add_custom_builds_api_users__user_id__custom_builds__key__put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the user. */ + user_id: string; + /** @description The key of the custom build to be deleted. */ + key: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CustomBuildCreationPayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Delete a custom build */ + delete_custom_build_api_users__user_id__custom_builds__key__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user. */ + user_id: string; + /** @description The key of the custom build to be deleted. */ + key: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["DeletedCustomBuild"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - workflow_invocation_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__jobs_summary_get: { - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. - */ + /** Add the object to user's favorites */ + set_favorite_api_users__user_id__favorites__object_type__put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description The ID of the user. */ + user_id: string; + /** @description The object type the user wants to favorite */ + object_type: components["schemas"]["FavoriteObjectType"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["FavoriteObject"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationJobsResponse"]; + "application/json": components["schemas"]["FavoriteObjectsSummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Remove the object from user's favorites */ + remove_favorite_api_users__user_id__favorites__object_type___object_id__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The ID of the user. */ + user_id: string; + /** @description The object type the user wants to favorite */ + object_type: components["schemas"]["FavoriteObjectType"]; + /** @description The ID of an object the user wants to remove from favorites */ + object_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["FavoriteObjectsSummary"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Return the user's object store usage summary broken down by object store ID */ + get_user_objectstore_usage_api_users__user_id__objectstore_usage_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserObjectstoreUsage"][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_workflow_invocation_report_api_workflows__workflow_id__invocations__invocation_id__report_get: { - /** - * Get JSON summarizing invocation for reporting. - * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. - */ + /** Triggers a recalculation of the current user disk usage. */ + recalculate_disk_usage_by_user_id_api_users__user_id__recalculate_disk_usage_put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; + /** @description The ID of the user. */ + user_id: string; }; }; responses: { - /** @description Successful Response */ + /** @description The asynchronous task summary to track the task state. */ 200: { content: { - "application/json": components["schemas"]["InvocationReport"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + /** @description The background task was submitted but there is no status tracking ID available. */ + 204: { + content: never; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Sends activation email to user. */ + send_activation_email_api_users__user_id__send_activation_email_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user. */ + user_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Set the user's theme choice */ + set_theme_api_users__user_id__theme__theme__put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user. */ + user_id: string; + /** @description The theme of the GUI */ + theme: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": string; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_workflow_invocation_report_pdf_api_workflows__workflow_id__invocations__invocation_id__report_pdf_get: { - /** - * Get PDF summarizing invocation for reporting. - * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. - */ + /** Return the user's quota usage summary broken down by quota source */ + get_user_usage_api_users__user_id__usage_get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; }; }; responses: { /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserQuotaUsage"][]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Return the user's quota usage summary for a given quota source label */ + get_user_usage_for_label_api_users__user_id__usage__label__get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; + /** @description The label corresponding to the quota source to fetch usage information about. */ + label: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserQuotaUsage"] | null; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Return Galaxy version information: major/minor version, optional extra info + * @description Return Galaxy version information: major/minor version, optional extra info. + */ + version_api_version_get: { + responses: { + /** @description Galaxy version information: major/minor version, optional extra info */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": Record; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - workflow_invocation_step_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__step_jobs_summary_get: { - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. - */ + /** Returns visualizations for the current user. */ + index_api_visualizations_get: { parameters: { + query?: { + /** @description Whether to include deleted visualizations in the result. */ + deleted?: boolean; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + user_id?: string | null; + show_own?: boolean; + show_published?: boolean; + show_shared?: boolean; + /** @description Sort visualization index by this specified attribute on the visualization model */ + sort_by?: "create_time" | "title" | "update_time" | "username"; + /** @description Sort in descending order? */ + sort_desc?: boolean; + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `title` + * : The visualization's title. + * + * `slug` + * : The visualization's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The visualization's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `user` + * : The visualization's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Visualizations: `title`, `slug`, `tag`, `type`. + */ + search?: string | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["InvocationStepJobsResponseStepModel"] - | components["schemas"]["InvocationStepJobsResponseJobModel"] - | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"] - )[]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["VisualizationSummaryList"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Makes this item inaccessible by a URL link. + * @description Makes this item inaccessible by a URL link and return the current sharing status. + */ + disable_link_access_api_visualizations__id__disable_link_access_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Visualization. */ + id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__get: { - /** - * Show details of workflow invocation step. - * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. - */ + /** + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. + */ + enable_link_access_api_visualizations__id__enable_link_access_put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; + /** @description The encoded database identifier of the Visualization. */ + id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationStep"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. + */ + publish_api_visualizations__id__publish_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Visualization. */ + id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__put: { - /** - * Update state of running workflow step invocation. - * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. - */ + /** + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. + */ + share_with_users_api_visualizations__id__share_with_users_put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; + /** @description The encoded database identifier of the Visualization. */ + id: string; }; }; requestBody: { content: { - "application/json": components["schemas"]["InvocationUpdatePayload"]; + "application/json": components["schemas"]["ShareWithPayload"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationStep"]; + "application/json": components["schemas"]["ShareWithStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Get the current sharing status of the given Visualization. + * @description Return the sharing status of the item. + */ + sharing_api_visualizations__id__sharing_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Visualization. */ + id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. + */ + set_slug_api_visualizations__id__slug_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Visualization. */ + id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetSlugPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 204: { + content: never; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - publish_api_workflows__workflow_id__publish_put: { - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ + /** + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. + */ + unpublish_api_visualizations__id__unpublish_put: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; + /** @description The encoded database identifier of the Visualization. */ + id: string; }; }; responses: { @@ -42925,163 +25915,191 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Return information about the current authenticated user + * @description Return information about the current authenticated user. + */ + whoami_api_whoami_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Information about the current authenticated user */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["UserModel"] | null; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - refactor_api_workflows__workflow_id__refactor_put: { - /** Updates the workflow stored with the given ID. */ + /** + * Lists stored workflows viewable by the user. + * @description Lists stored workflows viewable by the user. + */ + index_api_workflows_get: { parameters: { query?: { - instance?: boolean | null; + /** @description Whether to restrict result to deleted workflows. */ + show_deleted?: boolean; + /** @description Whether to restrict result to hidden workflows. */ + show_hidden?: boolean; + /** @description Whether to include a list of missing tools per workflow entry */ + missing_tools?: boolean; + show_published?: boolean | null; + show_shared?: boolean | null; + /** @description In unspecified, default ordering depends on other parameters but generally the user's own workflows appear first based on update time */ + sort_by?: ("create_time" | "update_time" | "name") | null; + /** @description Sort in descending order? */ + sort_desc?: boolean | null; + limit?: number | null; + offset?: number | null; + /** + * @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `name` + * : The stored workflow's name. (The tag `n` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The workflow's tag, if the tag contains a colon an approach will be made to match the key and value of the tag separately. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `user` + * : The stored workflow's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * `is:published` + * : Include only published workflows in the final result. Be sure the query parameter `show_published` is set to `true` if to include all published workflows and not just the requesting user's. + * + * `is:share_with_me` + * : Include only workflows shared with the requesting user. Be sure the query parameter `show_shared` is set to `true` if to include shared workflows. + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Stored Workflows: `name`, `tag`, `user`. + */ + search?: string | null; + /** @description Set this to true to skip joining workflow step counts and optimize the resulting index query. Response objects will not contain step counts. */ + skip_step_counts?: boolean; }; header?: { /** @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. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Stored Workflow. */ - workflow_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["RefactorRequest"]; - }; }; responses: { - /** @description Successful Response */ + /** @description A list with summary stored workflow information per viewable entry. */ 200: { content: { - "application/json": components["schemas"]["RefactorResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": Record[]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Get workflows present in the tools panel. */ + get_workflow_menu_api_workflows_menu_get: { + parameters: { + query?: { + /** @description Whether to restrict result to deleted workflows. */ + show_deleted?: boolean | null; + /** @description Whether to restrict result to hidden workflows. */ + show_hidden?: boolean | null; + /** @description Whether to include a list of missing tools per workflow entry */ + missing_tools?: boolean | null; + show_published?: boolean | null; + show_shared?: boolean | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - share_with_users_api_workflows__workflow_id__share_with_users_put: { - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ + /** Displays information needed to run a workflow. */ + show_workflow_api_workflows__workflow_id__get: { parameters: { + query?: { + instance?: boolean | null; + /** @description Use the legacy workflow format. */ + legacy?: boolean | null; + /** @description The version of the workflow to fetch. */ + version?: number | null; + }; header?: { /** @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. */ "run-as"?: string | null; @@ -43091,85 +26109,102 @@ export interface operations { workflow_id: string; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["ShareWithPayload"]; - }; - }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ShareWithStatus"]; + "application/json": components["schemas"]["StoredWorkflowDetailed"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Add the deleted flag to a workflow. */ + delete_workflow_api_workflows__workflow_id__delete: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Get state counts for accessible workflow. */ + workflows__invocation_counts: { + parameters: { + query?: { + /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ + instance?: boolean | null; + }; + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["RootModel_Dict_str__int__"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - sharing_api_workflows__workflow_id__sharing_get: { - /** - * Get the current sharing status of the given item. - * @description Return the sharing status of the item. - */ + /** + * Makes this item inaccessible by a URL link. + * @description Makes this item inaccessible by a URL link and return the current sharing status. + */ + disable_link_access_api_workflows__workflow_id__disable_link_access_put: { parameters: { header?: { /** @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. */ @@ -43187,74 +26222,83 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Makes this item accessible by a URL link. + * @description Makes this item accessible by a URL link and return the current sharing status. + */ + enable_link_access_api_workflows__workflow_id__enable_link_access_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - set_slug_api_workflows__workflow_id__slug_put: { - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ + /** Get the list of a user's workflow invocations. */ + index_invocations_api_workflows__workflow_id__invocations_get: { parameters: { + query?: { + /** @description Return only invocations for this History ID */ + history_id?: string | null; + /** @description Return only invocations for this Job ID */ + job_id?: string | null; + /** @description Return invocations for this User ID. */ + user_id?: string | null; + /** @description Sort Workflow Invocations by this attribute */ + sort_by?: components["schemas"]["InvocationSortByEnum"] | null; + /** @description Sort in descending order? */ + sort_desc?: boolean; + /** @description Set to false to only include terminal Invocations. */ + include_terminal?: boolean | null; + /** @description Limit the number of invocations to return. */ + limit?: number | null; + /** @description Number of invocations to skip. */ + offset?: number | null; + /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ + instance?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + }; header?: { /** @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. */ "run-as"?: string | null; @@ -43264,660 +26308,845 @@ export interface operations { workflow_id: string; }; }; - requestBody: { - content: { - "application/json": components["schemas"]["SetSlugPayload"]; - }; - }; responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; /** @description Successful Response */ - 204: never; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Schedule the workflow specified by `workflow_id` to run. */ + Invoke_workflow_api_workflows__workflow_id__invocations_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The database identifier - UUID or encoded - of the Workflow. */ + workflow_id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["InvokeWorkflowPayload"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["WorkflowInvocationResponse"] + | components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - index_api_workflows__workflow_id__tags_get: { - /** Show tags based on workflow_id */ + /** + * Get detailed description of a workflow invocation. + * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. + */ + show_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__get: { parameters: { + query?: { + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + /** + * @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. + */ + legacy_job_state?: boolean; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsListResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Cancel the specified workflow invocation. + * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. + */ + cancel_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__delete: { + parameters: { + query?: { + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + /** + * @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. + */ + legacy_job_state?: boolean; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - show_api_workflows__workflow_id__tags__tag_name__get: { - /** Show tag based on workflow_id */ + /** + * Get job state summary info aggregated across all current jobs of the workflow invocation. + * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. + */ + workflow_invocation_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__jobs_summary_get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; - tag_name: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + }; + }; + /** + * Get JSON summarizing invocation for reporting. + * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. + */ + show_workflow_invocation_report_api_workflows__workflow_id__invocations__invocation_id__report_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["InvocationReport"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + }; + }; + /** + * Get PDF summarizing invocation for reporting. + * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. + */ + show_workflow_invocation_report_pdf_api_workflows__workflow_id__invocations__invocation_id__report_pdf_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + content: never; + }; + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Get job state summary info aggregated per step of the workflow invocation. + * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. + */ + workflow_invocation_step_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__step_jobs_summary_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": ( + | components["schemas"]["InvocationStepJobsResponseStepModel"] + | components["schemas"]["InvocationStepJobsResponseJobModel"] + | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"] + )[]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - update_api_workflows__workflow_id__tags__tag_name__put: { - /** Update tag based on workflow_id */ + /** + * Show details of workflow invocation step. + * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. + */ + workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; - tag_name: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Update state of running workflow step invocation. + * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. + */ + update_workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["InvocationUpdatePayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Makes this item public and accessible by a URL link. + * @description Makes this item publicly available by a URL link and return the current sharing status. + */ + publish_api_workflows__workflow_id__publish_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - create_api_workflows__workflow_id__tags__tag_name__post: { - /** Create tag based on workflow_id */ + /** Updates the workflow stored with the given ID. */ + refactor_api_workflows__workflow_id__refactor_put: { parameters: { + query?: { + instance?: boolean | null; + }; header?: { /** @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. */ "run-as"?: string | null; }; path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; - tag_name: string; }; }; - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; + "application/json": components["schemas"]["RefactorRequest"]; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ItemTagsResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["RefactorResponse"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Share this item with specific users. + * @description Shares this item with specific users and return the current sharing status. + */ + share_with_users_api_workflows__workflow_id__share_with_users_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ShareWithPayload"]; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ShareWithStatus"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - delete_api_workflows__workflow_id__tags__tag_name__delete: { - /** Delete tag based on workflow_id */ + /** + * Get the current sharing status of the given item. + * @description Return the sharing status of the item. + */ + sharing_api_workflows__workflow_id__sharing_get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; - tag_name: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": boolean; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** + * Set a new slug for this shared item. + * @description Sets a new slug to access this item by URL. The new slug must be unique. + */ + set_slug_api_workflows__workflow_id__slug_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetSlugPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 204: { + content: never; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Show tags based on workflow_id */ + index_api_workflows__workflow_id__tags_get: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + workflow_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - undelete_workflow_api_workflows__workflow_id__undelete_post: { - /** Remove the deleted flag from a workflow. */ + /** Show tag based on workflow_id */ + show_api_workflows__workflow_id__tags__tag_name__get: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + tag_name: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Update tag based on workflow_id */ + update_api_workflows__workflow_id__tags__tag_name__put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + workflow_id: string; + tag_name: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** Create tag based on workflow_id */ + create_api_workflows__workflow_id__tags__tag_name__post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + workflow_id: string; + tag_name: string; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - unpublish_api_workflows__workflow_id__unpublish_put: { - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ + /** Delete tag based on workflow_id */ + delete_api_workflows__workflow_id__tags__tag_name__delete: { parameters: { header?: { /** @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. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + tag_name: string; }; }; responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": boolean; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + }; + }; + /** Remove the deleted flag from a workflow. */ + undelete_workflow_api_workflows__workflow_id__undelete_post: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; }; - /** @description No such object found. */ - 404: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Validation error */ - 422: { + }; + }; + /** + * Removes this item from the published list. + * @description Removes this item from the published list and return the current sharing status. + */ + unpublish_api_workflows__workflow_id__unpublish_put: { + parameters: { + header?: { + /** @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. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Stored Workflow. */ + workflow_id: string; + }; + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Get the list of a user's workflow invocations. + * @deprecated + */ index_invocations_api_workflows__workflow_id__usage_get: { - /** - * Get the list of a user's workflow invocations. - * @deprecated - */ parameters: { query?: { /** @description Return only invocations for this History ID */ @@ -43959,73 +27188,25 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Schedule the workflow specified by `workflow_id` to run. + * @deprecated + */ Invoke_workflow_api_workflows__workflow_id__usage_post: { - /** - * Schedule the workflow specified by `workflow_id` to run. - * @deprecated - */ parameters: { header?: { /** @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. */ @@ -44050,74 +27231,26 @@ export interface operations { | components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Get detailed description of a workflow invocation. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. + */ show_workflow_invocation_api_workflows__workflow_id__usage__invocation_id__get: { - /** - * Get detailed description of a workflow invocation. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ @@ -44137,85 +27270,37 @@ export interface operations { path: { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; - /** @description Validation error */ - 422: { + }; + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Cancel the specified workflow invocation. + * @deprecated + * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. + */ cancel_workflow_invocation_api_workflows__workflow_id__usage__invocation_id__delete: { - /** - * Cancel the specified workflow invocation. - * @deprecated - * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ @@ -44246,74 +27331,26 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Get job state summary info aggregated across all current jobs of the workflow invocation. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. + */ workflow_invocation_jobs_summary_api_workflows__workflow_id__usage__invocation_id__jobs_summary_get: { - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. - */ parameters: { header?: { /** @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. */ @@ -44333,74 +27370,26 @@ export interface operations { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Get JSON summarizing invocation for reporting. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. + */ show_workflow_invocation_report_api_workflows__workflow_id__usage__invocation_id__report_get: { - /** - * Get JSON summarizing invocation for reporting. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. - */ parameters: { header?: { /** @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. */ @@ -44420,74 +27409,26 @@ export interface operations { "application/json": components["schemas"]["InvocationReport"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Get PDF summarizing invocation for reporting. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. + */ show_workflow_invocation_report_pdf_api_workflows__workflow_id__usage__invocation_id__report_pdf_get: { - /** - * Get PDF summarizing invocation for reporting. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. - */ parameters: { header?: { /** @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. */ @@ -44502,75 +27443,29 @@ export interface operations { }; responses: { /** @description Successful Response */ - 200: never; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + 200: { + content: never; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Get job state summary info aggregated per step of the workflow invocation. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. + */ workflow_invocation_step_jobs_summary_api_workflows__workflow_id__usage__invocation_id__step_jobs_summary_get: { - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. - */ parameters: { header?: { /** @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. */ @@ -44594,74 +27489,26 @@ export interface operations { )[]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Show details of workflow invocation step. + * @deprecated + * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. + */ workflow_invocation_step_api_workflows__workflow_id__usage__invocation_id__steps__step_id__get: { - /** - * Show details of workflow invocation step. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. - */ parameters: { header?: { /** @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. */ @@ -44680,77 +27527,29 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["InvocationStep"]; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** + * Update state of running workflow step invocation. + * @deprecated + * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. + */ update_workflow_invocation_step_api_workflows__workflow_id__usage__invocation_id__steps__step_id__put: { - /** - * Update state of running workflow step invocation. - * @deprecated - * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. - */ parameters: { header?: { /** @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. */ @@ -44777,70 +27576,22 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** List all versions of a workflow. */ show_versions_api_workflows__workflow_id__versions_get: { - /** List all versions of a workflow. */ parameters: { query?: { instance?: boolean | null; @@ -44858,73 +27609,25 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** Get Object */ get_object_ga4gh_drs_v1_objects__object_id__get: { - /** Get Object */ parameters: { header?: { /** @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. */ @@ -44942,70 +27645,22 @@ export interface operations { "application/json": components["schemas"]["DrsObject"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** Get Object */ get_object_ga4gh_drs_v1_objects__object_id__post: { - /** Get Object */ parameters: { header?: { /** @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. */ @@ -45023,70 +27678,22 @@ export interface operations { "application/json": components["schemas"]["DrsObject"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** Get Access Url */ get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__get: { - /** Get Access Url */ parameters: { header?: { /** @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. */ @@ -45103,73 +27710,25 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** Get Access Url */ get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__post: { - /** Get Access Url */ parameters: { header?: { /** @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. */ @@ -45186,73 +27745,25 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; - }; - }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": unknown; }; }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; + /** Service Info */ service_info_ga4gh_drs_v1_service_info_get: { - /** Service Info */ responses: { /** @description Successful Response */ 200: { @@ -45260,62 +27771,14 @@ export interface operations { "application/json": components["schemas"]["Service"]; }; }; - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; diff --git a/lib/galaxy/schema/schema.py b/lib/galaxy/schema/schema.py index 2ba9ff2ce065..8b75e50f5a69 100644 --- a/lib/galaxy/schema/schema.py +++ b/lib/galaxy/schema/schema.py @@ -3735,19 +3735,6 @@ class PageSummaryList(RootModel): ) -class DatasetSummary(Model): - id: EncodedDatabaseIdField - create_time: Optional[datetime] = CreateTimeField - update_time: Optional[datetime] = UpdateTimeField - state: DatasetStateField - deleted: bool - purged: bool - purgable: bool - file_size: int - total_size: int - uuid: UuidField - - class MessageExceptionModel(BaseModel): err_msg: str err_code: int diff --git a/lib/tool_shed/webapp/frontend/src/schema/schema.ts b/lib/tool_shed/webapp/frontend/src/schema/schema.ts index f56d914f4046..f44d4b0b365e 100644 --- a/lib/tool_shed/webapp/frontend/src/schema/schema.ts +++ b/lib/tool_shed/webapp/frontend/src/schema/schema.ts @@ -1045,73 +1045,25 @@ export interface operations { "application/json": components["schemas"]["APIKeyResponse"] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } + /** + * Index + * @description index category + */ categories__index: { - /** - * Index - * @description index category - */ responses: { /** @description Successful Response */ 200: { @@ -1119,73 +1071,25 @@ export interface operations { "application/json": components["schemas"]["Category"][] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } + /** + * Create + * @description create a category + */ categories__create: { - /** - * Create - * @description create a category - */ requestBody: { content: { "application/json": components["schemas"]["CreateCategoryRequest"] @@ -1198,62 +1102,14 @@ export interface operations { "application/json": components["schemas"]["Category"] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -1278,62 +1134,14 @@ export interface operations { "application/json": components["schemas"]["Category"] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -1364,2322 +1172,243 @@ export interface operations { "application/json": components["schemas"]["RepositoriesByCategory"] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + } + } + /** Service Info */ + tools_trs_service_info: { + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["Service"] } } - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + } + } + /** Tool Classes */ + tools__trs_tool_classes: { + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["ToolClass"][] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Validation error */ - 422: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Internal server error. */ - 500: { + } + } + /** Trs Index */ + tools__trs_index: { + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": unknown + } + } + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - /** Service Info */ - tools_trs_service_info: { + /** Trs Get */ + tools__trs_get: { + parameters: { + path: { + /** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */ + tool_id: string + } + } responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["Service"] + "application/json": components["schemas"]["Tool"] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** Trs Get Versions */ + tools__trs_get_versions: { + parameters: { + path: { + /** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */ + tool_id: string } - /** @description Authentication required for this request */ - 403: { + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["ToolVersion"][] } } - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** + * Index + * @description Get a list of repositories or perform a search. + */ + repositories__index: { + parameters: { + query?: { + q?: string | null + page?: number | null + page_size?: number | null + deleted?: boolean | null + owner?: string | null + name?: string | null } - /** @description Validation error */ - 422: { + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": + | components["schemas"]["RepositorySearchResults"] + | components["schemas"]["Repository"][] } } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - tools__trs_tool_classes: { - /** Tool Classes */ + /** + * Create + * @description create a new repository + */ + repositories__create: { + requestBody: { + content: { + "application/json": components["schemas"]["CreateRepositoryRequest"] + } + } responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["ToolClass"][] + "application/json": components["schemas"]["Repository"] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + } + } + /** + * Get Ordered Installable Revisions + * @description Get an ordered list of the repository changeset revisions that are installable + */ + repositories__get_ordered_installable_revisions: { + parameters: { + query?: { + owner?: string | null + name?: string | null + tsr_id?: string | null + } + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": string[] } } - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - tools__trs_index: { - /** Trs Index */ - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": unknown - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - tools__trs_get: { - /** Trs Get */ - parameters: { - path: { - /** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */ - tool_id: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["Tool"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Trs Get Versions */ - tools__trs_get_versions: { - parameters: { - path: { - /** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */ - tool_id: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ToolVersion"][] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Index - * @description Get a list of repositories or perform a search. - */ - repositories__index: { - parameters: { - query?: { - q?: string | null - page?: number | null - page_size?: number | null - deleted?: boolean | null - owner?: string | null - name?: string | null - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": - | components["schemas"]["RepositorySearchResults"] - | components["schemas"]["Repository"][] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Create - * @description create a new repository - */ - repositories__create: { - requestBody: { - content: { - "application/json": components["schemas"]["CreateRepositoryRequest"] - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["Repository"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Get Ordered Installable Revisions - * @description Get an ordered list of the repository changeset revisions that are installable - */ - repositories__get_ordered_installable_revisions: { - parameters: { - query?: { - owner?: string | null - name?: string | null - tsr_id?: string | null - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": string[] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Legacy Install Info - * @description Get information used by the install client to install this repository. - */ - repositories__legacy_install_info: { - parameters: { - query: { - /** @description Name of the target repository. */ - name: string - /** @description Owner of the target repository. */ - owner: string - /** @description Changeset of the target repository. */ - changeset_revision: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record[] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Install Info - * @description Get information used by the install client to install this repository. - */ - repositories__install_info: { - parameters: { - query: { - /** @description Name of the target repository. */ - name: string - /** @description Owner of the target repository. */ - owner: string - /** @description Changeset of the target repository. */ - changeset_revision: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["InstallInfo"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Reset Metadata On Repository Legacy - * @description reset metadata on a repository - */ - repositories__reset_legacy: { - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - repositories__update: { - /** Updates */ - parameters: { - query: { - owner?: string | null - name?: string | null - changeset_revision: string - hexlify?: boolean | null - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Show */ - repositories__show: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["DetailedRepository"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Show Allow Push */ - repositories__show_allow_push: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": string[] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Add Allow Push */ - repositories__add_allow_push: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - /** @description The target username. */ - username: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": string[] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Remove Allow Push */ - repositories__remove_allow_push: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - /** @description The target username. */ - username: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": string[] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Create Changeset Revision - * @description upload new revision to the repository - */ - repositories__create_revision: { - parameters: { - query?: { - /** @description Set commit message as a query parameter. */ - commit_message?: string | null - } - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - requestBody?: { - content: { - "multipart/form-data": components["schemas"]["Body_repositories__create_revision"] - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["RepositoryUpdate"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Set Deprecated */ - repositories__set_deprecated: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Successful Response */ - 204: never - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Unset Deprecated */ - repositories__unset_deprecated: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Successful Response */ - 204: never - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Metadata - * @description Get information about repository metadata - */ - repositories__metadata: { - parameters: { - query?: { - /** @description Include only downloadable repositories. */ - downloadable_only?: boolean - } - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Permissions */ - repositories__permissions: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["RepositoryPermissions"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Reset Metadata On Repository - * @description reset metadata on a repository - */ - repositories__reset: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Set Malicious */ - repositories__set_malicious: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - /** @description The changeset revision corresponding to the target revision of the target repository. */ - changeset_revision: string - } - } - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Successful Response */ - 204: never - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Unset Malicious */ - repositories__unset_malicious: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - /** @description The changeset revision corresponding to the target revision of the target repository. */ - changeset_revision: string - } - } - responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Successful Response */ - 204: never - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Get Readmes - * @description fetch readmes for repository revision - */ - repositories__readmes: { - parameters: { - path: { - /** @description The encoded database identifier of the repository. */ - encoded_repository_id: string - /** @description The changeset revision corresponding to the target revision of the target repository. */ - changeset_revision: string - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["RepositoryRevisionReadmes"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** Index */ - tools__index: { - parameters: { - query: { - q: string - page?: number - page_size?: number - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": Record - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - /** - * Build Search Index - * @description Not part of the stable API, just something to simplify - * bootstrapping tool sheds, scripting, testing, etc... - */ - tools__build_search_index: { - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["BuildSearchIndexResponse"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - users__index: { - /** - * Index - * @description index users - */ - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserV2"][] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - users__create: { - /** - * Create - * @description create a user - */ - requestBody: { - content: { - "application/json": components["schemas"]["CreateUserRequest"] - } - } - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserV2"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -3687,526 +1416,615 @@ export interface operations { } } /** - * Current - * @description show current user + * Legacy Install Info + * @description Get information used by the install client to install this repository. */ - users__current: { - responses: { - /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["UserV2"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Method is not implemented. */ - 501: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - } - } - users__show: { - /** - * Show - * @description show a user - */ + repositories__legacy_install_info: { parameters: { - path: { - /** @description The encoded database identifier of the user. */ - encoded_user_id: string + query: { + /** @description Name of the target repository. */ + name: string + /** @description Owner of the target repository. */ + owner: string + /** @description Changeset of the target repository. */ + changeset_revision: string } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UserV2"] - } - } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": unknown[] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** + * Install Info + * @description Get information used by the install client to install this repository. + */ + repositories__install_info: { + parameters: { + query: { + /** @description Name of the target repository. */ + name: string + /** @description Owner of the target repository. */ + owner: string + /** @description Changeset of the target repository. */ + changeset_revision: string } - /** @description No such object found. */ - 404: { + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["InstallInfo"] } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Validation error */ - 422: { + } + } + /** + * Reset Metadata On Repository Legacy + * @description reset metadata on a repository + */ + repositories__reset_legacy: { + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] } } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - /** Return the user's API key */ - users__get_or_create_api_key: { + /** Updates */ + repositories__update: { parameters: { - path: { - /** @description The encoded database identifier of the user. */ - encoded_user_id: string + query: { + owner?: string | null + name?: string | null + changeset_revision: string + hexlify?: boolean | null } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": string + "application/json": unknown } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** Show */ + repositories__show: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string } - /** @description Authentication required for this request */ - 403: { + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["DetailedRepository"] } } - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** Show Allow Push */ + repositories__show_allow_push: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string } - /** @description Validation error */ - 422: { + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": string[] } } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - /** Creates a new API key for the user */ - users__create_api_key: { + /** Add Allow Push */ + repositories__add_allow_push: { parameters: { path: { - /** @description The encoded database identifier of the user. */ - encoded_user_id: string + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + /** @description The target username. */ + username: string } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": string + "application/json": string[] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** Remove Allow Push */ + repositories__remove_allow_push: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + /** @description The target username. */ + username: string } - /** @description Authentication required for this request */ - 403: { + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": string[] } } - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** + * Create Changeset Revision + * @description upload new revision to the repository + */ + repositories__create_revision: { + parameters: { + query?: { + /** @description Set commit message as a query parameter. */ + commit_message?: string | null + } + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + requestBody?: { + content: { + "multipart/form-data": components["schemas"]["Body_repositories__create_revision"] } - /** @description Validation error */ - 422: { + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["RepositoryUpdate"] } } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - /** Delete the current API key of the user */ - users__delete_api_key: { + /** Set Deprecated */ + repositories__set_deprecated: { parameters: { path: { - /** @description The encoded database identifier of the user. */ - encoded_user_id: string + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string } } responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Successful Response */ + 204: { + content: never + } + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Successful Response */ - 204: never - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + } + } + /** Unset Deprecated */ + repositories__unset_deprecated: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + responses: { + /** @description Successful Response */ + 204: { + content: never + } + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description No such object found. */ - 404: { + } + } + /** + * Metadata + * @description Get information about repository metadata + */ + repositories__metadata: { + parameters: { + query?: { + /** @description Include only downloadable repositories. */ + downloadable_only?: boolean + } + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": Record } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Validation error */ - 422: { + } + } + /** Permissions */ + repositories__permissions: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["RepositoryPermissions"] } } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - /** Version */ - configuration__version: { + /** + * Reset Metadata On Repository + * @description reset metadata on a repository + */ + repositories__reset: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + } + } responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["Version"] + "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + } + } + /** Set Malicious */ + repositories__set_malicious: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + /** @description The changeset revision corresponding to the target revision of the target repository. */ + changeset_revision: string + } + } + responses: { + /** @description Successful Response */ + 204: { + content: never + } + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description No such object found. */ - 404: { + } + } + /** Unset Malicious */ + repositories__unset_malicious: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + /** @description The changeset revision corresponding to the target revision of the target repository. */ + changeset_revision: string + } + } + responses: { + /** @description Successful Response */ + 204: { + content: never + } + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** + * Get Readmes + * @description fetch readmes for repository revision + */ + repositories__readmes: { + parameters: { + path: { + /** @description The encoded database identifier of the repository. */ + encoded_repository_id: string + /** @description The changeset revision corresponding to the target revision of the target repository. */ + changeset_revision: string } - /** @description Validation error */ - 422: { + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["RepositoryRevisionReadmes"] } } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - users__internal_change_password: { - /** - * Change Password - * @description reset a user - */ - requestBody: { - content: { - "application/json": components["schemas"]["UiChangePasswordRequest"] + /** Index */ + tools__index: { + parameters: { + query: { + q: string + page?: number + page_size?: number } } responses: { - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } /** @description Successful Response */ - 204: never - /** @description User does not have permissions to run jobs as another user. */ - 400: { + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": unknown } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication required for this request */ - 403: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description No such object found. */ - 404: { + } + } + /** + * Build Search Index + * @description Not part of the stable API, just something to simplify + * bootstrapping tool sheds, scripting, testing, etc... + */ + tools__build_search_index: { + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["BuildSearchIndexResponse"] } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Validation error */ - 422: { + } + } + /** + * Index + * @description index users + */ + users__index: { + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["UserV2"][] } } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -4214,157 +2032,225 @@ export interface operations { } } /** - * Internal Login - * @description login to web UI + * Create + * @description create a user */ - users__internal_login: { + users__create: { requestBody: { content: { - "application/json": components["schemas"]["UiLoginRequest"] + "application/json": components["schemas"]["CreateUserRequest"] } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UiLoginResponse"] + "application/json": components["schemas"]["UserV2"] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { + } + } + /** + * Current + * @description show current user + */ + users__current: { + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["UserV2"] } } - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + } + } + /** + * Show + * @description show a user + */ + users__show: { + parameters: { + path: { + /** @description The encoded database identifier of the user. */ + encoded_user_id: string + } + } + responses: { + /** @description Successful Response */ + 200: { + content: { + "application/json": components["schemas"]["UserV2"] + } + } + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Validation error */ - 422: { + } + } + /** Return the user's API key */ + users__get_or_create_api_key: { + parameters: { + path: { + /** @description The encoded database identifier of the user. */ + encoded_user_id: string + } + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": string } } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } } } - /** - * Internal Logout - * @description logout of web UI - */ - users__internal_logout: { - requestBody: { - content: { - "application/json": components["schemas"]["UiLogoutRequest"] + /** Creates a new API key for the user */ + users__create_api_key: { + parameters: { + path: { + /** @description The encoded database identifier of the user. */ + encoded_user_id: string } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UiLogoutResponse"] + "application/json": string } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** Delete the current API key of the user */ + users__delete_api_key: { + parameters: { + path: { + /** @description The encoded database identifier of the user. */ + encoded_user_id: string + } + } + responses: { + /** @description Successful Response */ + 204: { + content: never } - /** @description Authentication required for this request */ - 403: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description No such object found. */ - 404: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + } + } + /** Version */ + configuration__version: { + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["Version"] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Validation error */ - 422: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Internal server error. */ - 500: { + } + } + /** + * Change Password + * @description reset a user + */ + users__internal_change_password: { + requestBody: { + content: { + "application/json": components["schemas"]["UiChangePasswordRequest"] + } + } + responses: { + /** @description Successful Response */ + 204: { + content: never + } + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -4372,78 +2258,92 @@ export interface operations { } } /** - * Register - * @description register a user + * Internal Login + * @description login to web UI */ - users__internal_register: { + users__internal_login: { requestBody: { content: { - "application/json": components["schemas"]["UiRegisterRequest"] + "application/json": components["schemas"]["UiLoginRequest"] } } responses: { /** @description Successful Response */ 200: { content: { - "application/json": components["schemas"]["UiRegisterResponse"] + "application/json": components["schemas"]["UiLoginResponse"] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description User does not have permissions to run jobs as another user. */ - 400: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** + * Internal Logout + * @description logout of web UI + */ + users__internal_logout: { + requestBody: { + content: { + "application/json": components["schemas"]["UiLogoutRequest"] } - /** @description Authentication required for this request */ - 403: { + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["UiLogoutResponse"] } } - /** @description No such object found. */ - 404: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Database conflict prevented fulfilling the request. */ - 409: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } + } + } + /** + * Register + * @description register a user + */ + users__internal_register: { + requestBody: { + content: { + "application/json": components["schemas"]["UiRegisterRequest"] } - /** @description Validation error */ - 422: { + } + responses: { + /** @description Successful Response */ + 200: { content: { - "application/json": components["schemas"]["MessageExceptionModel"] + "application/json": components["schemas"]["UiRegisterResponse"] } } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } @@ -4472,62 +2372,14 @@ export interface operations { "application/json": components["schemas"]["RepositoryMetadata"] } } - /** @description Galaxy has accepted this request and is processing. A retry-after header indicates to the client when to retry. */ - 202: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description User does not have permissions to run jobs as another user. */ - 400: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication failed, invalid credentials supplied. */ - 401: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Authentication required for this request */ - 403: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description No such object found. */ - 404: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Database conflict prevented fulfilling the request. */ - 409: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description This API method or call signature has been deprecated and is no longer available */ - 410: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Validation error */ - 422: { - content: { - "application/json": components["schemas"]["MessageExceptionModel"] - } - } - /** @description Internal server error. */ - 500: { + /** @description Client Error */ + "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } } - /** @description Method is not implemented. */ - 501: { + /** @description Server Error */ + "5XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] } From bd6ebb4762f19b811519a4c9f61cb34f54ddde9f Mon Sep 17 00:00:00 2001 From: Arash Date: Thu, 11 Jul 2024 14:30:58 +0200 Subject: [PATCH 15/17] Remove unused import --- lib/galaxy/webapps/base/api.py | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/galaxy/webapps/base/api.py b/lib/galaxy/webapps/base/api.py index 38eb01d382ce..703af9d31845 100644 --- a/lib/galaxy/webapps/base/api.py +++ b/lib/galaxy/webapps/base/api.py @@ -37,7 +37,6 @@ Send, ) -from galaxy.exceptions.error_codes import error_codes_by_int_code from galaxy.schema.schema import MessageExceptionModel log = getLogger(__name__) From 0a61db0bbef30b367abe74dd93669fc09b1f9fe4 Mon Sep 17 00:00:00 2001 From: Arash Kadkhodaei Date: Thu, 11 Jul 2024 15:04:07 +0200 Subject: [PATCH 16/17] Rename Client Error to Request Error Co-authored-by: Marius van den Beek --- lib/galaxy/webapps/base/api.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/galaxy/webapps/base/api.py b/lib/galaxy/webapps/base/api.py index 703af9d31845..b6d12d834014 100644 --- a/lib/galaxy/webapps/base/api.py +++ b/lib/galaxy/webapps/base/api.py @@ -239,7 +239,7 @@ def add_request_id_middleware(app: FastAPI): def include_all_package_routers(app: FastAPI, package_name: str): responses: typing.Dict[typing.Union[int, str], typing.Dict[str, typing.Any]] = { "4XX": { - "description": "Client Error", + "description": "Request Error", "model": MessageExceptionModel, }, "5XX": { From bd96b54570f7d91fa0361ca5afc719c12515ff62 Mon Sep 17 00:00:00 2001 From: Arash Date: Thu, 11 Jul 2024 15:14:18 +0200 Subject: [PATCH 17/17] updating schema for renaming Client Error to Request Error --- client/src/api/schema/schema.ts | 728 +++++++++--------- .../webapp/frontend/src/schema/schema.ts | 90 +-- 2 files changed, 409 insertions(+), 409 deletions(-) diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index e97e66099548..7a8a545e86e3 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -13416,7 +13416,7 @@ export interface operations { "application/json": components["schemas"]["APIKeyResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13458,7 +13458,7 @@ export interface operations { "application/json": Record; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13496,7 +13496,7 @@ export interface operations { }; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13530,7 +13530,7 @@ export interface operations { }[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13568,7 +13568,7 @@ export interface operations { }; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13602,7 +13602,7 @@ export interface operations { }[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13634,7 +13634,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13667,7 +13667,7 @@ export interface operations { "application/json": components["schemas"]["DCESummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13701,7 +13701,7 @@ export interface operations { "application/json": components["schemas"]["HDCADetailed"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13744,7 +13744,7 @@ export interface operations { "application/json": components["schemas"]["DatasetCollectionContentElements"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13783,7 +13783,7 @@ export interface operations { "application/json": components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13820,7 +13820,7 @@ export interface operations { "application/json": components["schemas"]["DatasetCollectionAttributesResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13856,7 +13856,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13891,7 +13891,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13933,7 +13933,7 @@ export interface operations { 501: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -13970,7 +13970,7 @@ export interface operations { "application/json": components["schemas"]["SuitableConverters"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14024,7 +14024,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14063,7 +14063,7 @@ export interface operations { "application/json": components["schemas"]["DeleteDatasetBatchResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14111,7 +14111,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14164,7 +14164,7 @@ export interface operations { | components["schemas"]["HDCASummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14234,7 +14234,7 @@ export interface operations { "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14268,7 +14268,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14304,7 +14304,7 @@ export interface operations { "application/json": components["schemas"]["ConvertedDatasetsMap"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14356,7 +14356,7 @@ export interface operations { | components["schemas"]["HDAInaccessible"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14389,7 +14389,7 @@ export interface operations { "application/json": components["schemas"]["DatasetExtraFiles"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14422,7 +14422,7 @@ export interface operations { "application/json": components["schemas"]["DatasetTextContentDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14464,7 +14464,7 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14501,7 +14501,7 @@ export interface operations { "application/json": components["schemas"]["DatasetInheritanceChain"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14541,7 +14541,7 @@ export interface operations { "application/json": (components["schemas"]["JobMetric"] | null)[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14579,7 +14579,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14622,7 +14622,7 @@ export interface operations { "application/json": components["schemas"]["JobDisplayParametersSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14663,7 +14663,7 @@ export interface operations { "application/json": components["schemas"]["DatasetAssociationRoles"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14700,7 +14700,7 @@ export interface operations { "application/json": components["schemas"]["DatasetStorageDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14748,7 +14748,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14798,7 +14798,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14833,7 +14833,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14870,7 +14870,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14904,7 +14904,7 @@ export interface operations { "application/json": components["schemas"]["DatatypeDetails"][] | string[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14930,7 +14930,7 @@ export interface operations { "application/json": components["schemas"]["DatatypeConverterList"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14958,7 +14958,7 @@ export interface operations { }; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -14985,7 +14985,7 @@ export interface operations { "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15013,7 +15013,7 @@ export interface operations { }; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15040,7 +15040,7 @@ export interface operations { "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15066,7 +15066,7 @@ export interface operations { "application/json": components["schemas"]["DatatypesMap"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15092,7 +15092,7 @@ export interface operations { "application/json": string[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15128,7 +15128,7 @@ export interface operations { "application/json": components["schemas"]["DatatypesCombinedMap"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15154,7 +15154,7 @@ export interface operations { "application/json": components["schemas"]["DisplayApplication"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15193,7 +15193,7 @@ export interface operations { "application/json": components["schemas"]["ReloadFeedback"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15224,7 +15224,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15253,7 +15253,7 @@ export interface operations { "application/json": components["schemas"]["UserFileSourceModel"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15287,7 +15287,7 @@ export interface operations { "application/json": components["schemas"]["UserFileSourceModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15321,7 +15321,7 @@ export interface operations { "application/json": components["schemas"]["PluginStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15354,7 +15354,7 @@ export interface operations { "application/json": components["schemas"]["UserFileSourceModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15395,7 +15395,7 @@ export interface operations { "application/json": components["schemas"]["UserFileSourceModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15426,7 +15426,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15455,7 +15455,7 @@ export interface operations { "application/json": components["schemas"]["FileSourceTemplateSummaries"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15515,7 +15515,7 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15553,7 +15553,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15589,7 +15589,7 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15630,7 +15630,7 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15671,7 +15671,7 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15711,7 +15711,7 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15752,7 +15752,7 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15801,7 +15801,7 @@ export interface operations { | components["schemas"]["LibraryAvailablePermissions"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15846,7 +15846,7 @@ export interface operations { "application/json": components["schemas"]["LibraryFolderCurrentPermissions"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15878,7 +15878,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15910,7 +15910,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -15967,7 +15967,7 @@ export interface operations { | components["schemas"]["ListJstreeResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16000,7 +16000,7 @@ export interface operations { "application/json": string[][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16047,7 +16047,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16086,7 +16086,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16131,7 +16131,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16160,7 +16160,7 @@ export interface operations { "application/json": components["schemas"]["GroupListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16194,7 +16194,7 @@ export interface operations { "application/json": components["schemas"]["GroupListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16226,7 +16226,7 @@ export interface operations { "application/json": components["schemas"]["GroupResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16263,7 +16263,7 @@ export interface operations { "application/json": components["schemas"]["GroupResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16295,7 +16295,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16327,7 +16327,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16360,7 +16360,7 @@ export interface operations { "application/json": components["schemas"]["GroupRoleListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16395,7 +16395,7 @@ export interface operations { "application/json": components["schemas"]["GroupRoleResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16430,7 +16430,7 @@ export interface operations { "application/json": components["schemas"]["GroupRoleResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16465,7 +16465,7 @@ export interface operations { "application/json": components["schemas"]["GroupRoleResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16497,7 +16497,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16535,7 +16535,7 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16574,7 +16574,7 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16613,7 +16613,7 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16650,7 +16650,7 @@ export interface operations { "application/json": components["schemas"]["GroupUserListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16688,7 +16688,7 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16727,7 +16727,7 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16766,7 +16766,7 @@ export interface operations { "application/json": components["schemas"]["GroupUserResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16804,7 +16804,7 @@ export interface operations { "application/json": components["schemas"]["HelpForumSearchResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16903,7 +16903,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -16950,7 +16950,7 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17000,7 +17000,7 @@ export interface operations { "application/json": unknown[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17045,7 +17045,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17089,7 +17089,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17118,7 +17118,7 @@ export interface operations { "application/json": number; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17169,7 +17169,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17211,7 +17211,7 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17254,7 +17254,7 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17288,7 +17288,7 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17326,7 +17326,7 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17375,7 +17375,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17424,7 +17424,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17466,7 +17466,7 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17513,7 +17513,7 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17561,7 +17561,7 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17615,7 +17615,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17664,7 +17664,7 @@ export interface operations { | components["schemas"]["HistorySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17697,7 +17697,7 @@ export interface operations { "application/json": unknown[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17784,7 +17784,7 @@ export interface operations { "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17834,7 +17834,7 @@ export interface operations { "application/json": components["schemas"]["HistoryContentsResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17898,7 +17898,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -17952,7 +17952,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18011,7 +18011,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18060,7 +18060,7 @@ export interface operations { "application/json": components["schemas"]["HistoryContentBulkOperationResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18097,7 +18097,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18132,7 +18132,7 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18175,7 +18175,7 @@ export interface operations { "application/json": components["schemas"]["DatasetAssociationRoles"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18224,7 +18224,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18275,7 +18275,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18310,7 +18310,7 @@ export interface operations { "application/json": components["schemas"]["DatasetExtraFiles"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18347,7 +18347,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18380,7 +18380,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18414,7 +18414,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18453,7 +18453,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18492,7 +18492,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18526,7 +18526,7 @@ export interface operations { "application/json": boolean; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18583,7 +18583,7 @@ export interface operations { | components["schemas"]["HDCASummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18641,7 +18641,7 @@ export interface operations { | components["schemas"]["HDCASummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18715,7 +18715,7 @@ export interface operations { "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18753,7 +18753,7 @@ export interface operations { "application/json": Record; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18843,7 +18843,7 @@ export interface operations { | components["schemas"]["HistoryContentsWithStatsResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18906,7 +18906,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -18962,7 +18962,7 @@ export interface operations { | components["schemas"]["HDCASummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19019,7 +19019,7 @@ export interface operations { | components["schemas"]["HDCASummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19093,7 +19093,7 @@ export interface operations { "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19141,7 +19141,7 @@ export interface operations { | components["schemas"]["WorkflowInvocationStateSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19183,7 +19183,7 @@ export interface operations { "application/json": components["schemas"]["AsyncFile"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19225,7 +19225,7 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19282,7 +19282,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19315,7 +19315,7 @@ export interface operations { "application/json": components["schemas"]["CustomBuildsMetadataResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19351,7 +19351,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19387,7 +19387,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19432,7 +19432,7 @@ export interface operations { "application/vnd.galaxy.task.export+json": components["schemas"]["ExportTaskListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19491,7 +19491,7 @@ export interface operations { 202: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19533,7 +19533,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19584,7 +19584,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19622,7 +19622,7 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19660,7 +19660,7 @@ export interface operations { "application/json": components["schemas"]["AsyncFile"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19696,7 +19696,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19737,7 +19737,7 @@ export interface operations { "application/json": components["schemas"]["ShareHistoryWithStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19773,7 +19773,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19812,7 +19812,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19844,7 +19844,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19877,7 +19877,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19915,7 +19915,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19953,7 +19953,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -19986,7 +19986,7 @@ export interface operations { "application/json": boolean; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20022,7 +20022,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20060,7 +20060,7 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20116,7 +20116,7 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20153,7 +20153,7 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20186,7 +20186,7 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20230,7 +20230,7 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20274,7 +20274,7 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20313,7 +20313,7 @@ export interface operations { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20351,7 +20351,7 @@ export interface operations { "application/json": components["schemas"]["AsyncFile"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20384,7 +20384,7 @@ export interface operations { "application/json": components["schemas"]["InvocationReport"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20415,7 +20415,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20458,7 +20458,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20496,7 +20496,7 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20536,7 +20536,7 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20574,7 +20574,7 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20606,7 +20606,7 @@ export interface operations { "application/json": components["schemas"]["JobLock"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20643,7 +20643,7 @@ export interface operations { "application/json": components["schemas"]["JobLock"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20745,7 +20745,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20784,7 +20784,7 @@ export interface operations { "application/json": components["schemas"]["EncodedJobDetails"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20823,7 +20823,7 @@ export interface operations { | components["schemas"]["EncodedJobDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20861,7 +20861,7 @@ export interface operations { "application/json": boolean; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20894,7 +20894,7 @@ export interface operations { "application/json": components["schemas"]["JobInputSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20927,7 +20927,7 @@ export interface operations { "application/json": components["schemas"]["JobDestinationParams"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20965,7 +20965,7 @@ export interface operations { "application/json": components["schemas"]["JobErrorSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -20998,7 +20998,7 @@ export interface operations { "application/json": components["schemas"]["JobInputAssociation"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21038,7 +21038,7 @@ export interface operations { "application/json": (components["schemas"]["JobMetric"] | null)[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21079,7 +21079,7 @@ export interface operations { "text/plain": string; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "text/plain": components["schemas"]["MessageExceptionModel"]; @@ -21112,7 +21112,7 @@ export interface operations { "application/json": components["schemas"]["JobOutputAssociation"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21157,7 +21157,7 @@ export interface operations { "application/json": components["schemas"]["JobDisplayParametersSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21190,7 +21190,7 @@ export interface operations { "application/json": components["schemas"]["JobOutputAssociation"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21226,7 +21226,7 @@ export interface operations { "application/json": components["schemas"]["LibrarySummaryList"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21263,7 +21263,7 @@ export interface operations { "application/json": components["schemas"]["LibrarySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21295,7 +21295,7 @@ export interface operations { "application/json": components["schemas"]["LibrarySummaryList"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21329,7 +21329,7 @@ export interface operations { "application/json": components["schemas"]["LibrarySummary"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21365,7 +21365,7 @@ export interface operations { "application/json": components["schemas"]["LibrarySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21411,7 +21411,7 @@ export interface operations { "application/json": components["schemas"]["LibrarySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21452,7 +21452,7 @@ export interface operations { "application/json": components["schemas"]["LibrarySummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21503,7 +21503,7 @@ export interface operations { | components["schemas"]["LibraryAvailablePermissions"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21552,7 +21552,7 @@ export interface operations { | components["schemas"]["LibraryCurrentPermissions"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21578,7 +21578,7 @@ export interface operations { "application/json": components["schemas"]["LicenseMetadataModel"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21611,7 +21611,7 @@ export interface operations { "application/json": components["schemas"]["LicenseMetadataModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21648,7 +21648,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21686,7 +21686,7 @@ export interface operations { "application/json": components["schemas"]["UserNotificationListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21720,7 +21720,7 @@ export interface operations { "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21759,7 +21759,7 @@ export interface operations { | components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21793,7 +21793,7 @@ export interface operations { "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21825,7 +21825,7 @@ export interface operations { "application/json": components["schemas"]["BroadcastNotificationListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21873,7 +21873,7 @@ export interface operations { "application/json": components["schemas"]["NotificationCreatedResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21909,7 +21909,7 @@ export interface operations { "application/json": components["schemas"]["BroadcastNotificationResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21948,7 +21948,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -21983,7 +21983,7 @@ export interface operations { "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22023,7 +22023,7 @@ export interface operations { "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22058,7 +22058,7 @@ export interface operations { "application/json": components["schemas"]["NotificationStatusSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22091,7 +22091,7 @@ export interface operations { "application/json": components["schemas"]["UserNotificationResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22127,7 +22127,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22165,7 +22165,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22194,7 +22194,7 @@ export interface operations { "application/json": components["schemas"]["UserConcreteObjectStoreModel"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22228,7 +22228,7 @@ export interface operations { "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22262,7 +22262,7 @@ export interface operations { "application/json": components["schemas"]["PluginStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22295,7 +22295,7 @@ export interface operations { "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22336,7 +22336,7 @@ export interface operations { "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22367,7 +22367,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22396,7 +22396,7 @@ export interface operations { "application/json": components["schemas"]["ObjectStoreTemplateSummaries"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22432,7 +22432,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22465,7 +22465,7 @@ export interface operations { "application/json": components["schemas"]["ConcreteObjectStoreModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22548,7 +22548,7 @@ export interface operations { "application/json": components["schemas"]["PageSummaryList"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22585,7 +22585,7 @@ export interface operations { "application/json": components["schemas"]["PageSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22621,7 +22621,7 @@ export interface operations { "application/json": components["schemas"]["PageDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22655,7 +22655,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22697,7 +22697,7 @@ export interface operations { 501: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22733,7 +22733,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22769,7 +22769,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22811,7 +22811,7 @@ export interface operations { 501: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22847,7 +22847,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22888,7 +22888,7 @@ export interface operations { "application/json": components["schemas"]["ShareWithStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22924,7 +22924,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22963,7 +22963,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -22997,7 +22997,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23033,7 +23033,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23065,7 +23065,7 @@ export interface operations { "application/json": components["schemas"]["QuotaSummaryList"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23102,7 +23102,7 @@ export interface operations { "application/json": components["schemas"]["CreateQuotaResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23134,7 +23134,7 @@ export interface operations { "application/json": components["schemas"]["QuotaSummaryList"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23170,7 +23170,7 @@ export interface operations { "application/json": components["schemas"]["QuotaDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23206,7 +23206,7 @@ export interface operations { "application/json": string; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23242,7 +23242,7 @@ export interface operations { "application/json": components["schemas"]["QuotaDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23283,7 +23283,7 @@ export interface operations { "application/json": string; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23324,7 +23324,7 @@ export interface operations { "application/json": string; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23357,7 +23357,7 @@ export interface operations { "application/json": string; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23413,7 +23413,7 @@ export interface operations { | components["schemas"]["ListJstreeResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23450,7 +23450,7 @@ export interface operations { "application/json": components["schemas"]["CreatedEntryResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23490,7 +23490,7 @@ export interface operations { "application/json": components["schemas"]["FilesSourcePluginList"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23519,7 +23519,7 @@ export interface operations { "application/json": components["schemas"]["RoleListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23553,7 +23553,7 @@ export interface operations { "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23585,7 +23585,7 @@ export interface operations { "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23617,7 +23617,7 @@ export interface operations { "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23649,7 +23649,7 @@ export interface operations { "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23681,7 +23681,7 @@ export interface operations { "application/json": components["schemas"]["RoleModelResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23711,7 +23711,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23739,7 +23739,7 @@ export interface operations { "application/json": boolean; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23776,7 +23776,7 @@ export interface operations { "application/json": components["schemas"]["StorageItemsCleanupResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23813,7 +23813,7 @@ export interface operations { "application/json": components["schemas"]["StoredItem"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23842,7 +23842,7 @@ export interface operations { "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23879,7 +23879,7 @@ export interface operations { "application/json": components["schemas"]["StorageItemsCleanupResult"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23916,7 +23916,7 @@ export interface operations { "application/json": components["schemas"]["StoredItem"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23945,7 +23945,7 @@ export interface operations { "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -23982,7 +23982,7 @@ export interface operations { "application/json": components["schemas"]["StoredItem"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24011,7 +24011,7 @@ export interface operations { "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24049,7 +24049,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24077,7 +24077,7 @@ export interface operations { "application/json": components["schemas"]["TaskState"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24103,7 +24103,7 @@ export interface operations { "application/json": components["schemas"]["ToolDataEntryList"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24140,7 +24140,7 @@ export interface operations { "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24176,7 +24176,7 @@ export interface operations { "application/json": components["schemas"]["ToolDataDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24217,7 +24217,7 @@ export interface operations { "application/json": components["schemas"]["ToolDataDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24255,7 +24255,7 @@ export interface operations { "application/json": components["schemas"]["ToolDataField"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24293,7 +24293,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24329,7 +24329,7 @@ export interface operations { "application/json": components["schemas"]["ToolDataDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24366,7 +24366,7 @@ export interface operations { "application/json": components["schemas"]["InstalledToolShedRepository"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24398,7 +24398,7 @@ export interface operations { "application/json": components["schemas"]["CheckForUpdatesResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24427,7 +24427,7 @@ export interface operations { "application/json": components["schemas"]["InstalledToolShedRepository"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24461,7 +24461,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24487,7 +24487,7 @@ export interface operations { "application/json": components["schemas"]["TourList"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24518,7 +24518,7 @@ export interface operations { "application/json": components["schemas"]["TourDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24553,7 +24553,7 @@ export interface operations { "application/json": components["schemas"]["TourDetails"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24598,7 +24598,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24634,7 +24634,7 @@ export interface operations { "application/json": components["schemas"]["CreatedUserModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24672,7 +24672,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24715,7 +24715,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24750,7 +24750,7 @@ export interface operations { | components["schemas"]["AnonUserModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24783,7 +24783,7 @@ export interface operations { "application/json": components["schemas"]["DetailedUserModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24822,7 +24822,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24861,7 +24861,7 @@ export interface operations { | components["schemas"]["AnonUserModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24903,7 +24903,7 @@ export interface operations { "application/json": components["schemas"]["DetailedUserModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24945,7 +24945,7 @@ export interface operations { "application/json": components["schemas"]["DetailedUserModel"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -24978,7 +24978,7 @@ export interface operations { "application/json": string; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25011,7 +25011,7 @@ export interface operations { "application/json": string; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25042,7 +25042,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25079,7 +25079,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25115,7 +25115,7 @@ export interface operations { "application/json": components["schemas"]["UserBeaconSetting"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25156,7 +25156,7 @@ export interface operations { "application/json": components["schemas"]["UserBeaconSetting"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25189,7 +25189,7 @@ export interface operations { "application/json": components["schemas"]["CustomBuildsCollection"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25229,7 +25229,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25264,7 +25264,7 @@ export interface operations { "application/json": components["schemas"]["DeletedCustomBuild"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25304,7 +25304,7 @@ export interface operations { "application/json": components["schemas"]["FavoriteObjectsSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25341,7 +25341,7 @@ export interface operations { "application/json": components["schemas"]["FavoriteObjectsSummary"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25374,7 +25374,7 @@ export interface operations { "application/json": components["schemas"]["UserObjectstoreUsage"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25411,7 +25411,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25444,7 +25444,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25479,7 +25479,7 @@ export interface operations { "application/json": string; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25512,7 +25512,7 @@ export interface operations { "application/json": components["schemas"]["UserQuotaUsage"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25547,7 +25547,7 @@ export interface operations { "application/json": components["schemas"]["UserQuotaUsage"] | null; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25573,7 +25573,7 @@ export interface operations { "application/json": Record; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25655,7 +25655,7 @@ export interface operations { "application/json": components["schemas"]["VisualizationSummaryList"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25691,7 +25691,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25727,7 +25727,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25763,7 +25763,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25804,7 +25804,7 @@ export interface operations { "application/json": components["schemas"]["ShareWithStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25840,7 +25840,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25879,7 +25879,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25915,7 +25915,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -25947,7 +25947,7 @@ export interface operations { "application/json": components["schemas"]["UserModel"] | null; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26037,7 +26037,7 @@ export interface operations { "application/json": Record[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26076,7 +26076,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26116,7 +26116,7 @@ export interface operations { "application/json": components["schemas"]["StoredWorkflowDetailed"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26149,7 +26149,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26186,7 +26186,7 @@ export interface operations { "application/json": components["schemas"]["RootModel_Dict_str__int__"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26222,7 +26222,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26258,7 +26258,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26315,7 +26315,7 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26355,7 +26355,7 @@ export interface operations { | components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26404,7 +26404,7 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26453,7 +26453,7 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26491,7 +26491,7 @@ export interface operations { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26529,7 +26529,7 @@ export interface operations { "application/json": components["schemas"]["InvocationReport"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26565,7 +26565,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26607,7 +26607,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26647,7 +26647,7 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26692,7 +26692,7 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26728,7 +26728,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26769,7 +26769,7 @@ export interface operations { "application/json": components["schemas"]["RefactorResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26810,7 +26810,7 @@ export interface operations { "application/json": components["schemas"]["ShareWithStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26846,7 +26846,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26885,7 +26885,7 @@ export interface operations { 204: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26917,7 +26917,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26950,7 +26950,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -26988,7 +26988,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27026,7 +27026,7 @@ export interface operations { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27059,7 +27059,7 @@ export interface operations { "application/json": boolean; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27092,7 +27092,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27128,7 +27128,7 @@ export interface operations { "application/json": components["schemas"]["SharingStatus"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27188,7 +27188,7 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27231,7 +27231,7 @@ export interface operations { | components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27281,7 +27281,7 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27331,7 +27331,7 @@ export interface operations { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27370,7 +27370,7 @@ export interface operations { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27409,7 +27409,7 @@ export interface operations { "application/json": components["schemas"]["InvocationReport"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27446,7 +27446,7 @@ export interface operations { 200: { content: never; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27489,7 +27489,7 @@ export interface operations { )[]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27530,7 +27530,7 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27576,7 +27576,7 @@ export interface operations { "application/json": components["schemas"]["InvocationStep"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27612,7 +27612,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27645,7 +27645,7 @@ export interface operations { "application/json": components["schemas"]["DrsObject"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27678,7 +27678,7 @@ export interface operations { "application/json": components["schemas"]["DrsObject"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27713,7 +27713,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27748,7 +27748,7 @@ export interface operations { "application/json": unknown; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; @@ -27771,7 +27771,7 @@ export interface operations { "application/json": components["schemas"]["Service"]; }; }; - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]; diff --git a/lib/tool_shed/webapp/frontend/src/schema/schema.ts b/lib/tool_shed/webapp/frontend/src/schema/schema.ts index f44d4b0b365e..af27cb9318fc 100644 --- a/lib/tool_shed/webapp/frontend/src/schema/schema.ts +++ b/lib/tool_shed/webapp/frontend/src/schema/schema.ts @@ -1045,7 +1045,7 @@ export interface operations { "application/json": components["schemas"]["APIKeyResponse"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1071,7 +1071,7 @@ export interface operations { "application/json": components["schemas"]["Category"][] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1102,7 +1102,7 @@ export interface operations { "application/json": components["schemas"]["Category"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1134,7 +1134,7 @@ export interface operations { "application/json": components["schemas"]["Category"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1172,7 +1172,7 @@ export interface operations { "application/json": components["schemas"]["RepositoriesByCategory"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1195,7 +1195,7 @@ export interface operations { "application/json": components["schemas"]["Service"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1218,7 +1218,7 @@ export interface operations { "application/json": components["schemas"]["ToolClass"][] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1241,7 +1241,7 @@ export interface operations { "application/json": unknown } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1270,7 +1270,7 @@ export interface operations { "application/json": components["schemas"]["Tool"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1299,7 +1299,7 @@ export interface operations { "application/json": components["schemas"]["ToolVersion"][] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1337,7 +1337,7 @@ export interface operations { | components["schemas"]["Repository"][] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1368,7 +1368,7 @@ export interface operations { "application/json": components["schemas"]["Repository"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1401,7 +1401,7 @@ export interface operations { "application/json": string[] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1437,7 +1437,7 @@ export interface operations { "application/json": unknown[] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1473,7 +1473,7 @@ export interface operations { "application/json": components["schemas"]["InstallInfo"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1499,7 +1499,7 @@ export interface operations { "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1530,7 +1530,7 @@ export interface operations { "application/json": unknown } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1559,7 +1559,7 @@ export interface operations { "application/json": components["schemas"]["DetailedRepository"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1588,7 +1588,7 @@ export interface operations { "application/json": string[] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1619,7 +1619,7 @@ export interface operations { "application/json": string[] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1650,7 +1650,7 @@ export interface operations { "application/json": string[] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1691,7 +1691,7 @@ export interface operations { "application/json": components["schemas"]["RepositoryUpdate"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1718,7 +1718,7 @@ export interface operations { 204: { content: never } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1745,7 +1745,7 @@ export interface operations { 204: { content: never } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1781,7 +1781,7 @@ export interface operations { "application/json": Record } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1810,7 +1810,7 @@ export interface operations { "application/json": components["schemas"]["RepositoryPermissions"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1842,7 +1842,7 @@ export interface operations { "application/json": components["schemas"]["ResetMetadataOnRepositoryResponse"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1871,7 +1871,7 @@ export interface operations { 204: { content: never } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1900,7 +1900,7 @@ export interface operations { 204: { content: never } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1934,7 +1934,7 @@ export interface operations { "application/json": components["schemas"]["RepositoryRevisionReadmes"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1964,7 +1964,7 @@ export interface operations { "application/json": unknown } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -1991,7 +1991,7 @@ export interface operations { "application/json": components["schemas"]["BuildSearchIndexResponse"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2017,7 +2017,7 @@ export interface operations { "application/json": components["schemas"]["UserV2"][] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2048,7 +2048,7 @@ export interface operations { "application/json": components["schemas"]["UserV2"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2074,7 +2074,7 @@ export interface operations { "application/json": components["schemas"]["UserV2"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2106,7 +2106,7 @@ export interface operations { "application/json": components["schemas"]["UserV2"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2135,7 +2135,7 @@ export interface operations { "application/json": string } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2164,7 +2164,7 @@ export interface operations { "application/json": string } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2191,7 +2191,7 @@ export interface operations { 204: { content: never } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2214,7 +2214,7 @@ export interface operations { "application/json": components["schemas"]["Version"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2243,7 +2243,7 @@ export interface operations { 204: { content: never } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2274,7 +2274,7 @@ export interface operations { "application/json": components["schemas"]["UiLoginResponse"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2305,7 +2305,7 @@ export interface operations { "application/json": components["schemas"]["UiLogoutResponse"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2336,7 +2336,7 @@ export interface operations { "application/json": components["schemas"]["UiRegisterResponse"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"] @@ -2372,7 +2372,7 @@ export interface operations { "application/json": components["schemas"]["RepositoryMetadata"] } } - /** @description Client Error */ + /** @description Request Error */ "4XX": { content: { "application/json": components["schemas"]["MessageExceptionModel"]