This is an automated email from the ASF dual-hosted git repository. kaxilnaik pushed a commit to branch v3-1-test in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 903f54c41735101d4d2493f1cff1ea1c8f7ef5f7 Author: Pierre Jeambrun <[email protected]> AuthorDate: Wed Sep 24 18:41:18 2025 +0200 Improve API doc for ordering query param (#55988) (cherry picked from commit 097d09897360b75627cf0b3de51c16461dafdb94) (cherry picked from commit 443cc170a04de6c86e803e6e923651142bbb75cd) --- .../src/airflow/api_fastapi/common/parameters.py | 4 +- .../api_fastapi/core_api/openapi/_private_ui.yaml | 22 +++++ .../core_api/openapi/v2-rest-api-generated.yaml | 108 +++++++++++++++++++++ .../ui/openapi-gen/queries/ensureQueryData.ts | 44 ++++----- .../src/airflow/ui/openapi-gen/queries/prefetch.ts | 44 ++++----- .../src/airflow/ui/openapi-gen/queries/queries.ts | 44 ++++----- .../src/airflow/ui/openapi-gen/queries/suspense.ts | 44 ++++----- .../ui/openapi-gen/requests/services.gen.ts | 44 ++++----- .../airflow/ui/openapi-gen/requests/types.gen.ts | 66 +++++++++++++ 9 files changed, 309 insertions(+), 111 deletions(-) diff --git a/airflow-core/src/airflow/api_fastapi/common/parameters.py b/airflow-core/src/airflow/api_fastapi/common/parameters.py index e801d2d9e79..b33dffc9714 100644 --- a/airflow-core/src/airflow/api_fastapi/common/parameters.py +++ b/airflow-core/src/airflow/api_fastapi/common/parameters.py @@ -285,7 +285,9 @@ class SortParam(BaseParam[list[str]]): def dynamic_depends(self, default: str | None = None) -> Callable: def inner( order_by: list[str] = Query( - default=[default] if default is not None else [self.get_primary_key_string()] + default=[default] if default is not None else [self.get_primary_key_string()], + description=f"Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. " + f"Supported attributes: `{', '.join(self.allowed_attrs) if self.allowed_attrs else self.get_primary_key_string()}`", ), ) -> SortParam: return self.set_value(order_by) diff --git a/airflow-core/src/airflow/api_fastapi/core_api/openapi/_private_ui.yaml b/airflow-core/src/airflow/api_fastapi/core_api/openapi/_private_ui.yaml index ec079113922..aa2d8679bab 100644 --- a/airflow-core/src/airflow/api_fastapi/core_api/openapi/_private_ui.yaml +++ b/airflow-core/src/airflow/api_fastapi/core_api/openapi/_private_ui.yaml @@ -251,9 +251,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, + next_dagrun, state, start_date`' default: - dag_id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `dag_id, dag_display_name, + next_dagrun, state, start_date`' - name: is_favorite in: query required: false @@ -547,9 +553,13 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id`' - name: dag_id in: query required: false @@ -625,9 +635,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `run_after, + logical_date, start_date, end_date`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `run_after, logical_date, + start_date, end_date`' - name: run_after_gte in: query required: false @@ -752,9 +768,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `run_after, + logical_date, start_date, end_date`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `run_after, logical_date, + start_date, end_date`' - name: run_after_gte in: query required: false diff --git a/airflow-core/src/airflow/api_fastapi/core_api/openapi/v2-rest-api-generated.yaml b/airflow-core/src/airflow/api_fastapi/core_api/openapi/v2-rest-api-generated.yaml index 5d582a8d2cd..dcdd86adf2a 100644 --- a/airflow-core/src/airflow/api_fastapi/core_api/openapi/v2-rest-api-generated.yaml +++ b/airflow-core/src/airflow/api_fastapi/core_api/openapi/v2-rest-api-generated.yaml @@ -80,9 +80,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id, name, + uri, created_at, updated_at`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id, name, uri, created_at, + updated_at`' responses: '200': description: Successful Response @@ -160,9 +166,13 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id, name`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id, name`' responses: '200': description: Successful Response @@ -275,9 +285,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `source_task_id, + source_dag_id, source_run_id, source_map_index, timestamp`' default: - timestamp title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `source_task_id, source_dag_id, + source_run_id, source_map_index, timestamp`' - name: asset_id in: query required: false @@ -916,9 +932,13 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id`' responses: '200': description: Successful Response @@ -1451,9 +1471,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `conn_id, + conn_type, description, host, port, id`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `conn_id, conn_type, + description, host, port, id`' - name: connection_id_pattern in: query required: false @@ -2206,9 +2232,17 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id, state, + dag_id, run_id, logical_date, run_after, start_date, end_date, updated_at, + conf, duration`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id, state, dag_id, + run_id, logical_date, run_after, start_date, end_date, updated_at, conf, + duration`' - name: run_id_pattern in: query required: false @@ -2821,9 +2855,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `dag_id, warning_type, + message, timestamp`' default: - dag_id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `dag_id, warning_type, + message, timestamp`' responses: '200': description: Successful Response @@ -3085,9 +3125,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, + next_dagrun, state, start_date`' default: - dag_id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `dag_id, dag_display_name, + next_dagrun, state, start_date`' - name: is_favorite in: query required: false @@ -3658,9 +3704,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id, dttm, + dag_id, task_id, run_id, event, logical_date, owner, extra`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id, dttm, dag_id, + task_id, run_id, event, logical_date, owner, extra`' - name: dag_id in: query required: false @@ -3990,9 +4042,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id, timestamp, + filename, bundle_name, stacktrace`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id, timestamp, filename, + bundle_name, stacktrace`' - name: filename_pattern in: query required: false @@ -4144,9 +4202,17 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id, dag_id, + state, job_type, start_date, end_date, latest_heartbeat, executor_class, + hostname, unixname`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id, dag_id, state, + job_type, start_date, end_date, latest_heartbeat, executor_class, hostname, + unixname`' - name: job_state in: query required: false @@ -4489,9 +4555,13 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id, pool`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id, pool`' - name: pool_name_pattern in: query required: false @@ -5697,9 +5767,17 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id, state, + duration, start_date, end_date, map_index, try_number, logical_date, run_after, + data_interval_start, data_interval_end, rendered_map_index, operator`' default: - map_index title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id, state, duration, + start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, + data_interval_end, rendered_map_index, operator`' responses: '200': description: Successful Response @@ -6505,9 +6583,17 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id, state, + duration, start_date, end_date, map_index, try_number, logical_date, run_after, + data_interval_start, data_interval_end, rendered_map_index, operator`' default: - map_index title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id, state, duration, + start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, + data_interval_end, rendered_map_index, operator`' responses: '200': description: Successful Response @@ -7346,9 +7432,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `key, id, + _val, description, is_encrypted`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `key, id, _val, description, + is_encrypted`' - name: variable_key_pattern in: query required: false @@ -7741,9 +7833,13 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `name`' default: - name title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `name`' - name: tag_name_pattern in: query required: false @@ -7899,9 +7995,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `id, version_number, + bundle_name, bundle_version`' default: - id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `id, version_number, + bundle_name, bundle_version`' responses: '200': description: Successful Response @@ -8122,9 +8224,15 @@ paths: type: array items: type: string + description: 'Attributes to order by, multi criteria sort is supported. + Prefix with `-` for descending order. Supported attributes: `ti_id, subject, + responded_at, created_at, responded_by_user_id, responded_by_user_name`' default: - ti_id title: Order By + description: 'Attributes to order by, multi criteria sort is supported. Prefix + with `-` for descending order. Supported attributes: `ti_id, subject, responded_at, + created_at, responded_by_user_id, responded_by_user_name`' - name: dag_id_pattern in: query required: false diff --git a/airflow-core/src/airflow/ui/openapi-gen/queries/ensureQueryData.ts b/airflow-core/src/airflow/ui/openapi-gen/queries/ensureQueryData.ts index 9188e6a5184..58dc0af81c9 100644 --- a/airflow-core/src/airflow/ui/openapi-gen/queries/ensureQueryData.ts +++ b/airflow-core/src/airflow/ui/openapi-gen/queries/ensureQueryData.ts @@ -14,7 +14,7 @@ import * as Common from "./common"; * @param data.uriPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.dagIds * @param data.onlyActive -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name, uri, created_at, updated_at` * @returns AssetCollectionResponse Successful Response * @throws ApiError */ @@ -34,7 +34,7 @@ export const ensureUseAssetServiceGetAssetsData = (queryClient: QueryClient, { d * @param data.limit * @param data.offset * @param data.namePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name` * @returns AssetAliasCollectionResponse Successful Response * @throws ApiError */ @@ -61,7 +61,7 @@ export const ensureUseAssetServiceGetAssetAliasData = (queryClient: QueryClient, * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `source_task_id, source_dag_id, source_run_id, source_map_index, timestamp` * @param data.assetId * @param data.sourceDagId * @param data.sourceTaskId @@ -156,7 +156,7 @@ export const ensureUseAssetServiceNextRunAssetsData = (queryClient: QueryClient, * @param data.dagId * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` * @returns BackfillCollectionResponse Successful Response * @throws ApiError */ @@ -181,7 +181,7 @@ export const ensureUseBackfillServiceGetBackfillData = (queryClient: QueryClient * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` * @param data.dagId * @param data.active * @returns BackfillCollectionResponse Successful Response @@ -211,7 +211,7 @@ export const ensureUseConnectionServiceGetConnectionData = (queryClient: QueryCl * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `conn_id, conn_type, description, host, port, id` * @param data.connectionIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns ConnectionCollectionResponse Successful Response * @throws ApiError @@ -286,7 +286,7 @@ export const ensureUseDagRunServiceGetUpstreamAssetEventsData = (queryClient: Qu * @param data.runType * @param data.state * @param data.dagVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, run_after, start_date, end_date, updated_at, conf, duration` * @param data.runIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.triggeringUserNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns DAGRunCollectionResponse Successful Response @@ -424,7 +424,7 @@ export const ensureUseConfigServiceGetConfigsData = (queryClient: QueryClient) = * @param data.warningType * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, warning_type, message, timestamp` * @returns DAGWarningCollectionResponse Successful Response * @throws ApiError */ @@ -463,7 +463,7 @@ export const ensureUseDagWarningServiceListDagWarningsData = (queryClient: Query * @param data.dagRunEndDateLte * @param data.dagRunEndDateLt * @param data.dagRunState -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` * @param data.isFavorite * @returns DAGCollectionResponse Successful Response * @throws ApiError @@ -524,7 +524,7 @@ export const ensureUseDagServiceGetDagDetailsData = (queryClient: QueryClient, { * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name` * @param data.tagNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns DAGTagCollectionResponse Successful Response * @throws ApiError @@ -554,7 +554,7 @@ export const ensureUseDagServiceGetDagTagsData = (queryClient: QueryClient, { li * @param data.lastDagRunState * @param data.bundleName * @param data.bundleVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` * @param data.isFavorite * @param data.hasAssetSchedule Filter Dags with asset-based scheduling * @param data.assetDependency Filter Dags by asset dependency (name or URI) @@ -611,7 +611,7 @@ export const ensureUseEventLogServiceGetEventLogData = (queryClient: QueryClient * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dttm, dag_id, task_id, run_id, event, logical_date, owner, extra` * @param data.dagId * @param data.taskId * @param data.runId @@ -742,7 +742,7 @@ export const ensureUseTaskInstanceServiceGetTaskInstanceData = (queryClient: Que * @param data.mapIndex * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` * @returns TaskInstanceCollectionResponse Successful Response * @throws ApiError */ @@ -915,7 +915,7 @@ export const ensureUseTaskInstanceServiceGetMappedTaskInstanceData = (queryClien * @param data.mapIndex * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` * @returns TaskInstanceCollectionResponse Successful Response * @throws ApiError */ @@ -1066,7 +1066,7 @@ export const ensureUseTaskInstanceServiceGetHitlDetailData = (queryClient: Query * @param data.dagRunId * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `ti_id, subject, responded_at, created_at, responded_by_user_id, responded_by_user_name` * @param data.dagIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.taskId * @param data.taskIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. @@ -1122,7 +1122,7 @@ export const ensureUseImportErrorServiceGetImportErrorData = (queryClient: Query * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, timestamp, filename, bundle_name, stacktrace` * @param data.filenamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns ImportErrorCollectionResponse Successful Response * @throws ApiError @@ -1148,7 +1148,7 @@ export const ensureUseImportErrorServiceGetImportErrorsData = (queryClient: Quer * @param data.endDateLt * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dag_id, state, job_type, start_date, end_date, latest_heartbeat, executor_class, hostname, unixname` * @param data.jobState * @param data.jobType * @param data.hostname @@ -1209,7 +1209,7 @@ export const ensureUsePoolServiceGetPoolData = (queryClient: QueryClient, { pool * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, pool` * @param data.poolNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns PoolCollectionResponse Successful Response * @throws ApiError @@ -1350,7 +1350,7 @@ export const ensureUseVariableServiceGetVariableData = (queryClient: QueryClient * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted` * @param data.variableKeyPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns VariableCollectionResponse Successful Response * @throws ApiError @@ -1386,7 +1386,7 @@ export const ensureUseDagVersionServiceGetDagVersionData = (queryClient: QueryCl * @param data.versionNumber * @param data.bundleName * @param data.bundleVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, version_number, bundle_name, bundle_version` * @returns DAGVersionCollectionResponse Successful Response * @throws ApiError */ @@ -1510,7 +1510,7 @@ export const ensureUseStructureServiceStructureDataData = (queryClient: QueryCli * @param data.dagId * @param data.offset * @param data.limit -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` * @param data.runAfterGte * @param data.runAfterGt * @param data.runAfterLte @@ -1539,7 +1539,7 @@ export const ensureUseGridServiceGetDagStructureData = (queryClient: QueryClient * @param data.dagId * @param data.offset * @param data.limit -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` * @param data.runAfterGte * @param data.runAfterGt * @param data.runAfterLte diff --git a/airflow-core/src/airflow/ui/openapi-gen/queries/prefetch.ts b/airflow-core/src/airflow/ui/openapi-gen/queries/prefetch.ts index 46015f86402..0c202e74282 100644 --- a/airflow-core/src/airflow/ui/openapi-gen/queries/prefetch.ts +++ b/airflow-core/src/airflow/ui/openapi-gen/queries/prefetch.ts @@ -14,7 +14,7 @@ import * as Common from "./common"; * @param data.uriPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.dagIds * @param data.onlyActive -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name, uri, created_at, updated_at` * @returns AssetCollectionResponse Successful Response * @throws ApiError */ @@ -34,7 +34,7 @@ export const prefetchUseAssetServiceGetAssets = (queryClient: QueryClient, { dag * @param data.limit * @param data.offset * @param data.namePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name` * @returns AssetAliasCollectionResponse Successful Response * @throws ApiError */ @@ -61,7 +61,7 @@ export const prefetchUseAssetServiceGetAssetAlias = (queryClient: QueryClient, { * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `source_task_id, source_dag_id, source_run_id, source_map_index, timestamp` * @param data.assetId * @param data.sourceDagId * @param data.sourceTaskId @@ -156,7 +156,7 @@ export const prefetchUseAssetServiceNextRunAssets = (queryClient: QueryClient, { * @param data.dagId * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` * @returns BackfillCollectionResponse Successful Response * @throws ApiError */ @@ -181,7 +181,7 @@ export const prefetchUseBackfillServiceGetBackfill = (queryClient: QueryClient, * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` * @param data.dagId * @param data.active * @returns BackfillCollectionResponse Successful Response @@ -211,7 +211,7 @@ export const prefetchUseConnectionServiceGetConnection = (queryClient: QueryClie * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `conn_id, conn_type, description, host, port, id` * @param data.connectionIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns ConnectionCollectionResponse Successful Response * @throws ApiError @@ -286,7 +286,7 @@ export const prefetchUseDagRunServiceGetUpstreamAssetEvents = (queryClient: Quer * @param data.runType * @param data.state * @param data.dagVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, run_after, start_date, end_date, updated_at, conf, duration` * @param data.runIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.triggeringUserNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns DAGRunCollectionResponse Successful Response @@ -424,7 +424,7 @@ export const prefetchUseConfigServiceGetConfigs = (queryClient: QueryClient) => * @param data.warningType * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, warning_type, message, timestamp` * @returns DAGWarningCollectionResponse Successful Response * @throws ApiError */ @@ -463,7 +463,7 @@ export const prefetchUseDagWarningServiceListDagWarnings = (queryClient: QueryCl * @param data.dagRunEndDateLte * @param data.dagRunEndDateLt * @param data.dagRunState -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` * @param data.isFavorite * @returns DAGCollectionResponse Successful Response * @throws ApiError @@ -524,7 +524,7 @@ export const prefetchUseDagServiceGetDagDetails = (queryClient: QueryClient, { d * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name` * @param data.tagNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns DAGTagCollectionResponse Successful Response * @throws ApiError @@ -554,7 +554,7 @@ export const prefetchUseDagServiceGetDagTags = (queryClient: QueryClient, { limi * @param data.lastDagRunState * @param data.bundleName * @param data.bundleVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` * @param data.isFavorite * @param data.hasAssetSchedule Filter Dags with asset-based scheduling * @param data.assetDependency Filter Dags by asset dependency (name or URI) @@ -611,7 +611,7 @@ export const prefetchUseEventLogServiceGetEventLog = (queryClient: QueryClient, * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dttm, dag_id, task_id, run_id, event, logical_date, owner, extra` * @param data.dagId * @param data.taskId * @param data.runId @@ -742,7 +742,7 @@ export const prefetchUseTaskInstanceServiceGetTaskInstance = (queryClient: Query * @param data.mapIndex * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` * @returns TaskInstanceCollectionResponse Successful Response * @throws ApiError */ @@ -915,7 +915,7 @@ export const prefetchUseTaskInstanceServiceGetMappedTaskInstance = (queryClient: * @param data.mapIndex * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` * @returns TaskInstanceCollectionResponse Successful Response * @throws ApiError */ @@ -1066,7 +1066,7 @@ export const prefetchUseTaskInstanceServiceGetHitlDetail = (queryClient: QueryCl * @param data.dagRunId * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `ti_id, subject, responded_at, created_at, responded_by_user_id, responded_by_user_name` * @param data.dagIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.taskId * @param data.taskIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. @@ -1122,7 +1122,7 @@ export const prefetchUseImportErrorServiceGetImportError = (queryClient: QueryCl * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, timestamp, filename, bundle_name, stacktrace` * @param data.filenamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns ImportErrorCollectionResponse Successful Response * @throws ApiError @@ -1148,7 +1148,7 @@ export const prefetchUseImportErrorServiceGetImportErrors = (queryClient: QueryC * @param data.endDateLt * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dag_id, state, job_type, start_date, end_date, latest_heartbeat, executor_class, hostname, unixname` * @param data.jobState * @param data.jobType * @param data.hostname @@ -1209,7 +1209,7 @@ export const prefetchUsePoolServiceGetPool = (queryClient: QueryClient, { poolNa * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, pool` * @param data.poolNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns PoolCollectionResponse Successful Response * @throws ApiError @@ -1350,7 +1350,7 @@ export const prefetchUseVariableServiceGetVariable = (queryClient: QueryClient, * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted` * @param data.variableKeyPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns VariableCollectionResponse Successful Response * @throws ApiError @@ -1386,7 +1386,7 @@ export const prefetchUseDagVersionServiceGetDagVersion = (queryClient: QueryClie * @param data.versionNumber * @param data.bundleName * @param data.bundleVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, version_number, bundle_name, bundle_version` * @returns DAGVersionCollectionResponse Successful Response * @throws ApiError */ @@ -1510,7 +1510,7 @@ export const prefetchUseStructureServiceStructureData = (queryClient: QueryClien * @param data.dagId * @param data.offset * @param data.limit -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` * @param data.runAfterGte * @param data.runAfterGt * @param data.runAfterLte @@ -1539,7 +1539,7 @@ export const prefetchUseGridServiceGetDagStructure = (queryClient: QueryClient, * @param data.dagId * @param data.offset * @param data.limit -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` * @param data.runAfterGte * @param data.runAfterGt * @param data.runAfterLte diff --git a/airflow-core/src/airflow/ui/openapi-gen/queries/queries.ts b/airflow-core/src/airflow/ui/openapi-gen/queries/queries.ts index cf65f5e57a2..f93e114c358 100644 --- a/airflow-core/src/airflow/ui/openapi-gen/queries/queries.ts +++ b/airflow-core/src/airflow/ui/openapi-gen/queries/queries.ts @@ -14,7 +14,7 @@ import * as Common from "./common"; * @param data.uriPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.dagIds * @param data.onlyActive -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name, uri, created_at, updated_at` * @returns AssetCollectionResponse Successful Response * @throws ApiError */ @@ -34,7 +34,7 @@ export const useAssetServiceGetAssets = <TData = Common.AssetServiceGetAssetsDef * @param data.limit * @param data.offset * @param data.namePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name` * @returns AssetAliasCollectionResponse Successful Response * @throws ApiError */ @@ -61,7 +61,7 @@ export const useAssetServiceGetAssetAlias = <TData = Common.AssetServiceGetAsset * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `source_task_id, source_dag_id, source_run_id, source_map_index, timestamp` * @param data.assetId * @param data.sourceDagId * @param data.sourceTaskId @@ -156,7 +156,7 @@ export const useAssetServiceNextRunAssets = <TData = Common.AssetServiceNextRunA * @param data.dagId * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` * @returns BackfillCollectionResponse Successful Response * @throws ApiError */ @@ -181,7 +181,7 @@ export const useBackfillServiceGetBackfill = <TData = Common.BackfillServiceGetB * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` * @param data.dagId * @param data.active * @returns BackfillCollectionResponse Successful Response @@ -211,7 +211,7 @@ export const useConnectionServiceGetConnection = <TData = Common.ConnectionServi * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `conn_id, conn_type, description, host, port, id` * @param data.connectionIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns ConnectionCollectionResponse Successful Response * @throws ApiError @@ -286,7 +286,7 @@ export const useDagRunServiceGetUpstreamAssetEvents = <TData = Common.DagRunServ * @param data.runType * @param data.state * @param data.dagVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, run_after, start_date, end_date, updated_at, conf, duration` * @param data.runIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.triggeringUserNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns DAGRunCollectionResponse Successful Response @@ -424,7 +424,7 @@ export const useConfigServiceGetConfigs = <TData = Common.ConfigServiceGetConfig * @param data.warningType * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, warning_type, message, timestamp` * @returns DAGWarningCollectionResponse Successful Response * @throws ApiError */ @@ -463,7 +463,7 @@ export const useDagWarningServiceListDagWarnings = <TData = Common.DagWarningSer * @param data.dagRunEndDateLte * @param data.dagRunEndDateLt * @param data.dagRunState -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` * @param data.isFavorite * @returns DAGCollectionResponse Successful Response * @throws ApiError @@ -524,7 +524,7 @@ export const useDagServiceGetDagDetails = <TData = Common.DagServiceGetDagDetail * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name` * @param data.tagNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns DAGTagCollectionResponse Successful Response * @throws ApiError @@ -554,7 +554,7 @@ export const useDagServiceGetDagTags = <TData = Common.DagServiceGetDagTagsDefau * @param data.lastDagRunState * @param data.bundleName * @param data.bundleVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` * @param data.isFavorite * @param data.hasAssetSchedule Filter Dags with asset-based scheduling * @param data.assetDependency Filter Dags by asset dependency (name or URI) @@ -611,7 +611,7 @@ export const useEventLogServiceGetEventLog = <TData = Common.EventLogServiceGetE * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dttm, dag_id, task_id, run_id, event, logical_date, owner, extra` * @param data.dagId * @param data.taskId * @param data.runId @@ -742,7 +742,7 @@ export const useTaskInstanceServiceGetTaskInstance = <TData = Common.TaskInstanc * @param data.mapIndex * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` * @returns TaskInstanceCollectionResponse Successful Response * @throws ApiError */ @@ -915,7 +915,7 @@ export const useTaskInstanceServiceGetMappedTaskInstance = <TData = Common.TaskI * @param data.mapIndex * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` * @returns TaskInstanceCollectionResponse Successful Response * @throws ApiError */ @@ -1066,7 +1066,7 @@ export const useTaskInstanceServiceGetHitlDetail = <TData = Common.TaskInstanceS * @param data.dagRunId * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `ti_id, subject, responded_at, created_at, responded_by_user_id, responded_by_user_name` * @param data.dagIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.taskId * @param data.taskIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. @@ -1122,7 +1122,7 @@ export const useImportErrorServiceGetImportError = <TData = Common.ImportErrorSe * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, timestamp, filename, bundle_name, stacktrace` * @param data.filenamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns ImportErrorCollectionResponse Successful Response * @throws ApiError @@ -1148,7 +1148,7 @@ export const useImportErrorServiceGetImportErrors = <TData = Common.ImportErrorS * @param data.endDateLt * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dag_id, state, job_type, start_date, end_date, latest_heartbeat, executor_class, hostname, unixname` * @param data.jobState * @param data.jobType * @param data.hostname @@ -1209,7 +1209,7 @@ export const usePoolServiceGetPool = <TData = Common.PoolServiceGetPoolDefaultRe * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, pool` * @param data.poolNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns PoolCollectionResponse Successful Response * @throws ApiError @@ -1350,7 +1350,7 @@ export const useVariableServiceGetVariable = <TData = Common.VariableServiceGetV * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted` * @param data.variableKeyPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns VariableCollectionResponse Successful Response * @throws ApiError @@ -1386,7 +1386,7 @@ export const useDagVersionServiceGetDagVersion = <TData = Common.DagVersionServi * @param data.versionNumber * @param data.bundleName * @param data.bundleVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, version_number, bundle_name, bundle_version` * @returns DAGVersionCollectionResponse Successful Response * @throws ApiError */ @@ -1510,7 +1510,7 @@ export const useStructureServiceStructureData = <TData = Common.StructureService * @param data.dagId * @param data.offset * @param data.limit -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` * @param data.runAfterGte * @param data.runAfterGt * @param data.runAfterLte @@ -1539,7 +1539,7 @@ export const useGridServiceGetDagStructure = <TData = Common.GridServiceGetDagSt * @param data.dagId * @param data.offset * @param data.limit -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` * @param data.runAfterGte * @param data.runAfterGt * @param data.runAfterLte diff --git a/airflow-core/src/airflow/ui/openapi-gen/queries/suspense.ts b/airflow-core/src/airflow/ui/openapi-gen/queries/suspense.ts index 214a5b3ed8d..3f48b71552a 100644 --- a/airflow-core/src/airflow/ui/openapi-gen/queries/suspense.ts +++ b/airflow-core/src/airflow/ui/openapi-gen/queries/suspense.ts @@ -14,7 +14,7 @@ import * as Common from "./common"; * @param data.uriPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.dagIds * @param data.onlyActive -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name, uri, created_at, updated_at` * @returns AssetCollectionResponse Successful Response * @throws ApiError */ @@ -34,7 +34,7 @@ export const useAssetServiceGetAssetsSuspense = <TData = Common.AssetServiceGetA * @param data.limit * @param data.offset * @param data.namePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name` * @returns AssetAliasCollectionResponse Successful Response * @throws ApiError */ @@ -61,7 +61,7 @@ export const useAssetServiceGetAssetAliasSuspense = <TData = Common.AssetService * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `source_task_id, source_dag_id, source_run_id, source_map_index, timestamp` * @param data.assetId * @param data.sourceDagId * @param data.sourceTaskId @@ -156,7 +156,7 @@ export const useAssetServiceNextRunAssetsSuspense = <TData = Common.AssetService * @param data.dagId * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` * @returns BackfillCollectionResponse Successful Response * @throws ApiError */ @@ -181,7 +181,7 @@ export const useBackfillServiceGetBackfillSuspense = <TData = Common.BackfillSer * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` * @param data.dagId * @param data.active * @returns BackfillCollectionResponse Successful Response @@ -211,7 +211,7 @@ export const useConnectionServiceGetConnectionSuspense = <TData = Common.Connect * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `conn_id, conn_type, description, host, port, id` * @param data.connectionIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns ConnectionCollectionResponse Successful Response * @throws ApiError @@ -286,7 +286,7 @@ export const useDagRunServiceGetUpstreamAssetEventsSuspense = <TData = Common.Da * @param data.runType * @param data.state * @param data.dagVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, run_after, start_date, end_date, updated_at, conf, duration` * @param data.runIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.triggeringUserNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns DAGRunCollectionResponse Successful Response @@ -424,7 +424,7 @@ export const useConfigServiceGetConfigsSuspense = <TData = Common.ConfigServiceG * @param data.warningType * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, warning_type, message, timestamp` * @returns DAGWarningCollectionResponse Successful Response * @throws ApiError */ @@ -463,7 +463,7 @@ export const useDagWarningServiceListDagWarningsSuspense = <TData = Common.DagWa * @param data.dagRunEndDateLte * @param data.dagRunEndDateLt * @param data.dagRunState -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` * @param data.isFavorite * @returns DAGCollectionResponse Successful Response * @throws ApiError @@ -524,7 +524,7 @@ export const useDagServiceGetDagDetailsSuspense = <TData = Common.DagServiceGetD * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name` * @param data.tagNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns DAGTagCollectionResponse Successful Response * @throws ApiError @@ -554,7 +554,7 @@ export const useDagServiceGetDagTagsSuspense = <TData = Common.DagServiceGetDagT * @param data.lastDagRunState * @param data.bundleName * @param data.bundleVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` * @param data.isFavorite * @param data.hasAssetSchedule Filter Dags with asset-based scheduling * @param data.assetDependency Filter Dags by asset dependency (name or URI) @@ -611,7 +611,7 @@ export const useEventLogServiceGetEventLogSuspense = <TData = Common.EventLogSer * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dttm, dag_id, task_id, run_id, event, logical_date, owner, extra` * @param data.dagId * @param data.taskId * @param data.runId @@ -742,7 +742,7 @@ export const useTaskInstanceServiceGetTaskInstanceSuspense = <TData = Common.Tas * @param data.mapIndex * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` * @returns TaskInstanceCollectionResponse Successful Response * @throws ApiError */ @@ -915,7 +915,7 @@ export const useTaskInstanceServiceGetMappedTaskInstanceSuspense = <TData = Comm * @param data.mapIndex * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` * @returns TaskInstanceCollectionResponse Successful Response * @throws ApiError */ @@ -1066,7 +1066,7 @@ export const useTaskInstanceServiceGetHitlDetailSuspense = <TData = Common.TaskI * @param data.dagRunId * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `ti_id, subject, responded_at, created_at, responded_by_user_id, responded_by_user_name` * @param data.dagIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.taskId * @param data.taskIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. @@ -1122,7 +1122,7 @@ export const useImportErrorServiceGetImportErrorSuspense = <TData = Common.Impor * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, timestamp, filename, bundle_name, stacktrace` * @param data.filenamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns ImportErrorCollectionResponse Successful Response * @throws ApiError @@ -1148,7 +1148,7 @@ export const useImportErrorServiceGetImportErrorsSuspense = <TData = Common.Impo * @param data.endDateLt * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dag_id, state, job_type, start_date, end_date, latest_heartbeat, executor_class, hostname, unixname` * @param data.jobState * @param data.jobType * @param data.hostname @@ -1209,7 +1209,7 @@ export const usePoolServiceGetPoolSuspense = <TData = Common.PoolServiceGetPoolD * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, pool` * @param data.poolNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns PoolCollectionResponse Successful Response * @throws ApiError @@ -1350,7 +1350,7 @@ export const useVariableServiceGetVariableSuspense = <TData = Common.VariableSer * @param data The data for the request. * @param data.limit * @param data.offset -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted` * @param data.variableKeyPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns VariableCollectionResponse Successful Response * @throws ApiError @@ -1386,7 +1386,7 @@ export const useDagVersionServiceGetDagVersionSuspense = <TData = Common.DagVers * @param data.versionNumber * @param data.bundleName * @param data.bundleVersion -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, version_number, bundle_name, bundle_version` * @returns DAGVersionCollectionResponse Successful Response * @throws ApiError */ @@ -1510,7 +1510,7 @@ export const useStructureServiceStructureDataSuspense = <TData = Common.Structur * @param data.dagId * @param data.offset * @param data.limit -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` * @param data.runAfterGte * @param data.runAfterGt * @param data.runAfterLte @@ -1539,7 +1539,7 @@ export const useGridServiceGetDagStructureSuspense = <TData = Common.GridService * @param data.dagId * @param data.offset * @param data.limit -* @param data.orderBy +* @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` * @param data.runAfterGte * @param data.runAfterGt * @param data.runAfterLte diff --git a/airflow-core/src/airflow/ui/openapi-gen/requests/services.gen.ts b/airflow-core/src/airflow/ui/openapi-gen/requests/services.gen.ts index cf8f1a731a4..d3294be6ea5 100644 --- a/airflow-core/src/airflow/ui/openapi-gen/requests/services.gen.ts +++ b/airflow-core/src/airflow/ui/openapi-gen/requests/services.gen.ts @@ -16,7 +16,7 @@ export class AssetService { * @param data.uriPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.dagIds * @param data.onlyActive - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name, uri, created_at, updated_at` * @returns AssetCollectionResponse Successful Response * @throws ApiError */ @@ -49,7 +49,7 @@ export class AssetService { * @param data.limit * @param data.offset * @param data.namePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name` * @returns AssetAliasCollectionResponse Successful Response * @throws ApiError */ @@ -102,7 +102,7 @@ export class AssetService { * @param data The data for the request. * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `source_task_id, source_dag_id, source_run_id, source_map_index, timestamp` * @param data.assetId * @param data.sourceDagId * @param data.sourceTaskId @@ -416,7 +416,7 @@ export class BackfillService { * @param data.dagId * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` * @returns BackfillCollectionResponse Successful Response * @throws ApiError */ @@ -584,7 +584,7 @@ export class BackfillService { * @param data The data for the request. * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` * @param data.dagId * @param data.active * @returns BackfillCollectionResponse Successful Response @@ -697,7 +697,7 @@ export class ConnectionService { * @param data The data for the request. * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `conn_id, conn_type, description, host, port, id` * @param data.connectionIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns ConnectionCollectionResponse Successful Response * @throws ApiError @@ -997,7 +997,7 @@ export class DagRunService { * @param data.runType * @param data.state * @param data.dagVersion - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, run_after, start_date, end_date, updated_at, conf, duration` * @param data.runIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.triggeringUserNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns DAGRunCollectionResponse Successful Response @@ -1325,7 +1325,7 @@ export class DagWarningService { * @param data.warningType * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, warning_type, message, timestamp` * @returns DAGWarningCollectionResponse Successful Response * @throws ApiError */ @@ -1379,7 +1379,7 @@ export class DagService { * @param data.dagRunEndDateLte * @param data.dagRunEndDateLt * @param data.dagRunState - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` * @param data.isFavorite * @returns DAGCollectionResponse Successful Response * @throws ApiError @@ -1630,7 +1630,7 @@ export class DagService { * @param data The data for the request. * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name` * @param data.tagNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns DAGTagCollectionResponse Successful Response * @throws ApiError @@ -1672,7 +1672,7 @@ export class DagService { * @param data.lastDagRunState * @param data.bundleName * @param data.bundleVersion - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` * @param data.isFavorite * @param data.hasAssetSchedule Filter Dags with asset-based scheduling * @param data.assetDependency Filter Dags by asset dependency (name or URI) @@ -1766,7 +1766,7 @@ export class EventLogService { * @param data The data for the request. * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dttm, dag_id, task_id, run_id, event, logical_date, owner, extra` * @param data.dagId * @param data.taskId * @param data.runId @@ -2029,7 +2029,7 @@ export class TaskInstanceService { * @param data.mapIndex * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` * @returns TaskInstanceCollectionResponse Successful Response * @throws ApiError */ @@ -2325,7 +2325,7 @@ export class TaskInstanceService { * @param data.mapIndex * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` * @returns TaskInstanceCollectionResponse Successful Response * @throws ApiError */ @@ -2759,7 +2759,7 @@ export class TaskInstanceService { * @param data.dagRunId * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `ti_id, subject, responded_at, created_at, responded_by_user_id, responded_by_user_name` * @param data.dagIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @param data.taskId * @param data.taskIdPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. @@ -2845,7 +2845,7 @@ export class ImportErrorService { * @param data The data for the request. * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, timestamp, filename, bundle_name, stacktrace` * @param data.filenamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns ImportErrorCollectionResponse Successful Response * @throws ApiError @@ -2886,7 +2886,7 @@ export class JobService { * @param data.endDateLt * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dag_id, state, job_type, start_date, end_date, latest_heartbeat, executor_class, hostname, unixname` * @param data.jobState * @param data.jobType * @param data.hostname @@ -3058,7 +3058,7 @@ export class PoolService { * @param data The data for the request. * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, pool` * @param data.poolNamePattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns PoolCollectionResponse Successful Response * @throws ApiError @@ -3478,7 +3478,7 @@ export class VariableService { * @param data The data for the request. * @param data.limit * @param data.offset - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted` * @param data.variableKeyPattern SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. * @returns VariableCollectionResponse Successful Response * @throws ApiError @@ -3614,7 +3614,7 @@ export class DagVersionService { * @param data.versionNumber * @param data.bundleName * @param data.bundleVersion - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, version_number, bundle_name, bundle_version` * @returns DAGVersionCollectionResponse Successful Response * @throws ApiError */ @@ -3867,7 +3867,7 @@ export class GridService { * @param data.dagId * @param data.offset * @param data.limit - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` * @param data.runAfterGte * @param data.runAfterGt * @param data.runAfterLte @@ -3910,7 +3910,7 @@ export class GridService { * @param data.dagId * @param data.offset * @param data.limit - * @param data.orderBy + * @param data.orderBy Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` * @param data.runAfterGte * @param data.runAfterGt * @param data.runAfterLte diff --git a/airflow-core/src/airflow/ui/openapi-gen/requests/types.gen.ts b/airflow-core/src/airflow/ui/openapi-gen/requests/types.gen.ts index 6b8306c7030..2cf869aff87 100644 --- a/airflow-core/src/airflow/ui/openapi-gen/requests/types.gen.ts +++ b/airflow-core/src/airflow/ui/openapi-gen/requests/types.gen.ts @@ -1977,6 +1977,9 @@ export type GetAssetsData = { namePattern?: string | null; offset?: number; onlyActive?: boolean; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name, uri, created_at, updated_at` + */ orderBy?: Array<(string)>; /** * SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. @@ -1993,6 +1996,9 @@ export type GetAssetAliasesData = { */ namePattern?: string | null; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name` + */ orderBy?: Array<(string)>; }; @@ -2008,6 +2014,9 @@ export type GetAssetEventsData = { assetId?: number | null; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `source_task_id, source_dag_id, source_run_id, source_map_index, timestamp` + */ orderBy?: Array<(string)>; sourceDagId?: string | null; sourceMapIndex?: number | null; @@ -2095,6 +2104,9 @@ export type ListBackfillsData = { dagId: string; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` + */ orderBy?: Array<(string)>; }; @@ -2141,6 +2153,9 @@ export type ListBackfillsUiData = { dagId?: string | null; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id` + */ orderBy?: Array<(string)>; }; @@ -2173,6 +2188,9 @@ export type GetConnectionsData = { connectionIdPattern?: string | null; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `conn_id, conn_type, description, host, port, id` + */ orderBy?: Array<(string)>; }; @@ -2251,6 +2269,9 @@ export type GetDagRunsData = { logicalDateLt?: string | null; logicalDateLte?: string | null; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, run_after, start_date, end_date, updated_at, conf, duration` + */ orderBy?: Array<(string)>; runAfterGt?: string | null; runAfterGte?: string | null; @@ -2342,6 +2363,9 @@ export type ListDagWarningsData = { dagId?: string | null; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, warning_type, message, timestamp` + */ orderBy?: Array<(string)>; warningType?: DagWarningType | null; }; @@ -2385,6 +2409,9 @@ export type GetDagsData = { lastDagRunState?: DagRunState | null; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` + */ orderBy?: Array<(string)>; owners?: Array<(string)>; paused?: boolean | null; @@ -2453,6 +2480,9 @@ export type UnfavoriteDagResponse = void; export type GetDagTagsData = { limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name` + */ orderBy?: Array<(string)>; /** * SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. @@ -2493,6 +2523,9 @@ export type GetDagsUiData = { lastDagRunState?: DagRunState | null; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `dag_id, dag_display_name, next_dagrun, state, start_date` + */ orderBy?: Array<(string)>; owners?: Array<(string)>; paused?: boolean | null; @@ -2532,6 +2565,9 @@ export type GetEventLogsData = { limit?: number; mapIndex?: number | null; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dttm, dag_id, task_id, run_id, event, logical_date, owner, extra` + */ orderBy?: Array<(string)>; owner?: string | null; /** @@ -2610,6 +2646,9 @@ export type GetMappedTaskInstancesData = { mapIndex?: Array<(number)>; offset?: number; operator?: Array<(string)>; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` + */ orderBy?: Array<(string)>; pool?: Array<(string)>; queue?: Array<(string)>; @@ -2709,6 +2748,9 @@ export type GetTaskInstancesData = { mapIndex?: Array<(number)>; offset?: number; operator?: Array<(string)>; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, duration, start_date, end_date, map_index, try_number, logical_date, run_after, data_interval_start, data_interval_end, rendered_map_index, operator` + */ orderBy?: Array<(string)>; pool?: Array<(string)>; queue?: Array<(string)>; @@ -2861,6 +2903,9 @@ export type GetHitlDetailsData = { limit?: number; mapIndex?: number | null; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `ti_id, subject, responded_at, created_at, responded_by_user_id, responded_by_user_name` + */ orderBy?: Array<(string)>; respondedByUserId?: Array<(string)>; respondedByUserName?: Array<(string)>; @@ -2892,6 +2937,9 @@ export type GetImportErrorsData = { filenamePattern?: string | null; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, timestamp, filename, bundle_name, stacktrace` + */ orderBy?: Array<(string)>; }; @@ -2909,6 +2957,9 @@ export type GetJobsData = { jobType?: string | null; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, dag_id, state, job_type, start_date, end_date, latest_heartbeat, executor_class, hostname, unixname` + */ orderBy?: Array<(string)>; startDateGt?: string | null; startDateGte?: string | null; @@ -2950,6 +3001,9 @@ export type PatchPoolResponse = PoolResponse; export type GetPoolsData = { limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, pool` + */ orderBy?: Array<(string)>; /** * SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. @@ -3083,6 +3137,9 @@ export type PatchVariableResponse = VariableResponse; export type GetVariablesData = { limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted` + */ orderBy?: Array<(string)>; /** * SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). Regular expressions are **not** supported. @@ -3123,6 +3180,9 @@ export type GetDagVersionsData = { dagId: string; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, version_number, bundle_name, bundle_version` + */ orderBy?: Array<(string)>; versionNumber?: number; }; @@ -3183,6 +3243,9 @@ export type GetDagStructureData = { dagId: string; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` + */ orderBy?: Array<(string)>; runAfterGt?: string | null; runAfterGte?: string | null; @@ -3201,6 +3264,9 @@ export type GetGridRunsData = { dagId: string; limit?: number; offset?: number; + /** + * Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `run_after, logical_date, start_date, end_date` + */ orderBy?: Array<(string)>; runAfterGt?: string | null; runAfterGte?: string | null;
