From 1fe7a96d8e21c5c497d0591ba84a3d1f547b57b1 Mon Sep 17 00:00:00 2001 From: Dannon Baker Date: Tue, 11 Jul 2023 12:09:53 +1000 Subject: [PATCH] Rebase, test get fetch args --- client/src/api/schema/client.ts | 18 + client/src/api/schema/index.ts | 1 + client/src/api/schema/schema.ts | 5235 ++++++++--------- client/src/components/admin/JobLock.vue | 8 +- .../webapp/frontend/src/schema/schema.ts | 328 +- 5 files changed, 2801 insertions(+), 2789 deletions(-) create mode 100644 client/src/api/schema/client.ts diff --git a/client/src/api/schema/client.ts b/client/src/api/schema/client.ts new file mode 100644 index 000000000000..4115b1667359 --- /dev/null +++ b/client/src/api/schema/client.ts @@ -0,0 +1,18 @@ +import createClient from "openapi-fetch"; + +import { getAppRoot } from "@/onload/loadConfig"; + +import { paths } from "./schema"; // generated from openapi-typescript + +export const { get, put } = createClient({ baseUrl: getAppRoot(undefined, true) }); + +// // Type-checked request +// await put("/blogposts", { +// body: { +// title: "My New Post", +// // ❌ Property 'publish_date' is missing in type … +// }, +// }); + +// // Type-checked response +// const { data, error } = await get("/blogposts/{post_id}", { params: { path: { post_id: "123" } } }); diff --git a/client/src/api/schema/index.ts b/client/src/api/schema/index.ts index d931cad37dd6..923bf9a108d9 100644 --- a/client/src/api/schema/index.ts +++ b/client/src/api/schema/index.ts @@ -1,2 +1,3 @@ +export { get, put } from "./client"; export { type ApiResponse, fetcher } from "./fetcher"; export type { components, operations, paths } from "./schema"; diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index 190abb1ad1ea..5c2c901f56ea 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -2140,7 +2140,7 @@ export interface components { /** Collection Type */ collection_type?: string | null; /** Default */ - default?: Record | null; + default?: unknown; /** Label */ label?: string | null; /** @@ -2199,7 +2199,7 @@ export interface components { * Quota percent * @description Percentage of the storage quota applicable to the user. */ - quota_percent?: Record; + quota_percent?: unknown; /** * Total disk usage * @description Size of all non-purged, unique datasets of the user in bytes. @@ -2525,29 +2525,29 @@ export interface components { * All Datasets * @default true */ - all_datasets?: Record; + all_datasets?: unknown; /** Archive File */ - archive_file?: Record; + archive_file?: unknown; /** Archive Source */ - archive_source?: Record; + archive_source?: unknown; /** * Archive Type * @default url */ - archive_type?: Record; + archive_type?: unknown; /** History Id */ - history_id?: Record; + history_id?: unknown; /** Name */ - name?: Record; + name?: unknown; }; /** Body_fetch_form_api_tools_fetch_post */ Body_fetch_form_api_tools_fetch_post: { /** Files */ files?: string[] | null; /** History Id */ - history_id: Record; + history_id: unknown; /** Targets */ - targets: Record; + targets: unknown; }; /** BroadcastNotificationContent */ BroadcastNotificationContent: { @@ -2718,7 +2718,7 @@ export interface components { * @description Whether this files source plugin allows write access. */ writable: boolean; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** BulkOperationItemError */ BulkOperationItemError: { @@ -2949,7 +2949,7 @@ export interface components { /** Info */ info?: string | null; /** Name */ - name?: string | number | number | boolean | null; + name?: string | number | boolean | null; /** * Space To Tab * @default false @@ -3193,7 +3193,7 @@ export interface components { * @default dataset */ type?: components["schemas"]["HistoryContentType"] | null; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** CreateHistoryFromStore */ CreateHistoryFromStore: { @@ -3387,7 +3387,7 @@ export interface components { * @description The name of the page. */ title: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** CreateQuotaParams */ CreateQuotaParams: { @@ -4075,7 +4075,7 @@ export interface components { * Transform * @description The transformations applied to the dataset source. */ - transform?: Record[] | null; + transform?: unknown[] | null; }; /** DatasetSourceId */ DatasetSourceId: { @@ -4554,12 +4554,12 @@ export interface components { * Quota in bytes * @description Quota applicable to the user in bytes. */ - quota_bytes: Record; + quota_bytes: unknown; /** * Quota percent * @description Percentage of the storage quota applicable to the user. */ - quota_percent?: Record; + quota_percent?: unknown; /** * Tags used * @description Tags used by the user @@ -4877,7 +4877,7 @@ export interface components { * Parameters * @description Object containing all the parameters of the tool associated with this job. The specific parameters depend on the tool itself. */ - params: Record; + params: unknown; /** * State * @description Current state of the job. @@ -5114,7 +5114,7 @@ export interface components { | components["schemas"]["HdcaDataItemsFromTarget"] | components["schemas"]["FtpImportTarget"] )[]; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** FileDataElement */ FileDataElement: { @@ -5152,7 +5152,7 @@ export interface components { /** Info */ info?: string | null; /** Name */ - name?: string | number | number | boolean | null; + name?: string | number | boolean | null; /** * Space To Tab * @default false @@ -5381,7 +5381,7 @@ export interface components { /** Info */ info?: string | null; /** Name */ - name?: string | number | number | boolean | null; + name?: string | number | boolean | null; /** * Space To Tab * @default false @@ -5702,7 +5702,7 @@ export interface components { * Metadata * @description The metadata associated with this dataset. */ - metadata?: Record | null; + metadata?: unknown; /** * Miscellaneous Blurb * @description TODO @@ -5803,7 +5803,7 @@ export interface components { * @description The collection of visualizations that can be applied to this dataset. */ visualizations?: components["schemas"]["Visualization"][] | null; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** * HDADetailed @@ -5950,7 +5950,7 @@ export interface components { * Metadata * @description The metadata associated with this dataset. */ - metadata?: Record | null; + metadata?: unknown; /** * Miscellaneous Blurb * @description TODO @@ -6092,7 +6092,7 @@ export interface components { state: components["schemas"]["DatasetState"]; /** Tags */ tags: string[]; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** * HDASummary @@ -6649,21 +6649,21 @@ export interface components { * @description Model for a category in the help forum. */ HelpForumCategory: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** * HelpForumGroup * @description Model for a group in the help forum. */ HelpForumGroup: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** * HelpForumGroupedSearchResult * @description Model for a grouped search result. */ HelpForumGroupedSearchResult: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** * HelpForumPost @@ -6715,7 +6715,7 @@ export interface components { * @description The username of the post author. */ username: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** * HelpForumSearchResponse @@ -6762,7 +6762,7 @@ export interface components { * @description Model for a tag in the help forum. */ HelpForumTag: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** * HelpForumTopic @@ -6773,7 +6773,7 @@ export interface components { * Archetype * @description The archetype of the topic. */ - archetype: Record; + archetype: unknown; /** * Archived * @description Whether the topic is archived. @@ -6868,7 +6868,7 @@ export interface components { * Tags Descriptions * @description The descriptions of the tags of the topic. */ - tags_descriptions?: Record | null; + tags_descriptions?: unknown; /** * Title * @description The title of the topic. @@ -6895,7 +6895,7 @@ export interface components { * @description Model for a user in the help forum. */ HelpForumUser: { - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** * HistoryActiveContentCounts @@ -7365,7 +7365,7 @@ export interface components { * Tool Inputs * @description TODO */ - tool_inputs?: Record; + tool_inputs?: unknown; /** * Tool Version * @description The version of the tool associated with this step. @@ -7408,7 +7408,7 @@ export interface components { * Tool Inputs * @description TODO */ - tool_inputs?: Record; + tool_inputs?: unknown; /** * Tool Version * @description The version of the tool associated with this step. @@ -7451,7 +7451,7 @@ export interface components { * Tool Inputs * @description TODO */ - tool_inputs?: Record; + tool_inputs?: unknown; /** * Tool Version * @description The version of the tool associated with this step. @@ -7806,7 +7806,7 @@ export interface components { * Parameter value * @description Value of the input parameter. */ - parameter_value: Record; + parameter_value: unknown; /** * Workflow step ID * @description The encoded ID of the workflow step associated with the input parameter. @@ -8248,7 +8248,7 @@ export interface components { * Effective Outputs * @description TODO */ - effective_outputs?: Record | null; + effective_outputs?: unknown; /** * History * @description The encoded history id - passed exactly like this 'hist_id=...' - into which to import. Or the name of the new history into which to import. @@ -8477,7 +8477,7 @@ export interface components { * @description ID assigned to submitted job by external job running system */ "Runner Job ID"?: string | null; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** JobDisplayParametersSummary */ JobDisplayParametersSummary: { @@ -8717,7 +8717,7 @@ export interface components { * Output label * @description The output label */ - label: Record; + label: unknown; /** * Dataset * @description The associated dataset. @@ -8758,13 +8758,7 @@ export interface components { * Value * @description The values of the job parameter */ - value?: - | components["schemas"]["EncodedJobParameterHistoryItem"][] - | number - | number - | boolean - | string - | null; + value?: components["schemas"]["EncodedJobParameterHistoryItem"][] | number | boolean | string | null; }; /** * JobSourceType @@ -9131,7 +9125,7 @@ export interface components { /** Folder Name */ folder_name: string; /** Full Path */ - full_path: unknown[][]; + full_path: [string, string][]; /** * Parent Library Id * @example 0123456789ABCDEF @@ -9428,7 +9422,7 @@ export interface components { * @deprecated * @default [] */ - ListJstreeResponse: Record[]; + ListJstreeResponse: unknown[]; /** * ListUriResponse * @default [] @@ -9574,7 +9568,7 @@ export interface components { /** Info */ info?: string | null; /** Name */ - name?: string | number | number | boolean | null; + name?: string | number | boolean | null; /** * Space To Tab * @default false @@ -10049,7 +10043,7 @@ export interface components { * @description The name of the user owning this Page. */ username: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** PageSummary */ PageSummary: { @@ -10167,12 +10161,12 @@ export interface components { /** Info */ info?: string | null; /** Name */ - name?: string | number | number | boolean | null; + name?: string | number | boolean | null; /** * Paste Content * @description Content to upload */ - paste_content: string | number | number | boolean; + paste_content: string | number | boolean; /** * Space To Tab * @default false @@ -10230,7 +10224,7 @@ export interface components { /** Link Data Only */ link_data_only?: boolean | null; /** Name */ - name?: string | number | number | boolean | null; + name?: string | number | boolean | null; /** Path */ path: string; /** @@ -10280,7 +10274,7 @@ export interface components { * Tool Inputs * @description TODO */ - tool_inputs?: Record; + tool_inputs?: unknown; /** * Tool Version * @description The version of the tool associated with this step. @@ -10896,7 +10890,7 @@ export interface components { * @description The tool ID related to the job. */ tool_id: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** ServerDirElement */ ServerDirElement: { @@ -10936,7 +10930,7 @@ export interface components { /** Link Data Only */ link_data_only?: boolean | null; /** Name */ - name?: string | number | number | boolean | null; + name?: string | number | boolean | null; /** Server Dir */ server_dir: string; /** @@ -11142,7 +11136,7 @@ export interface components { * User Identifiers * @description A collection of encoded IDs (or email addresses) of users that this resource will be shared with. */ - user_ids: (string | string)[]; + user_ids: string[]; }; /** ShareWithStatus */ ShareWithStatus: { @@ -11254,7 +11248,7 @@ export interface components { /** ShortTermStoreExportPayload */ ShortTermStoreExportPayload: { /** Duration */ - duration?: number | number | null; + duration?: number | null; /** * Include deleted * @description Include file contents for deleted datasets (if include_files is True). @@ -11311,7 +11305,7 @@ export interface components { * Job dependencies * @description The dependencies of the job. */ - dependencies?: Record[] | null; + dependencies?: unknown[] | null; /** * Exit Code * @description The exit code returned by the tool. Can be unset if the job is not completed yet. @@ -11354,7 +11348,7 @@ export interface components { * Job Messages * @description List with additional information and possible reasons for a failed job. */ - job_messages?: Record[] | null; + job_messages?: unknown[] | null; /** * Job Metrics * @description Collections of metrics provided by `JobInstrumenter` plugins on a particular job. Only administrators can see these metrics. @@ -11401,7 +11395,7 @@ export interface components { * Parameters * @description Object containing all the parameters of the tool associated with this job. The specific parameters depend on the tool itself. */ - params: Record; + params: unknown; /** * State * @description Current state of the job. @@ -11712,7 +11706,7 @@ export interface components { * Tool Inputs * @description TODO */ - tool_inputs?: Record; + tool_inputs?: unknown; /** * Tool Version * @description The version of the tool associated with this step. @@ -11904,7 +11898,7 @@ export interface components { * Tool Inputs * @description TODO */ - tool_inputs?: Record; + tool_inputs?: unknown; /** * Tool Version * @description The version of the tool associated with this step. @@ -12068,7 +12062,7 @@ export interface components { * @example 0123456789ABCDEF */ id: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** UpdateCreatorAction */ UpdateCreatorAction: { @@ -12079,7 +12073,7 @@ export interface components { */ action_type: "update_creator"; /** Creator */ - creator?: Record; + creator?: unknown; }; /** * UpdateHistoryContentsBatchPayload @@ -12100,7 +12094,7 @@ export interface components { * @description A list of content items to update with the changes. */ items: components["schemas"]["UpdateContentItem"][]; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** * UpdateHistoryContentsPayload @@ -12136,7 +12130,7 @@ export interface components { * @description Whether this item is visible in the history. */ visible?: boolean | null; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** UpdateLibraryFolderPayload */ UpdateLibraryFolderPayload: { @@ -12387,7 +12381,7 @@ export interface components { /** Info */ info?: string | null; /** Name */ - name?: string | number | number | boolean | null; + name?: string | number | boolean | null; /** * Space To Tab * @default false @@ -12728,7 +12722,7 @@ export interface components { * @description The name of the user owning this Visualization. */ username: string; - [key: string]: unknown | undefined; + [key: string]: unknown; }; /** * VisualizationSummaryList @@ -12751,7 +12745,7 @@ export interface components { * Value * @description TODO */ - value: Record | null; + value: unknown; }; /** WorkflowInvocationCollectionView */ WorkflowInvocationCollectionView: { @@ -12795,7 +12789,7 @@ export interface components { * UUID * @description Universal unique identifier of the workflow invocation. */ - uuid?: string | string | null; + uuid?: string | null; /** * Workflow ID * @description The encoded Workflow ID associated with the invocation. @@ -12900,7 +12894,7 @@ export interface components { * UUID * @description Universal unique identifier of the workflow invocation. */ - uuid?: string | string | null; + uuid?: string | null; /** * Workflow ID * @description The encoded Workflow ID associated with the invocation. @@ -13115,8 +13109,8 @@ export interface components { export type external = Record; export interface operations { + /** Returns returns an API key for authenticated user based on BaseAuth headers. */ get_api_key_api_authenticate_baseauth_get: { - /** Returns returns an API key for authenticated user based on BaseAuth headers. */ responses: { /** @description Successful Response */ 200: { @@ -13126,14 +13120,14 @@ export interface operations { }; }; }; + /** + * Gets given objects from a given cloud-based bucket to a Galaxy history. + * @deprecated + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -13157,14 +13151,14 @@ export interface operations { }; }; }; + /** + * Sends given dataset(s) in a given history to a given cloud-based bucket. + * @deprecated + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -13188,24 +13182,24 @@ export interface operations { }; }; }; + /** + * 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; + /** @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; }; }; @@ -13224,18 +13218,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 Encoded id to be decoded */ path: { + /** @description Encoded id to be decoded */ encoded_id: string; }; }; @@ -13256,14 +13250,14 @@ export interface operations { }; }; }; + /** + * 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; }; }; @@ -13284,18 +13278,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 Decoded id to be encoded */ path: { + /** @description Decoded id to be encoded */ decoded_id: number; }; }; @@ -13316,14 +13310,14 @@ export interface operations { }; }; }; + /** + * Return tool lineages for tools that have them + * @description Return tool lineages for tools that have them. + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -13344,14 +13338,14 @@ export interface operations { }; }; }; + /** + * Reload the Galaxy toolbox (but not individual tools) + * @description Reload the Galaxy toolbox (but not individual tools). + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -13359,7 +13353,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -13370,15 +13364,15 @@ export interface operations { }; }; }; + /** Content */ content_api_dataset_collection_element__dce_id__get: { - /** Content */ 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 encoded ID of the dataset collection element. */ path: { + /** @description The encoded ID of the dataset collection element. */ dce_id: string; }; }; @@ -13397,11 +13391,11 @@ export interface operations { }; }; }; + /** Create a new dataset collection instance. */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -13425,25 +13419,25 @@ export interface operations { }; }; }; + /** 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: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ - /** @description The maximum number of content elements to return. */ - /** @description The number of content elements that will be skipped before returning. */ 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; }; - /** @description The user ID 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 ID of the `HDCA`. */ - /** @description Parent collection ID describing what collection the contents belongs to. */ path: { + /** @description The ID of the `HDCA`. */ hdca_id: string; + /** @description Parent collection ID describing what collection the contents belongs to. */ parent_id: string; }; }; @@ -13462,21 +13456,21 @@ export interface operations { }; }; }; + /** Returns detailed information about the given collection. */ show_api_dataset_collections__id__get: { - /** Returns detailed information about the given collection. */ parameters: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ - /** @description The view of collection instance to return. */ 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 user ID 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 ID of the `HDCA`. */ path: { + /** @description The ID of the `HDCA`. */ id: string; }; }; @@ -13495,19 +13489,19 @@ export interface operations { }; }; }; + /** 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: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ query?: { + /** @description The type of collection instance. Either `history` (default) or `library`. */ instance_type?: "history" | "library"; }; - /** @description The user ID 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 ID of the `HDCA`. */ path: { + /** @description The ID of the `HDCA`. */ id: string; }; }; @@ -13526,15 +13520,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the `HDCA`. */ path: { + /** @description The ID of the `HDCA`. */ id: string; }; }; @@ -13547,7 +13541,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -13558,19 +13552,19 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the `HDCA`. */ path: { + /** @description The ID of the `HDCA`. */ id: string; }; }; @@ -13585,20 +13579,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the `HDCA`. */ path: { + /** @description The ID of the `HDCA`. */ id: string; }; }; @@ -13619,19 +13613,19 @@ export interface operations { 501: never; }; }; + /** Returns a list of applicable converters for all datatypes in the given collection. */ suitable_converters_api_dataset_collections__id__suitable_converters_get: { - /** Returns a list of applicable converters for all datatypes in the given collection. */ parameters: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ query?: { + /** @description The type of collection instance. Either `history` (default) or `library`. */ instance_type?: "history" | "library"; }; - /** @description The user ID 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 ID of the `HDCA`. */ path: { + /** @description The ID of the `HDCA`. */ id: string; }; }; @@ -13650,29 +13644,29 @@ export interface operations { }; }; }; + /** Search datasets or collections using a query system. */ 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. */ + 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; }; - /** @description The user ID 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; }; }; @@ -13697,16 +13691,16 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -13730,30 +13724,30 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The type of information about the dataset to be requested. */ - /** @description The type of information about the dataset to be requested. Each of these values may require additional parameters in the request and may return different responses. */ - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ query?: { + /** @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; }; - /** @description The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ dataset_id: string; }; }; @@ -13761,7 +13755,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -13772,24 +13766,24 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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; }; - /** @description The ID of the item (`HDA`/`HDCA`) */ path: { + /** @description The ID of the item (`HDA`/`HDCA`) */ dataset_id: string; }; }; @@ -13818,41 +13812,41 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ query?: { + /** + * @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 The user ID 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 ID of the item (`HDA`/`HDCA`) */ path: { + /** @description The ID of the item (`HDA`/`HDCA`) */ dataset_id: string; }; }; @@ -13882,15 +13876,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ dataset_id: string; content_type: components["schemas"]["DatasetContentType"]; }; @@ -13899,7 +13893,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -13910,18 +13904,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ dataset_id: string; }; }; @@ -13940,30 +13934,30 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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; }; - /** @description The ID of the History Dataset. */ - /** @description File extension of the new format to convert this dataset to. */ 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; }; }; @@ -13985,15 +13979,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the dataset. */ path: { + /** @description The encoded database identifier of the dataset. */ dataset_id: string; }; }; @@ -14012,15 +14006,15 @@ export interface operations { }; }; }; + /** Returns dataset content as Text. */ get_content_as_text_api_datasets__dataset_id__get_content_as_text_get: { - /** Returns dataset content as Text. */ 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ dataset_id: string; }; }; @@ -14039,19 +14033,19 @@ export interface operations { }; }; }; + /** 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: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ hda_ldda?: components["schemas"]["DatasetSourceType"]; }; - /** @description The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ dataset_id: string; }; }; @@ -14075,19 +14069,19 @@ export interface operations { }; }; }; + /** 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: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ hda_ldda?: components["schemas"]["DatasetSourceType"]; }; - /** @description The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ dataset_id: string; }; }; @@ -14106,22 +14100,22 @@ export interface operations { }; }; }; + /** + * Return job metrics for specified job. + * @deprecated + */ get_metrics_api_datasets__dataset_id__metrics_get: { - /** - * Return job metrics for specified job. - * @deprecated - */ parameters: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ hda_ldda?: components["schemas"]["DatasetSourceType"]; }; - /** @description The user ID 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 ID of the dataset */ path: { + /** @description The ID of the dataset */ dataset_id: string; }; }; @@ -14140,15 +14134,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ dataset_id: string; }; }; @@ -14161,7 +14155,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -14172,25 +14166,25 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ hda_ldda?: components["schemas"]["DatasetSourceType"]; }; - /** @description The user ID 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 ID of the dataset */ path: { + /** @description The ID of the dataset */ dataset_id: string; }; }; @@ -14209,18 +14203,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ dataset_id: string; }; }; @@ -14244,19 +14238,19 @@ export interface operations { }; }; }; + /** 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: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ hda_ldda?: components["schemas"]["DatasetSourceType"]; }; - /** @description The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ dataset_id: string; }; }; @@ -14275,32 +14269,32 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - /** @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. */ - /** @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. */ - /** @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. */ 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 The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ history_content_id: string; }; }; @@ -14315,32 +14309,32 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - /** @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. */ - /** @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. */ - /** @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. */ 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 The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ history_content_id: string; }; }; @@ -14348,7 +14342,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -14359,19 +14353,19 @@ export interface operations { }; }; }; + /** Returns the metadata file associated with this history item. */ datasets__get_metadata_file: { - /** Returns the metadata file associated with this history item. */ parameters: { - /** @description The name of the metadata file to retrieve. */ query: { + /** @description The name of the metadata file to retrieve. */ metadata_file: string; }; - /** @description The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ history_content_id: string; }; }; @@ -14386,19 +14380,19 @@ export interface operations { }; }; }; + /** 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: { - /** @description The name of the metadata file to retrieve. */ query: { + /** @description The name of the metadata file to retrieve. */ metadata_file: string; }; - /** @description The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ history_content_id: string; }; }; @@ -14406,7 +14400,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -14417,16 +14411,16 @@ export interface operations { }; }; }; + /** + * Lists all available data types + * @description Gets the list of all available data types. + */ 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 */ + 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; }; }; @@ -14445,11 +14439,11 @@ export interface operations { }; }; }; + /** + * 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: { @@ -14459,11 +14453,11 @@ export interface operations { }; }; }; + /** + * 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: { @@ -14475,12 +14469,12 @@ export interface operations { }; }; }; + /** + * 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: { @@ -14490,11 +14484,11 @@ export interface operations { }; }; }; + /** + * 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: { @@ -14506,12 +14500,12 @@ export interface operations { }; }; }; + /** + * 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: { @@ -14521,11 +14515,11 @@ export interface operations { }; }; }; + /** + * 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: { @@ -14535,11 +14529,11 @@ export interface operations { }; }; }; + /** + * 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: { @@ -14549,18 +14543,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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 */ + 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; }; }; @@ -14579,11 +14573,11 @@ export interface operations { }; }; }; + /** + * 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: { @@ -14593,14 +14587,14 @@ export interface operations { }; }; }; + /** + * Reloads the list of display applications. + * @description Reloads the list of display applications. + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -14626,15 +14620,15 @@ export interface operations { }; }; }; + /** Download */ download_api_drs_download__object_id__get: { - /** Download */ 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 ID of the group */ path: { + /** @description The ID of the group */ object_id: string; }; }; @@ -14649,42 +14643,42 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Maximum number of contents to return. */ - /** @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. */ - /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ - /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ - /** @description Sort results by specified field. */ - /** @description Sort results in descending order. */ 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 The user ID 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 encoded identifier of the library folder. */ path: { + /** @description The encoded identifier of the library folder. */ folder_id: string; }; }; @@ -14703,15 +14697,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded identifier of the library folder. */ path: { + /** @description The encoded identifier of the library folder. */ folder_id: string; }; }; @@ -14724,7 +14718,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -14735,18 +14729,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded identifier of the library folder. */ path: { + /** @description The encoded identifier of the library folder. */ id: string; }; }; @@ -14765,18 +14759,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded identifier of the library folder. */ path: { + /** @description The encoded identifier of the library folder. */ id: string; }; }; @@ -14800,18 +14794,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded identifier of the library folder. */ path: { + /** @description The encoded identifier of the library folder. */ id: string; }; }; @@ -14835,22 +14829,22 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Whether to restore a deleted library folder. */ query?: { + /** @description Whether to restore a deleted library folder. */ undelete?: 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; }; - /** @description The encoded identifier of the library folder. */ path: { + /** @description The encoded identifier of the library folder. */ id: string; }; }; @@ -14869,18 +14863,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded identifier of the library folder. */ path: { + /** @description The encoded identifier of the library folder. */ id: string; }; }; @@ -14904,29 +14898,29 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ - /** @description The page number to retrieve when paginating the available roles. */ - /** @description The maximum number of permissions per page when paginating. */ - /** @description Optional search text to retrieve only the roles matching this query. */ 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 The user ID 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 encoded identifier of the library folder. */ path: { + /** @description The encoded identifier of the library folder. */ id: string; }; }; @@ -14947,22 +14941,22 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ query?: { + /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ action?: components["schemas"]["LibraryFolderPermissionAction"] | 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; }; - /** @description The encoded identifier of the library folder. */ path: { + /** @description The encoded identifier of the library folder. */ id: string; }; }; @@ -14986,11 +14980,11 @@ export interface operations { }; }; }; + /** Delete */ delete_api_forms__id__delete: { - /** Delete */ 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: { @@ -15001,7 +14995,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -15012,11 +15006,11 @@ export interface operations { }; }; }; + /** Undelete */ undelete_api_forms__id__undelete_post: { - /** Undelete */ 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: { @@ -15027,7 +15021,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -15038,27 +15032,27 @@ 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. + */ 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. */ + 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 The user ID 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; }; }; @@ -15079,15 +15073,15 @@ export interface operations { }; }; }; + /** Return a list of installed genomes */ index_api_genomes_get: { - /** Return a list of installed genomes */ - parameters?: { - /** @description If true, return genome keys with chromosome lengths */ + parameters: { 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; }; }; @@ -15106,29 +15100,29 @@ export interface operations { }; }; }; + /** Return information about build */ show_api_genomes__id__get: { - /** Return information about build */ parameters: { - /** @description If true, return reference data */ - /** @description Limits size of returned data */ - /** @description Limits size of returned data */ - /** @description Limits size of returned data */ - /** @description Limits size of returned data */ - /** @description Format */ 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 user ID 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 Genome ID */ path: { + /** @description Genome ID */ id: string; }; }; @@ -15136,7 +15130,7 @@ export interface operations { /** @description Information about genome build */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -15147,21 +15141,21 @@ export interface operations { }; }; }; + /** 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: { - /** @description Index type */ - /** @description Format */ query?: { + /** @description Index type */ type?: string; + /** @description Format */ format?: string; }; - /** @description The user ID 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 Genome ID */ path: { + /** @description Genome ID */ id: string; }; }; @@ -15169,7 +15163,7 @@ export interface operations { /** @description Indexes for a genome id for provided type */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -15180,27 +15174,27 @@ export interface operations { }; }; }; + /** Return raw sequence data */ sequences_api_genomes__id__sequences_get: { - /** Return raw sequence data */ parameters: { - /** @description If true, return reference data */ - /** @description Limits size of returned data */ - /** @description Limits size of returned data */ - /** @description Limits size of returned data */ - /** @description Format */ 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; }; - /** @description The user ID 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 Genome ID */ path: { + /** @description Genome ID */ id: string; }; }; @@ -15208,7 +15202,7 @@ export interface operations { /** @description Raw sequence data */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -15219,11 +15213,11 @@ export interface operations { }; }; }; + /** Displays a collection (list) of groups. */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -15242,11 +15236,11 @@ export interface operations { }; }; }; + /** Creates a new group. */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -15270,11 +15264,11 @@ export interface operations { }; }; }; + /** Displays information about a group. */ show_group_api_groups__group_id__get: { - /** Displays information about a 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; }; path: { @@ -15296,11 +15290,11 @@ export interface operations { }; }; }; + /** Modifies a group. */ update_api_groups__group_id__put: { - /** Modifies a 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; }; path: { @@ -15327,11 +15321,11 @@ export interface operations { }; }; }; + /** Delete */ delete_api_groups__group_id__delete: { - /** Delete */ 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: { @@ -15342,7 +15336,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -15353,11 +15347,11 @@ export interface operations { }; }; }; + /** Purge */ purge_api_groups__group_id__purge_post: { - /** Purge */ 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: { @@ -15368,7 +15362,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -15379,15 +15373,15 @@ export interface operations { }; }; }; + /** Displays a collection (list) of groups. */ group_roles_api_groups__group_id__roles_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 The ID of the group. */ path: { + /** @description The ID of the group. */ group_id: string; }; }; @@ -15406,17 +15400,17 @@ export interface operations { }; }; }; + /** Displays information about a group role. */ group_role_api_groups__group_id__roles__role_id__get: { - /** Displays information about a group role. */ 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 ID of the group. */ - /** @description The ID of the role. */ path: { + /** @description The ID of the group. */ group_id: string; + /** @description The ID of the role. */ role_id: string; }; }; @@ -15435,17 +15429,17 @@ export interface operations { }; }; }; + /** Adds a role to a group */ update_api_groups__group_id__roles__role_id__put: { - /** Adds a role to a 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 The ID of the group. */ - /** @description The ID of the role. */ path: { + /** @description The ID of the group. */ group_id: string; + /** @description The ID of the role. */ role_id: string; }; }; @@ -15464,17 +15458,17 @@ export interface operations { }; }; }; + /** Removes a role from a group */ delete_api_groups__group_id__roles__role_id__delete: { - /** Removes a role from a 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 The ID of the group. */ - /** @description The ID of the role. */ path: { + /** @description The ID of the group. */ group_id: string; + /** @description The ID of the role. */ role_id: string; }; }; @@ -15493,11 +15487,11 @@ export interface operations { }; }; }; + /** Undelete */ undelete_api_groups__group_id__undelete_post: { - /** Undelete */ 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: { @@ -15508,7 +15502,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -15519,20 +15513,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the group. */ - /** @description The ID of the user. */ path: { + /** @description The ID of the group. */ group_id: string; + /** @description The ID of the user. */ user_id: string; }; }; @@ -15551,21 +15545,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the group. */ - /** @description The ID of the user. */ path: { + /** @description The ID of the group. */ group_id: string; + /** @description The ID of the user. */ user_id: string; }; }; @@ -15584,21 +15578,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the group. */ - /** @description The ID of the user. */ path: { + /** @description The ID of the group. */ group_id: string; + /** @description The ID of the user. */ user_id: string; }; }; @@ -15617,19 +15611,19 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the group. */ path: { + /** @description The ID of the group. */ group_id: string; }; }; @@ -15648,20 +15642,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the group. */ - /** @description The ID of the user. */ path: { + /** @description The ID of the group. */ group_id: string; + /** @description The ID of the user. */ user_id: string; }; }; @@ -15680,21 +15674,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the group. */ - /** @description The ID of the user. */ path: { + /** @description The ID of the group. */ group_id: string; + /** @description The ID of the user. */ user_id: string; }; }; @@ -15713,21 +15707,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the group. */ - /** @description The ID of the user. */ path: { + /** @description The ID of the group. */ group_id: string; + /** @description The ID of the user. */ user_id: string; }; }; @@ -15746,20 +15740,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Search query to use for searching the Galaxy Help forum. */ query: { + /** @description Search query to use for searching the Galaxy Help forum. */ query: string; }; - /** @description The user ID 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; }; }; @@ -15778,77 +15772,77 @@ export interface operations { }; }; }; + /** Returns histories available to the current user. */ 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 */ + 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 The user ID 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; }; }; @@ -15871,20 +15865,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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 */ + 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 The user ID 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; }; }; @@ -15912,32 +15906,32 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + 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; }; - /** @description The user ID 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; }; }; @@ -15945,11 +15939,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": ( - | components["schemas"]["ArchivedHistorySummary"] - | components["schemas"]["ArchivedHistoryDetailed"] - | Record - )[]; + "application/json": unknown[]; }; }; /** @description Validation Error */ @@ -15960,18 +15950,18 @@ export interface operations { }; }; }; + /** Marks several histories with the given IDs as deleted. */ 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 */ + 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 user ID 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; }; }; @@ -15999,17 +15989,17 @@ export interface operations { }; }; }; + /** Marks several histories with the given IDs as undeleted. */ 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 */ + 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 The user ID 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; }; }; @@ -16037,11 +16027,11 @@ export interface operations { }; }; }; + /** Returns number of histories for the current user. */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -16060,29 +16050,29 @@ export interface operations { }; }; }; + /** Returns deleted histories for the current user. */ 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 */ + 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 The user ID 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; }; }; @@ -16105,21 +16095,21 @@ export interface operations { }; }; }; + /** 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: { - /** @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; }; - /** @description The encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16141,17 +16131,17 @@ export interface operations { }; }; }; + /** Create histories from a model store. */ 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 */ + 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 The user ID 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; }; }; @@ -16178,11 +16168,11 @@ export interface operations { }; }; }; + /** Launch a task to create histories from a model store. */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -16206,17 +16196,17 @@ export interface operations { }; }; }; + /** Returns the most recently used history of the user. */ 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 */ + 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 The user ID 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; }; }; @@ -16238,27 +16228,27 @@ export interface operations { }; }; }; + /** Return all histories that are published. */ 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 */ + 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; }; - /** @description The user ID 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; }; }; @@ -16281,27 +16271,27 @@ export interface operations { }; }; }; + /** Return all histories that are shared with the current user. */ 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 */ + 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; }; - /** @description The user ID 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; }; }; @@ -16324,21 +16314,21 @@ export interface operations { }; }; }; + /** Returns the history with the given ID. */ history_api_histories__history_id__get: { - /** Returns the history with the given ID. */ parameters: { - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ query?: { + /** @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; }; - /** @description The encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16360,27 +16350,27 @@ export interface operations { }; }; }; + /** 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: { - /** @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; }; - /** @description The encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; requestBody: { content: { - "application/json": Record; + "application/json": unknown; }; }; responses: { @@ -16401,22 +16391,22 @@ export interface operations { }; }; }; + /** 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: { - /** @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 The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16443,31 +16433,31 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16480,10 +16470,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": - | components["schemas"]["ArchivedHistorySummary"] - | components["schemas"]["ArchivedHistoryDetailed"] - | Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -16494,28 +16481,28 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description If true, the history will be un-archived even if it has an associated archive export record and was purged. */ 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 The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16537,15 +16524,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16553,7 +16540,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record[]; + "application/json": unknown[]; }; }; /** @description Validation Error */ @@ -16564,68 +16551,68 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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.** */ - /** - * @deprecated - * @description Legacy name for the `dataset_details` parameter. - */ - /** - * @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. - */ - /** - * @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. - */ - /** - * @deprecated - * @description Whether to return deleted or undeleted datasets only. Leave unset for both. - */ - /** - * @deprecated - * @description Whether to return visible or hidden datasets only. Leave unset for both. - */ - /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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 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 The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16645,27 +16632,27 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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; }; - /** @description The encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16689,27 +16676,27 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The type of the target history element. */ - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ query?: { + /** @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 The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16745,36 +16732,36 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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: { - /** @description The name that the Archive will have (defaults to history name). */ - /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ - /** @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 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 The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16782,7 +16769,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -16793,41 +16780,41 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ - /** @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 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 The user ID 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 encoded database identifier of the History. */ - /** @description The name that the Archive will have (defaults to history name). */ - /** - * @deprecated - * @description Output format of the archive. - */ 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; }; }; @@ -16835,7 +16822,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -16846,26 +16833,26 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ 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 The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -16889,21 +16876,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the `HDCA`. */ - /** @description The encoded database identifier of the History. */ path: { + /** @description The ID of the `HDCA`. */ id: string; + /** @description The encoded database identifier of the History. */ history_id: string | null; }; }; @@ -16918,17 +16905,17 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the item (`HDA`/`HDCA`) */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ id: string; }; }; @@ -16947,20 +16934,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the item (`HDA`/`HDCA`) */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ dataset_id: string; }; }; @@ -16984,32 +16971,32 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - /** @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. */ - /** @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. */ - /** @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. */ 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 The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ history_content_id: string; history_id: string | null; }; @@ -17025,32 +17012,32 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - /** @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. */ - /** @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. */ - /** @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. */ 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 The user ID 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 ID of the History Dataset. */ path: { + /** @description The ID of the History Dataset. */ history_content_id: string; history_id: string | null; }; @@ -17059,7 +17046,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -17070,17 +17057,17 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the History Dataset. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the History Dataset. */ history_content_id: string; }; }; @@ -17099,21 +17086,21 @@ export interface operations { }; }; }; + /** Returns the metadata file associated with this history item. */ history_contents__get_metadata_file: { - /** Returns the metadata file associated with this history item. */ parameters: { - /** @description The name of the metadata file to retrieve. */ query: { + /** @description The name of the metadata file to retrieve. */ metadata_file: string; }; - /** @description The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the History Dataset. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the History Dataset. */ history_content_id: string; }; }; @@ -17128,11 +17115,11 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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: { @@ -17155,11 +17142,11 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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: { @@ -17183,11 +17170,11 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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: { @@ -17216,11 +17203,11 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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: { @@ -17249,11 +17236,11 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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: { @@ -17277,33 +17264,33 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The type of the target history element. */ - /** @description This value can be used to broadly restrict the magnitude of the number of elements returned via the API for large collections. The number of actual elements returned may be "a bit" more than this number or "a lot" less - varying on the depth of nesting, balance of nesting at each level, and size of target collection. The consumer of this API should not expect a stable number or pre-calculable number of elements to be produced given this parameter - the only promise is that this API will not respond with an order of magnitude more elements estimated with this value. The UI uses this parameter to fetch a "balanced" concept of the "start" of large collections at every depth of the collection. */ - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ query?: { + /** @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 The user ID 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 ID of the item (`HDA`/`HDCA`) */ - /** @description The encoded database identifier of the History. */ path: { + /** @description The ID of the item (`HDA`/`HDCA`) */ id: string; + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -17327,29 +17314,29 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The type of the target history element. */ - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ query?: { + /** @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 The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the item (`HDA`/`HDCA`) */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ id: string; }; }; @@ -17378,45 +17365,45 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The type of the target history element. */ - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ query?: { + /** @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 The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the item (`HDA`/`HDCA`) */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ id: string; }; }; @@ -17446,20 +17433,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the item (`HDA`/`HDCA`) */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ id: string; }; }; @@ -17478,70 +17465,70 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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.** */ - /** - * @deprecated - * @description Legacy name for the `dataset_details` parameter. - */ - /** - * @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. - */ - /** - * @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. - */ - /** - * @deprecated - * @description Whether to return deleted or undeleted datasets only. Leave unset for both. - */ - /** - * @deprecated - * @description Whether to return visible or hidden datasets only. Leave unset for both. - */ - /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - /** @description The value to filter by. */ - /** @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 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 The user ID 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 encoded database identifier of the History. */ - /** @description The type of the target history element. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The type of the target history element. */ type: components["schemas"]["HistoryContentType"]; }; }; @@ -17562,26 +17549,26 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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; }; - /** @description The encoded database identifier of the History. */ - /** @description The type of the target history element. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The type of the target history element. */ type: components["schemas"]["HistoryContentType"]; }; }; @@ -17617,32 +17604,32 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description This value can be used to broadly restrict the magnitude of the number of elements returned via the API for large collections. The number of actual elements returned may be "a bit" more than this number or "a lot" less - varying on the depth of nesting, balance of nesting at each level, and size of target collection. The consumer of this API should not expect a stable number or pre-calculable number of elements to be produced given this parameter - the only promise is that this API will not respond with an order of magnitude more elements estimated with this value. The UI uses this parameter to fetch a "balanced" concept of the "start" of large collections at every depth of the collection. */ - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ query?: { + /** @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 The user ID 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 ID of the item (`HDA`/`HDCA`) */ - /** @description The encoded database identifier of the History. */ - /** @description The type of the target history element. */ 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"]; }; }; @@ -17666,28 +17653,28 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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; }; - /** @description The encoded database identifier of the History. */ - /** @description The ID of the item (`HDA`/`HDCA`) */ - /** @description The type of the target history element. */ 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"]; }; }; @@ -17716,45 +17703,45 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - /** @description View to be passed to the serializer */ - /** @description Comma-separated list of keys to be passed to the serializer */ query?: { + /** + * @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 The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the item (`HDA`/`HDCA`) */ - /** @description The type of the target history element. */ 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"]; }; }; @@ -17784,27 +17771,27 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the item (`HDA`/`HDCA`) */ - /** @description The type of the target history element. */ 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"]; }; }; @@ -17826,19 +17813,19 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the item (`HDA`/`HDCA`) */ - /** @description The type of the target history element. */ 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"]; }; }; @@ -17862,19 +17849,19 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the item (`HDA`/`HDCA`) */ - /** @description The type of the target history element. */ 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"]; }; }; @@ -17898,27 +17885,27 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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; }; - /** @description The encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -17948,15 +17935,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -17975,18 +17962,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18005,18 +17992,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18035,26 +18022,26 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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 */ 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 The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18074,30 +18061,30 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18125,26 +18112,26 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ - /** @description The ID of the specific Job Export History Association or `latest` (default) to download the last generated archive. */ 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"; }; }; @@ -18159,29 +18146,29 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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. */ - /** @description A comma-separated list of type of object represented by elements in the `ids` array - any of `Job`, `ImplicitCollectionJob`, or `WorkflowInvocation`. */ 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; }; - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18204,15 +18191,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18236,15 +18223,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18268,18 +18255,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18298,18 +18285,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18333,18 +18320,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18363,18 +18350,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18394,11 +18381,11 @@ export interface operations { }; }; }; + /** Show tags based on history_id */ index_api_histories__history_id__tags_get: { - /** Show tags based on history_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. */ header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { @@ -18420,11 +18407,11 @@ export interface operations { }; }; }; + /** Show tag based on history_id */ show_api_histories__history_id__tags__tag_name__get: { - /** Show tag based on history_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. */ header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { @@ -18447,11 +18434,11 @@ export interface operations { }; }; }; + /** Update tag based on history_id */ update_api_histories__history_id__tags__tag_name__put: { - /** Update tag based on history_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. */ header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { @@ -18479,11 +18466,11 @@ export interface operations { }; }; }; + /** Create tag based on history_id */ create_api_histories__history_id__tags__tag_name__post: { - /** Create tag based on history_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. */ header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { @@ -18511,11 +18498,11 @@ export interface operations { }; }; }; + /** Delete tag based on history_id */ delete_api_histories__history_id__tags__tag_name__delete: { - /** Delete tag based on history_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. */ header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { @@ -18538,18 +18525,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18568,15 +18555,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the History. */ path: { + /** @description The encoded database identifier of the History. */ history_id: string; }; }; @@ -18600,38 +18587,38 @@ export interface operations { }; }; }; + /** Get the list of a user's workflow invocations. */ 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. */ + 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; }; - /** @description The user ID 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; }; }; @@ -18650,14 +18637,14 @@ export interface operations { }; }; }; + /** + * Create Invocations From Store + * @description Create invocation(s) from a supplied model store. + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -18681,15 +18668,15 @@ export interface operations { }; }; }; + /** Show details of workflow invocation step. */ step_api_invocations_steps__step_id__get: { - /** Show details of workflow invocation step. */ 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 encoded database identifier of the WorkflowInvocationStep. */ path: { + /** @description The encoded database identifier of the WorkflowInvocationStep. */ step_id: string; }; }; @@ -18708,26 +18695,26 @@ export interface operations { }; }; }; + /** Get detailed description of a workflow invocation. */ show_invocation_api_invocations__invocation_id__get: { - /** Get detailed description of a workflow invocation. */ parameters: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - /** - * @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. - */ 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 The user ID 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 encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -18746,26 +18733,26 @@ export interface operations { }; }; }; + /** Cancel the specified workflow invocation. */ cancel_invocation_api_invocations__invocation_id__delete: { - /** Cancel the specified workflow invocation. */ parameters: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - /** - * @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. - */ 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 The user ID 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 encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -18784,37 +18771,37 @@ export interface operations { }; }; }; + /** + * Return a BioCompute Object for the workflow invocation. + * @deprecated + * @description The BioCompute Object endpoints are in beta - important details such + * as how inputs and outputs are represented, how the workflow is encoded, + * and how author and version information is encoded, and how URLs are + * generated will very likely change in important ways over time. + * + * **Deprecation Notice**: please use the asynchronous short_term_storage export system instead. + * + * 1. call POST `api/invocations/{id}/prepare_store_download` with payload: + * ``` + * { + * model_store_format: bco.json + * } + * ``` + * 2. Get `storageRequestId` from response and poll GET `api/short_term_storage/${storageRequestId}/ready` until `SUCCESS` + * + * 3. Get the resulting file with `api/short_term_storage/${storageRequestId}` + */ export_invocation_bco_api_invocations__invocation_id__biocompute_get: { - /** - * Return a BioCompute Object for the workflow invocation. - * @deprecated - * @description The BioCompute Object endpoints are in beta - important details such - * as how inputs and outputs are represented, how the workflow is encoded, - * and how author and version information is encoded, and how URLs are - * generated will very likely change in important ways over time. - * - * **Deprecation Notice**: please use the asynchronous short_term_storage export system instead. - * - * 1. call POST `api/invocations/{id}/prepare_store_download` with payload: - * ``` - * { - * model_store_format: bco.json - * } - * ``` - * 2. Get `storageRequestId` from response and poll GET `api/short_term_storage/${storageRequestId}/ready` until `SUCCESS` - * - * 3. Get the resulting file with `api/short_term_storage/${storageRequestId}` - */ parameters: { query?: { merge_history_metadata?: 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; }; - /** @description The encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -18822,7 +18809,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -18833,37 +18820,37 @@ export interface operations { }; }; }; + /** + * Return a BioCompute Object for the workflow invocation as a file for download. + * @deprecated + * @description The BioCompute Object endpoints are in beta - important details such + * as how inputs and outputs are represented, how the workflow is encoded, + * and how author and version information is encoded, and how URLs are + * generated will very likely change in important ways over time. + * + * **Deprecation Notice**: please use the asynchronous short_term_storage export system instead. + * + * 1. call POST `api/invocations/{id}/prepare_store_download` with payload: + * ``` + * { + * model_store_format: bco.json + * } + * ``` + * 2. Get `storageRequestId` from response and poll GET `api/short_term_storage/${storageRequestId}/ready` until `SUCCESS` + * + * 3. Get the resulting file with `api/short_term_storage/${storageRequestId}` + */ download_invocation_bco_api_invocations__invocation_id__biocompute_download_get: { - /** - * Return a BioCompute Object for the workflow invocation as a file for download. - * @deprecated - * @description The BioCompute Object endpoints are in beta - important details such - * as how inputs and outputs are represented, how the workflow is encoded, - * and how author and version information is encoded, and how URLs are - * generated will very likely change in important ways over time. - * - * **Deprecation Notice**: please use the asynchronous short_term_storage export system instead. - * - * 1. call POST `api/invocations/{id}/prepare_store_download` with payload: - * ``` - * { - * model_store_format: bco.json - * } - * ``` - * 2. Get `storageRequestId` from response and poll GET `api/short_term_storage/${storageRequestId}/ready` until `SUCCESS` - * - * 3. Get the resulting file with `api/short_term_storage/${storageRequestId}` - */ parameters: { query?: { merge_history_metadata?: 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; }; - /** @description The encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -18878,21 +18865,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -18911,15 +18898,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -18943,15 +18930,15 @@ export interface operations { }; }; }; + /** Get JSON summarizing invocation for reporting. */ show_invocation_report_api_invocations__invocation_id__report_get: { - /** Get JSON summarizing invocation for reporting. */ 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 encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -18970,15 +18957,15 @@ export interface operations { }; }; }; + /** Get PDF summarizing invocation for reporting. */ show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get: { - /** Get PDF summarizing invocation for reporting. */ 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 encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -18993,21 +18980,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -19030,20 +19017,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Invocation. */ - /** @description The encoded database identifier of the WorkflowInvocationStep. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ step_id: string; }; }; @@ -19062,17 +19049,17 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the Invocation. */ - /** @description The encoded database identifier of the WorkflowInvocationStep. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ step_id: string; }; }; @@ -19096,15 +19083,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -19128,14 +19115,14 @@ export interface operations { }; }; }; + /** + * Job Lock Status + * @description Get job lock status. + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -19154,14 +19141,14 @@ export interface operations { }; }; }; + /** + * Update Job Lock + * @description Set job lock status. + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -19185,80 +19172,80 @@ export interface operations { }; }; }; + /** Index */ 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 */ + 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"]; - date_range_min?: string | string | null; - date_range_max?: string | string | null; + /** @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 The user ID 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; }; }; @@ -19281,16 +19268,16 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -19314,19 +19301,19 @@ export interface operations { }; }; }; + /** Return dictionary containing description of job data. */ show_job_api_jobs__job_id__get: { - /** Return dictionary containing description of job data. */ parameters: { - /** @description Show extra information. */ query?: { + /** @description Show extra information. */ full?: 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; }; - /** @description The ID of the job */ path: { + /** @description The ID of the job */ job_id: string; }; }; @@ -19347,15 +19334,15 @@ export interface operations { }; }; }; + /** Cancels specified job */ cancel_job_api_jobs__job_id__delete: { - /** Cancels specified job */ 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 ID of the job */ path: { + /** @description The ID of the job */ job_id: string; }; }; @@ -19379,15 +19366,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the job */ path: { + /** @description The ID of the job */ job_id: string; }; }; @@ -19406,15 +19393,15 @@ export interface operations { }; }; }; + /** Return destination parameters for specified job. */ destination_params_job_api_jobs__job_id__destination_params_get: { - /** Return destination parameters for specified job. */ 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 ID of the job */ path: { + /** @description The ID of the job */ job_id: string; }; }; @@ -19433,15 +19420,15 @@ export interface operations { }; }; }; + /** Submits a bug report via the API. */ report_error_api_jobs__job_id__error_post: { - /** Submits a bug report via the API. */ 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 ID of the job */ path: { + /** @description The ID of the job */ job_id: string; }; }; @@ -19465,15 +19452,15 @@ export interface operations { }; }; }; + /** Returns input datasets created by a job. */ get_inputs_api_jobs__job_id__inputs_get: { - /** Returns input datasets created by a job. */ 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 ID of the job */ path: { + /** @description The ID of the job */ job_id: string; }; }; @@ -19492,22 +19479,22 @@ export interface operations { }; }; }; + /** Return job metrics for specified job. */ get_metrics_api_jobs__job_id__metrics_get: { - /** Return job metrics for specified job. */ parameters: { - /** - * @deprecated - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - */ query?: { + /** + * @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; }; - /** @description The ID of the job */ path: { + /** @description The ID of the job */ job_id: string; }; }; @@ -19526,20 +19513,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description A key used to authenticate this request as acting onbehalf or a job runner for the specified job */ - /** @description OIDC provider name */ query: { + /** @description A key used to authenticate this request as acting onbehalf or a job runner for the specified job */ job_key: string; + /** @description OIDC provider name */ provider: string; }; - /** @description The user ID 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: { @@ -19561,15 +19548,15 @@ export interface operations { }; }; }; + /** Returns output datasets created by a job. */ get_outputs_api_jobs__job_id__outputs_get: { - /** Returns output datasets created by a job. */ 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 ID of the job */ path: { + /** @description The ID of the job */ job_id: string; }; }; @@ -19588,27 +19575,27 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * @deprecated - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - */ query?: { + /** + * @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; }; - /** @description The ID of the job */ path: { + /** @description The ID of the job */ job_id: string; }; }; @@ -19627,15 +19614,15 @@ export interface operations { }; }; }; + /** Resumes a paused job. */ resume_paused_job_api_jobs__job_id__resume_put: { - /** Resumes a paused job. */ 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 ID of the job */ path: { + /** @description The ID of the job */ job_id: string; }; }; @@ -19654,18 +19641,18 @@ export interface operations { }; }; }; + /** + * Returns a list of summary data for all libraries. + * @description Returns a list of summary data for all libraries. + */ 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. */ + parameters: { query?: { + /** @description Whether to include deleted libraries in the result. */ deleted?: 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; }; }; @@ -19684,14 +19671,14 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -19715,14 +19702,14 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -19741,11 +19728,11 @@ export interface operations { }; }; }; + /** Create libraries from a model store. */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -19769,18 +19756,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Library. */ path: { + /** @description The ID of the Library. */ id: string; }; }; @@ -19799,23 +19786,23 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Whether to restore a deleted library. */ query?: { + /** @description Whether to restore a deleted library. */ undelete?: 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; }; - /** @description The ID of the Library. */ path: { + /** @description The ID of the Library. */ id: string; }; }; @@ -19839,18 +19826,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Library. */ path: { + /** @description The ID of the Library. */ id: string; }; }; @@ -19874,31 +19861,31 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ - /** @description Indicates whether the roles available for the library access are requested. */ - /** @description The page number to retrieve when paginating the available roles. */ - /** @description The maximum number of permissions per page when paginating. */ - /** @description Optional search text to retrieve only the roles matching this query. */ 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 The user ID 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 ID of the Library. */ path: { + /** @description The ID of the Library. */ id: string; }; }; @@ -19919,22 +19906,22 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Indicates what action should be performed on the Library. */ query?: { + /** @description Indicates what action should be performed on the Library. */ action?: components["schemas"]["LibraryPermissionAction"] | 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; }; - /** @description The ID of the Library. */ path: { + /** @description The ID of the Library. */ id: string; }; }; @@ -19962,11 +19949,11 @@ export interface operations { }; }; }; + /** + * 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: { @@ -19976,16 +19963,16 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ path: { - id: Record; + /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ + id: unknown; }; }; responses: { @@ -20003,14 +19990,14 @@ export interface operations { }; }; }; + /** + * Records a collection of metrics. + * @description Record any metrics sent and return some status object. + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -20023,7 +20010,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -20034,20 +20021,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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; }; - /** @description The user ID 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; }; }; @@ -20066,11 +20053,11 @@ export interface operations { }; }; }; + /** Updates a list of notifications with the requested values in a single request. */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -20094,14 +20081,14 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -20127,11 +20114,11 @@ export interface operations { }; }; }; + /** Deletes a list of notifications received by the user in a single request. */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -20155,14 +20142,14 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -20181,25 +20168,25 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -20223,18 +20210,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Notification. */ path: { + /** @description The ID of the Notification. */ notification_id: string; }; }; @@ -20253,18 +20240,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Notification. */ path: { + /** @description The ID of the Notification. */ notification_id: string; }; }; @@ -20284,17 +20271,17 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -20313,17 +20300,17 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -20347,17 +20334,17 @@ export interface operations { }; }; }; + /** + * 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; }; - /** @description The user ID 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; }; }; @@ -20376,15 +20363,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the Notification. */ path: { + /** @description The ID of the Notification. */ notification_id: string; }; }; @@ -20403,15 +20390,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the Notification. */ path: { + /** @description The ID of the Notification. */ notification_id: string; }; }; @@ -20431,22 +20418,22 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Notification. */ path: { + /** @description The ID of the Notification. */ notification_id: string; }; }; @@ -20461,15 +20448,15 @@ export interface operations { }; }; }; + /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ 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. */ + parameters: { query?: { + /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ selectable?: 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; }; }; @@ -20488,15 +20475,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 concrete object store ID. */ path: { + /** @description The concrete object store ID. */ object_store_id: string; }; }; @@ -20515,65 +20502,65 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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? */ + 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 The user ID 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; }; }; @@ -20592,14 +20579,14 @@ export interface operations { }; }; }; + /** + * Create a page and return summary information. + * @description Get a list with details of all Pages available to the user. + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -20623,18 +20610,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20653,18 +20640,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20679,20 +20666,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20713,18 +20700,18 @@ export interface operations { 501: 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: { - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing 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; }; - /** @description The ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20743,18 +20730,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20773,20 +20760,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20807,18 +20794,18 @@ export interface operations { 501: 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: { - /** - * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20837,18 +20824,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20872,18 +20859,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20902,18 +20889,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20933,18 +20920,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20959,18 +20946,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Page. */ path: { + /** @description The ID of the Page. */ id: string; }; }; @@ -20989,14 +20976,14 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21015,14 +21002,14 @@ export interface operations { }; }; }; + /** + * Creates a new quota. + * @description Creates a new quota. + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21046,14 +21033,14 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21072,18 +21059,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Quota. */ path: { + /** @description The ID of the Quota. */ id: string; }; }; @@ -21102,18 +21089,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Quota. */ path: { + /** @description The ID of the Quota. */ id: string; }; }; @@ -21132,18 +21119,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the Quota. */ path: { + /** @description The ID of the Quota. */ id: string; }; }; @@ -21162,18 +21149,18 @@ export interface operations { }; }; }; + /** + * Updates an existing quota. + * @description Updates an existing quota. + */ update_api_quotas__id__put: { - /** - * Updates an existing quota. - * @description Updates an existing 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; }; - /** @description The ID of the Quota. */ path: { + /** @description The ID of the Quota. */ id: string; }; }; @@ -21197,18 +21184,18 @@ export interface operations { }; }; }; + /** + * Deletes an existing quota. + * @description Deletes an existing quota. + */ delete_api_quotas__id__delete: { - /** - * Deletes an existing quota. - * @description Deletes an existing 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; }; - /** @description The ID of the Quota. */ path: { + /** @description The ID of the Quota. */ id: string; }; }; @@ -21232,15 +21219,15 @@ export interface operations { }; }; }; + /** Purges a previously deleted quota. */ purge_api_quotas__id__purge_post: { - /** Purges a previously deleted 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; }; - /** @description The ID of the Quota. */ path: { + /** @description The ID of the Quota. */ id: string; }; }; @@ -21259,26 +21246,26 @@ export interface operations { }; }; }; + /** + * Displays remote files available to the user. + * @description Lists all remote files available to the user from different sources. + */ 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. */ + 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 The user ID 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; }; }; @@ -21299,14 +21286,14 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21330,22 +21317,22 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + 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; }; - /** @description The user ID 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; }; }; @@ -21364,11 +21351,11 @@ export interface operations { }; }; }; + /** Index */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21387,11 +21374,11 @@ export interface operations { }; }; }; + /** Create */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21415,11 +21402,11 @@ export interface operations { }; }; }; + /** Show */ show_api_roles__id__get: { - /** Show */ 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: { @@ -21441,11 +21428,11 @@ export interface operations { }; }; }; + /** Delete */ delete_api_roles__id__delete: { - /** Delete */ 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: { @@ -21467,11 +21454,11 @@ export interface operations { }; }; }; + /** Purge */ purge_api_roles__id__purge_post: { - /** Purge */ 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: { @@ -21493,11 +21480,11 @@ export interface operations { }; }; }; + /** Undelete */ undelete_api_roles__id__undelete_post: { - /** Undelete */ 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: { @@ -21519,8 +21506,8 @@ export interface operations { }; }; }; + /** 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; @@ -21539,8 +21526,8 @@ export interface operations { }; }; }; + /** 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; @@ -21561,14 +21548,14 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21592,19 +21579,19 @@ export interface operations { }; }; }; + /** Returns discarded datasets owned by the given user. The results can be paginated. */ 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. */ + 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 The user ID 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; }; }; @@ -21623,11 +21610,11 @@ export interface operations { }; }; }; + /** 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: { - /** 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21646,14 +21633,14 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21677,19 +21664,19 @@ export interface operations { }; }; }; + /** Returns archived histories owned by the given user that are not purged. The results can be paginated. */ 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. */ + 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 The user ID 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; }; }; @@ -21708,11 +21695,11 @@ export interface operations { }; }; }; + /** 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: { - /** 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21731,19 +21718,19 @@ export interface operations { }; }; }; + /** Returns all discarded histories associated with the given user. */ 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. */ + 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 The user ID 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; }; }; @@ -21762,11 +21749,11 @@ export interface operations { }; }; }; + /** 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: { - /** 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21785,17 +21772,17 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -21815,8 +21802,8 @@ export interface operations { }; }; }; + /** Determine state of task ID */ state_api_tasks__task_id__state_get: { - /** Determine state of task ID */ parameters: { path: { task_id: string; @@ -21837,11 +21824,11 @@ export interface operations { }; }; }; + /** + * 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: { @@ -21851,14 +21838,14 @@ export interface operations { }; }; }; + /** Import a data manager bundle */ create_api_tool_data_post: { - /** Import a data manager bundle */ - parameters?: { + parameters: { query?: { tool_data_file_path?: 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; }; }; @@ -21882,18 +21869,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 name of the tool data table */ path: { + /** @description The name of the tool data table */ table_name: string; }; }; @@ -21912,18 +21899,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 name of the tool data table */ path: { + /** @description The name of the tool data table */ table_name: string; }; }; @@ -21947,20 +21934,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 name of the tool data table */ - /** @description The name of the tool data table field */ path: { + /** @description The name of the tool data table */ table_name: string; + /** @description The name of the tool data table field */ field_name: string; }; }; @@ -21979,22 +21966,22 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 name of the tool data table */ - /** @description The name of the tool data table field */ - /** @description The name of a file associated with this data table field */ 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; }; }; @@ -22009,18 +21996,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 name of the tool data table */ path: { + /** @description The name of the tool data table */ table_name: string; }; }; @@ -22039,19 +22026,19 @@ export interface operations { }; }; }; + /** Lists installed tool shed repositories. */ 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. */ + 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; }; }; @@ -22070,14 +22057,14 @@ export interface operations { }; }; }; + /** Check for updates to the specified repository, or all installed repositories. */ check_for_updates_api_tool_shed_repositories_check_for_updates_get: { - /** Check for updates to the specified repository, or all installed repositories. */ - parameters?: { + parameters: { query?: { id?: 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; }; }; @@ -22096,11 +22083,11 @@ export interface operations { }; }; }; + /** Show installed tool shed repository. */ show_api_tool_shed_repositories__id__get: { - /** Show installed tool shed repository. */ parameters: { - /** @description The encoded database identifier of the installed Tool Shed Repository. */ path: { + /** @description The encoded database identifier of the installed Tool Shed Repository. */ id: string; }; }; @@ -22119,11 +22106,11 @@ export interface operations { }; }; }; + /** Upload files to Galaxy */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -22136,7 +22123,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -22147,11 +22134,11 @@ export interface operations { }; }; }; + /** + * Index + * @description Return list of available tours. + */ index_api_tours_get: { - /** - * Index - * @description Return list of available tours. - */ responses: { /** @description Successful Response */ 200: { @@ -22161,11 +22148,11 @@ export interface operations { }; }; }; + /** + * Show + * @description Return a tour definition. + */ show_api_tours__tour_id__get: { - /** - * Show - * @description Return a tour definition. - */ parameters: { path: { tour_id: string; @@ -22186,14 +22173,14 @@ export interface operations { }; }; }; + /** + * Update Tour + * @description Return a tour definition. + */ update_tour_api_tours__tour_id__post: { - /** - * Update Tour - * @description Return a tour definition. - */ 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: { @@ -22215,24 +22202,24 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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 */ + 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 The user ID 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; }; }; @@ -22254,11 +22241,11 @@ export interface operations { }; }; }; + /** Create a new Galaxy user. Only admins can create users for now. */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -22284,16 +22271,16 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -22314,22 +22301,22 @@ export interface operations { }; }; }; + /** + * Get Deleted Users + * @description Return a collection of deleted users. Only admins can see deleted users. + */ 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 */ + 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; }; - /** @description The user ID 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; }; }; @@ -22351,15 +22338,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22380,15 +22367,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22407,17 +22394,17 @@ export interface operations { }; }; }; + /** + * 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: { - /** - * 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -22438,19 +22425,19 @@ export interface operations { }; }; }; + /** 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: { - /** @description Indicates if the user is deleted */ query?: { + /** @description Indicates if the user is deleted */ deleted?: 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; }; - /** @description The ID of the user to get or 'current'. */ path: { + /** @description The ID of the user to get or 'current'. */ user_id: string | "current"; }; }; @@ -22471,19 +22458,19 @@ export interface operations { }; }; }; + /** 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: { - /** @description Indicates if the user is deleted */ query?: { + /** @description Indicates if the user is deleted */ deleted?: 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; }; - /** @description The ID of the user to get or 'current'. */ path: { + /** @description The ID of the user to get or 'current'. */ user_id: string | "current"; }; }; @@ -22507,15 +22494,15 @@ export interface operations { }; }; }; + /** 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?: { + /** @description The user ID that will be used 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22539,15 +22526,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22566,15 +22553,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22593,15 +22580,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22616,15 +22603,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22645,18 +22632,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22675,18 +22662,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22710,15 +22697,15 @@ export interface operations { }; }; }; + /** Returns collection of custom builds. */ get_custom_builds_api_users__user_id__custom_builds_get: { - /** Returns collection of custom builds. */ 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22737,17 +22724,17 @@ export interface operations { }; }; }; + /** Add new custom build. */ add_custom_builds_api_users__user_id__custom_builds__key__put: { - /** Add new custom build. */ 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 ID of the user. */ - /** @description The key of the custom build to be deleted. */ path: { + /** @description The ID of the user. */ user_id: string; + /** @description The key of the custom build to be deleted. */ key: string; }; }; @@ -22760,7 +22747,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -22771,17 +22758,17 @@ export interface operations { }; }; }; + /** Delete a custom build */ delete_custom_build_api_users__user_id__custom_builds__key__delete: { - /** Delete a custom build */ 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 ID of the user. */ - /** @description The key of the custom build to be deleted. */ path: { + /** @description The ID of the user. */ user_id: string; + /** @description The key of the custom build to be deleted. */ key: string; }; }; @@ -22800,17 +22787,17 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user. */ - /** @description The object type the user wants to favorite */ path: { + /** @description The ID of the user. */ user_id: string; + /** @description The object type the user wants to favorite */ object_type: components["schemas"]["FavoriteObjectType"]; }; }; @@ -22834,19 +22821,19 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user. */ - /** @description The object type the user wants to favorite */ - /** @description The ID of an object the user wants to remove from favorites */ 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; }; }; @@ -22865,15 +22852,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user to get or 'current'. */ path: { + /** @description The ID of the user to get or 'current'. */ user_id: string | "current"; }; }; @@ -22892,15 +22879,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22921,15 +22908,15 @@ export interface operations { }; }; }; + /** Sends activation email to user. */ send_activation_email_api_users__user_id__send_activation_email_post: { - /** Sends activation email to 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 The ID of the user. */ path: { + /** @description The ID of the user. */ user_id: string; }; }; @@ -22937,7 +22924,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -22948,17 +22935,17 @@ export interface operations { }; }; }; + /** Set the user's theme choice */ set_theme_api_users__user_id__theme__theme__put: { - /** Set the user's theme choice */ 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 ID of the user. */ - /** @description The theme of the GUI */ path: { + /** @description The ID of the user. */ user_id: string; + /** @description The theme of the GUI */ theme: string; }; }; @@ -22977,15 +22964,15 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user to get or 'current'. */ path: { + /** @description The ID of the user to get or 'current'. */ user_id: string | "current"; }; }; @@ -23004,17 +22991,17 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 ID of the user to get or 'current'. */ - /** @description The label corresponding to the quota source to fetch usage information about. */ 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; }; }; @@ -23033,11 +23020,11 @@ export interface operations { }; }; }; + /** + * 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: { @@ -23047,64 +23034,64 @@ export interface operations { }; }; }; + /** Returns visualizations for the current user. */ 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`. - */ + 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; }; - /** @description The user ID 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; }; }; @@ -23123,18 +23110,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Visualization. */ path: { + /** @description The encoded database identifier of the Visualization. */ id: string; }; }; @@ -23153,18 +23140,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Visualization. */ path: { + /** @description The encoded database identifier of the Visualization. */ id: string; }; }; @@ -23183,18 +23170,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Visualization. */ path: { + /** @description The encoded database identifier of the Visualization. */ id: string; }; }; @@ -23213,18 +23200,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Visualization. */ path: { + /** @description The encoded database identifier of the Visualization. */ id: string; }; }; @@ -23248,18 +23235,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Visualization. */ path: { + /** @description The encoded database identifier of the Visualization. */ id: string; }; }; @@ -23278,18 +23265,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Visualization. */ path: { + /** @description The encoded database identifier of the Visualization. */ id: string; }; }; @@ -23309,18 +23296,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Visualization. */ path: { + /** @description The encoded database identifier of the Visualization. */ id: string; }; }; @@ -23339,14 +23326,14 @@ export interface operations { }; }; }; + /** + * Return information about the current authenticated user + * @description Return information about the current authenticated user. + */ 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. */ + parameters: { header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; }; @@ -23365,72 +23352,72 @@ export interface operations { }; }; }; + /** + * Lists stored workflows viewable by the user. + * @description Lists stored workflows viewable by the user. + */ 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. */ + parameters: { 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; }; - /** @description The user ID 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; }; }; @@ -23449,21 +23436,21 @@ export interface operations { }; }; }; + /** Get workflows present in the tools panel. */ 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 */ + 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 The user ID 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; }; }; @@ -23471,7 +23458,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -23482,22 +23469,22 @@ export interface operations { }; }; }; + /** Displays information needed to run a workflow. */ show_workflow_api_workflows__workflow_id__get: { - /** Displays information needed to run a workflow. */ parameters: { - /** @description Use the legacy workflow format. */ - /** @description The version of the workflow to fetch. */ query?: { instance?: boolean | null; + /** @description Use the legacy workflow format. */ legacy?: boolean | null; + /** @description The version of the workflow to fetch. */ version?: number | 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; }; - /** @description The encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -23516,15 +23503,15 @@ export interface operations { }; }; }; + /** Add the deleted flag to a workflow. */ delete_workflow_api_workflows__workflow_id__delete: { - /** Add the deleted flag to a workflow. */ 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -23532,7 +23519,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -23543,19 +23530,19 @@ export interface operations { }; }; }; + /** Get state counts for accessible workflow. */ workflows__invocation_counts: { - /** Get state counts for accessible workflow. */ parameters: { - /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ query?: { + /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ instance?: 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; }; - /** @description The encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -23574,18 +23561,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -23604,18 +23591,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -23634,39 +23621,39 @@ export interface operations { }; }; }; + /** 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: { - /** @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 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 The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -23685,16 +23672,16 @@ export interface operations { }; }; }; + /** 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: { - /** @description The user ID 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 database identifier - UUID or encoded - of the Workflow. */ path: { - workflow_id: string | string | string; + /** @description The database identifier - UUID or encoded - of the Workflow. */ + workflow_id: string; }; }; requestBody: { @@ -23719,31 +23706,31 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - /** - * @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. - */ 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 The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -23762,31 +23749,31 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - /** - * @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. - */ 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 The user ID 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 encoded database identifier of the Invocation. */ - /** @description The encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -23805,20 +23792,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -23837,20 +23824,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Invocation. */ - /** @description The encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -23869,20 +23856,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -23897,20 +23884,20 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -23933,22 +23920,22 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ - /** @description The encoded database identifier of the WorkflowInvocationStep. */ 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; }; }; @@ -23967,22 +23954,22 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ - /** @description The encoded database identifier of the WorkflowInvocationStep. */ 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; }; }; @@ -24006,18 +23993,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24036,18 +24023,18 @@ export interface operations { }; }; }; + /** 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; }; - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24071,18 +24058,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24106,18 +24093,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24136,18 +24123,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24167,11 +24154,11 @@ export interface operations { }; }; }; + /** Show tags based on workflow_id */ index_api_workflows__workflow_id__tags_get: { - /** Show tags based on workflow_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. */ header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { @@ -24193,11 +24180,11 @@ export interface operations { }; }; }; + /** Show tag based on workflow_id */ show_api_workflows__workflow_id__tags__tag_name__get: { - /** Show tag based on workflow_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. */ header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { @@ -24220,11 +24207,11 @@ export interface operations { }; }; }; + /** Update tag based on workflow_id */ update_api_workflows__workflow_id__tags__tag_name__put: { - /** Update tag based on workflow_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. */ header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { @@ -24252,11 +24239,11 @@ export interface operations { }; }; }; + /** Create tag based on workflow_id */ create_api_workflows__workflow_id__tags__tag_name__post: { - /** Create tag based on workflow_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. */ header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { @@ -24284,11 +24271,11 @@ export interface operations { }; }; }; + /** Delete tag based on workflow_id */ delete_api_workflows__workflow_id__tags__tag_name__delete: { - /** Delete tag based on workflow_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. */ header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { @@ -24311,15 +24298,15 @@ export interface operations { }; }; }; + /** Remove the deleted flag from a workflow. */ undelete_workflow_api_workflows__workflow_id__undelete_post: { - /** Remove the deleted flag from a workflow. */ 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24327,7 +24314,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -24338,18 +24325,18 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24368,42 +24355,42 @@ export interface operations { }; }; }; + /** + * 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: { - /** @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 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 The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24422,19 +24409,19 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 database identifier - UUID or encoded - of the Workflow. */ path: { - workflow_id: string | string | string; + /** @description The database identifier - UUID or encoded - of the Workflow. */ + workflow_id: string; }; }; requestBody: { @@ -24459,32 +24446,32 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - /** - * @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. - */ 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 The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -24503,32 +24490,32 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - /** - * @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. - */ 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 The user ID 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 encoded database identifier of the Invocation. */ - /** @description The encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24547,21 +24534,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -24580,21 +24567,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Invocation. */ - /** @description The encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24613,21 +24600,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -24642,21 +24629,21 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; + /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; }; @@ -24679,23 +24666,23 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ - /** @description The encoded database identifier of the WorkflowInvocationStep. */ 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; }; }; @@ -24714,23 +24701,23 @@ export interface operations { }; }; }; + /** + * 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: { - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ - /** @description The encoded database identifier of the Invocation. */ - /** @description The encoded database identifier of the WorkflowInvocationStep. */ 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; }; }; @@ -24754,18 +24741,18 @@ export interface operations { }; }; }; + /** 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; }; - /** @description The user ID 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 encoded database identifier of the Stored Workflow. */ path: { + /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; }; @@ -24773,7 +24760,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -24784,15 +24771,15 @@ export interface operations { }; }; }; + /** Get Object */ get_object_ga4gh_drs_v1_objects__object_id__get: { - /** Get 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 The ID of the group */ path: { + /** @description The ID of the group */ object_id: string; }; }; @@ -24811,15 +24798,15 @@ export interface operations { }; }; }; + /** Get Object */ get_object_ga4gh_drs_v1_objects__object_id__post: { - /** Get 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 The ID of the group */ path: { + /** @description The ID of the group */ object_id: string; }; }; @@ -24838,17 +24825,17 @@ export interface operations { }; }; }; + /** Get Access Url */ get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__get: { - /** Get Access Url */ 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 ID of the group */ - /** @description The access ID of the access method for objects, unused in Galaxy. */ path: { + /** @description The ID of the group */ object_id: string; + /** @description The access ID of the access method for objects, unused in Galaxy. */ access_id: string; }; }; @@ -24856,7 +24843,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -24867,17 +24854,17 @@ export interface operations { }; }; }; + /** Get Access Url */ get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__post: { - /** Get Access Url */ 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 ID of the group */ - /** @description The access ID of the access method for objects, unused in Galaxy. */ path: { + /** @description The ID of the group */ object_id: string; + /** @description The access ID of the access method for objects, unused in Galaxy. */ access_id: string; }; }; @@ -24885,7 +24872,7 @@ export interface operations { /** @description Successful Response */ 200: { content: { - "application/json": Record; + "application/json": unknown; }; }; /** @description Validation Error */ @@ -24896,8 +24883,8 @@ export interface operations { }; }; }; + /** Service Info */ service_info_ga4gh_drs_v1_service_info_get: { - /** Service Info */ responses: { /** @description Successful Response */ 200: { diff --git a/client/src/components/admin/JobLock.vue b/client/src/components/admin/JobLock.vue index fb2ada5c53f4..58d63f59077c 100644 --- a/client/src/components/admin/JobLock.vue +++ b/client/src/components/admin/JobLock.vue @@ -1,11 +1,17 @@