openapi: 3.1.0 info: title: Airflow Asset Task Instance API description: Airflow API. All endpoints located under ``/api/v2`` can be used safely, are stable and backward compatible. Endpoints located under ``/ui`` are dedicated to the UI and are subject to breaking change depending on the need of the frontend. Users should not rely on those but use the public ones instead. version: '2' tags: - name: Task Instance paths: /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links: get: tags: - Task Instance summary: Airflow Get Extra Links description: Get extra links for task instance. operationId: get_extra_links security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: query required: false schema: type: integer default: -1 title: Map Index responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExtraLinkCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}: get: tags: - Task Instance summary: Airflow Get Task Instance description: Get task instance. operationId: get_task_instance security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - Task Instance summary: Airflow Patch Task Instance description: Update a task instance. operationId: patch_task_instance security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: query required: false schema: anyOf: - type: integer - type: 'null' title: Map Index - name: update_mask in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Update Mask requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchTaskInstanceBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '400': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Bad Request '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '409': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Conflict '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Task Instance summary: Airflow Delete Task Instance description: Delete a task instance. operationId: delete_task_instance security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: query required: false schema: type: integer default: -1 title: Map Index responses: '200': description: Successful Response content: application/json: schema: {} '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMapped: get: tags: - Task Instance summary: Airflow Get Mapped Task Instances description: Get list of mapped task instances. operationId: get_mapped_task_instances security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: run_after_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Run After Gte - name: run_after_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Run After Gt - name: run_after_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Run After Lte - name: run_after_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Run After Lt - name: logical_date_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Gte - name: logical_date_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Gt - name: logical_date_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Lte - name: logical_date_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Lt - name: start_date_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Date Gte - name: start_date_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Date Gt - name: start_date_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Date Lte - name: start_date_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Date Lt - name: end_date_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Date Gte - name: end_date_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Date Gt - name: end_date_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Date Lte - name: end_date_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Date Lt - name: updated_at_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Updated At Gte - name: updated_at_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Updated At Gt - name: updated_at_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Updated At Lte - name: updated_at_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Updated At Lt - name: duration_gte in: query required: false schema: anyOf: - type: number - type: 'null' title: Duration Gte - name: duration_gt in: query required: false schema: anyOf: - type: number - type: 'null' title: Duration Gt - name: duration_lte in: query required: false schema: anyOf: - type: number - type: 'null' title: Duration Lte - name: duration_lt in: query required: false schema: anyOf: - type: number - type: 'null' title: Duration Lt - name: state in: query required: false schema: type: array items: type: string title: State - name: pool in: query required: false schema: type: array items: type: string title: Pool - name: pool_name_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Pool Name Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: queue in: query required: false schema: type: array items: type: string title: Queue - name: queue_name_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Queue Name Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: executor in: query required: false schema: type: array items: type: string title: Executor - name: version_number in: query required: false schema: type: array items: type: integer title: Version Number - name: try_number in: query required: false schema: type: array items: type: integer title: Try Number - name: operator in: query required: false schema: type: array items: type: string title: Operator - name: operator_name_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Operator Name Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: map_index in: query required: false schema: type: array items: type: integer title: Map Index - name: limit in: query required: false schema: type: integer minimum: 0 default: 50 title: Limit - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset - name: order_by in: query required: false schema: 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, run_after, logical_date, data_interval_start, data_interval_end`' 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, run_after, logical_date, data_interval_start, data_interval_end`' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/dependencies: get: tags: - Task Instance summary: Airflow Get Task Instance Dependencies description: Get dependencies blocking task from getting scheduled. operationId: get_task_instance_dependencies_by_map_index security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: path required: true schema: type: integer title: Map Index responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskDependencyCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dependencies: get: tags: - Task Instance summary: Airflow Get Task Instance Dependencies description: Get dependencies blocking task from getting scheduled. operationId: get_task_instance_dependencies security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: query required: false schema: type: integer default: -1 title: Map Index responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskDependencyCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/tries: get: tags: - Task Instance summary: Airflow Get Task Instance Tries description: Get list of task instances history. operationId: get_task_instance_tries security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: query required: false schema: type: integer default: -1 title: Map Index responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceHistoryCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/tries: get: tags: - Task Instance summary: Airflow Get Mapped Task Instance Tries operationId: get_mapped_task_instance_tries security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: path required: true schema: type: integer title: Map Index responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceHistoryCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}: get: tags: - Task Instance summary: Airflow Get Mapped Task Instance description: Get task instance. operationId: get_mapped_task_instance security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: path required: true schema: type: integer title: Map Index responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - Task Instance summary: Airflow Patch Task Instance description: Update a task instance. operationId: patch_task_instance_by_map_index security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: path required: true schema: anyOf: - type: integer - type: 'null' title: Map Index - name: update_mask in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Update Mask requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchTaskInstanceBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '400': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Bad Request '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '409': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Conflict '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances: get: tags: - Task Instance summary: Airflow Get Task Instances description: 'Get list of task instances. This endpoint allows specifying `~` as the dag_id, dag_run_id to retrieve task instances for all DAGs and DAG runs. Supports two pagination modes: **Offset (default):** use `limit` and `offset` query parameters. Returns `total_entries`. **Cursor:** pass `cursor` (empty string for the first page, then `next_cursor` from the response). When `cursor` is provided, `offset` is ignored and `total_entries` is not returned. ``next_cursor`` is ``null`` when there are no more pages; ``previous_cursor`` is ``null`` on the first page.' operationId: get_task_instances security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: Cursor for keyset-based pagination. Pass an empty string for the first page, then use ``next_cursor`` from the response. When ``cursor`` is provided, ``offset`` is ignored. title: Cursor description: Cursor for keyset-based pagination. Pass an empty string for the first page, then use ``next_cursor`` from the response. When ``cursor`` is provided, ``offset`` is ignored. - name: task_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Task Id - name: run_after_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Run After Gte - name: run_after_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Run After Gt - name: run_after_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Run After Lte - name: run_after_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Run After Lt - name: logical_date_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Gte - name: logical_date_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Gt - name: logical_date_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Lte - name: logical_date_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Lt - name: start_date_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Date Gte - name: start_date_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Date Gt - name: start_date_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Date Lte - name: start_date_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Date Lt - name: end_date_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Date Gte - name: end_date_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Date Gt - name: end_date_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Date Lte - name: end_date_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Date Lt - name: updated_at_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Updated At Gte - name: updated_at_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Updated At Gt - name: updated_at_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Updated At Lte - name: updated_at_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Updated At Lt - name: duration_gte in: query required: false schema: anyOf: - type: number - type: 'null' title: Duration Gte - name: duration_gt in: query required: false schema: anyOf: - type: number - type: 'null' title: Duration Gt - name: duration_lte in: query required: false schema: anyOf: - type: number - type: 'null' title: Duration Lte - name: duration_lt in: query required: false schema: anyOf: - type: number - type: 'null' title: Duration Lt - name: task_display_name_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Task Display Name Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: task_group_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by exact task group ID. Returns all tasks within the specified task group. title: Task Group Id description: Filter by exact task group ID. Returns all tasks within the specified task group. - name: dag_id_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Dag Id Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: run_id_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Run Id Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: state in: query required: false schema: type: array items: type: string title: State - name: pool in: query required: false schema: type: array items: type: string title: Pool - name: pool_name_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Pool Name Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: queue in: query required: false schema: type: array items: type: string title: Queue - name: queue_name_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Queue Name Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: executor in: query required: false schema: type: array items: type: string title: Executor - name: version_number in: query required: false schema: type: array items: type: integer title: Version Number - name: try_number in: query required: false schema: type: array items: type: integer title: Try Number - name: operator in: query required: false schema: type: array items: type: string title: Operator - name: operator_name_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Operator Name Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: map_index in: query required: false schema: type: array items: type: integer title: Map Index - name: limit in: query required: false schema: type: integer minimum: 0 default: 50 title: Limit - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset - name: order_by in: query required: false schema: 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, logical_date, run_after, data_interval_start, data_interval_end`' 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, logical_date, run_after, data_interval_start, data_interval_end`' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '400': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Bad Request '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - Task Instance summary: Airflow Bulk Task Instances description: Bulk update, and delete task instances. operationId: bulk_task_instances security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkBody_BulkTaskInstanceBody_' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BulkResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/list: post: tags: - Task Instance summary: Airflow Get Task Instances Batch description: Get list of task instances. operationId: get_task_instances_batch security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: const: '~' type: string title: Dag Id - name: dag_run_id in: path required: true schema: const: '~' type: string title: Dag Run Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TaskInstancesBatchBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/tries/{task_try_number}: get: tags: - Task Instance summary: Airflow Get Task Instance Try Details description: Get task instance details by try number. operationId: get_task_instance_try_details security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: task_try_number in: path required: true schema: type: integer title: Task Try Number - name: map_index in: query required: false schema: type: integer default: -1 title: Map Index responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceHistoryResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/tries/{task_try_number}: get: tags: - Task Instance summary: Airflow Get Mapped Task Instance Try Details operationId: get_mapped_task_instance_try_details security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: task_try_number in: path required: true schema: type: integer title: Task Try Number - name: map_index in: path required: true schema: type: integer title: Map Index responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceHistoryResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/clearTaskInstances: post: tags: - Task Instance summary: Airflow Post Clear Task Instances description: Clear task instances. operationId: post_clear_task_instances security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ClearTaskInstancesBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '409': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Conflict '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/dry_run: patch: tags: - Task Instance summary: Airflow Patch Task Instance Dry Run description: Update a task instance dry_run mode. operationId: patch_task_instance_dry_run_by_map_index security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: path required: true schema: anyOf: - type: integer - type: 'null' title: Map Index - name: update_mask in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Update Mask requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchTaskInstanceBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '400': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Bad Request '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run: patch: tags: - Task Instance summary: Airflow Patch Task Instance Dry Run description: Update a task instance dry_run mode. operationId: patch_task_instance_dry_run security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: query required: false schema: anyOf: - type: integer - type: 'null' title: Map Index - name: update_mask in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Update Mask requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchTaskInstanceBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstanceCollectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '400': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Bad Request '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{try_number}: get: tags: - Task Instance summary: Airflow Get Log description: Get logs for a specific task instance. operationId: get_log security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: try_number in: path required: true schema: type: integer minimum: 0 title: Try Number - name: full_content in: query required: false schema: type: boolean default: false title: Full Content - name: map_index in: query required: false schema: type: integer default: -1 title: Map Index - name: token in: query required: false schema: anyOf: - type: string - type: 'null' title: Token - name: accept in: header required: false schema: type: string enum: - application/json - application/x-ndjson - '*/*' default: '*/*' title: Accept responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskInstancesLogResponse' application/x-ndjson: schema: type: string example: '{"content": "content"} {"content": "content"} ' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/externalLogUrl/{try_number}: get: tags: - Task Instance summary: Airflow Get External Log Url description: Get external log URL for a specific task instance. operationId: get_external_log_url security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: try_number in: path required: true schema: type: integer exclusiveMinimum: 0 title: Try Number - name: map_index in: query required: false schema: type: integer default: -1 title: Map Index responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExternalLogUrlResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '400': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Bad Request '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/hitlDetails: patch: tags: - Task Instance summary: Airflow Update Hitl Detail description: Update a Human-in-the-loop detail. operationId: update_hitl_detail security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: path required: true schema: type: integer title: Map Index requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateHITLDetailPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HITLDetailResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '409': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Conflict '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK get: tags: - Task Instance summary: Airflow Get Hitl Detail description: Get a Human-in-the-loop detail of a specific task instance. operationId: get_hitl_detail security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: path required: true schema: type: integer title: Map Index responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HITLDetail' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/hitlDetails/tries/{try_number}: get: tags: - Task Instance summary: Airflow Get Hitl Detail Try Detail description: Get a Human-in-the-loop detail of a specific task instance. operationId: get_hitl_detail_try_detail security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: task_id in: path required: true schema: type: string title: Task Id - name: map_index in: path required: true schema: type: integer title: Map Index - name: try_number in: path required: true schema: anyOf: - type: integer - type: 'null' title: Try Number responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HITLDetailHistory' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/hitlDetails: get: tags: - Task Instance summary: Airflow Get Hitl Details description: Get Human-in-the-loop details. operationId: get_hitl_details security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: limit in: query required: false schema: type: integer minimum: 0 default: 50 title: Limit - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset - name: order_by in: query required: false schema: 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, dag_id, run_id, task_display_name, run_after, rendered_map_index, task_instance_operator, task_instance_state`' 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, dag_id, run_id, task_display_name, run_after, rendered_map_index, task_instance_operator, task_instance_state`' - name: dag_id_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Dag Id Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: task_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Task Id - name: task_id_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Task Id Pattern description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: map_index in: query required: false schema: anyOf: - type: integer - type: 'null' title: Map Index - name: state in: query required: false schema: type: array items: type: string title: State - name: response_received in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Response Received - name: responded_by_user_id in: query required: false schema: type: array items: type: string title: Responded By User Id - name: responded_by_user_name in: query required: false schema: type: array items: type: string title: Responded By User Name - name: subject_search in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Subject Search description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: body_search in: query required: false schema: anyOf: - type: string - type: 'null' description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. title: Body Search description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported. - name: created_at_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created At Gte - name: created_at_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created At Gt - name: created_at_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created At Lte - name: created_at_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created At Lt responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HITLDetailCollection' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: BulkTaskInstanceBody: properties: new_state: anyOf: - $ref: '#/components/schemas/TaskInstanceState' - type: 'null' note: anyOf: - type: string maxLength: 1000 - type: 'null' title: Note include_upstream: type: boolean title: Include Upstream default: false include_downstream: type: boolean title: Include Downstream default: false include_future: type: boolean title: Include Future default: false include_past: type: boolean title: Include Past default: false task_id: type: string title: Task Id map_index: anyOf: - type: integer - type: 'null' title: Map Index dag_id: anyOf: - type: string - type: 'null' title: Dag Id dag_run_id: anyOf: - type: string - type: 'null' title: Dag Run Id additionalProperties: false type: object required: - task_id title: BulkTaskInstanceBody description: Request body for bulk update, and delete task instances. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError HITLDetailResponse: properties: responded_by: $ref: '#/components/schemas/HITLUser' responded_at: type: string format: date-time title: Responded At chosen_options: items: type: string type: array minItems: 1 title: Chosen Options params_input: additionalProperties: true type: object title: Params Input type: object required: - responded_by - responded_at - chosen_options title: HITLDetailResponse description: Response of updating a Human-in-the-loop detail. BulkActionResponse: properties: success: items: type: string type: array title: Success description: A list of unique id/key representing successful operations. default: [] errors: items: additionalProperties: true type: object type: array title: Errors description: A list of errors encountered during the operation, each containing details about the issue. default: [] type: object title: BulkActionResponse description: 'Serializer for individual bulk action responses. Represents the outcome of a single bulk operation (create, update, or delete). The response includes a list of successful keys and any errors encountered during the operation. This structure helps users understand which key actions succeeded and which failed.' TaskDependencyCollectionResponse: properties: dependencies: items: $ref: '#/components/schemas/TaskDependencyResponse' type: array title: Dependencies type: object required: - dependencies title: TaskDependencyCollectionResponse description: Task scheduling dependencies collection serializer for responses. TaskInstanceHistoryResponse: properties: task_id: type: string title: Task Id dag_id: type: string title: Dag Id dag_run_id: type: string title: Dag Run Id map_index: type: integer title: Map Index start_date: anyOf: - type: string format: date-time - type: 'null' title: Start Date end_date: anyOf: - type: string format: date-time - type: 'null' title: End Date duration: anyOf: - type: number - type: 'null' title: Duration state: anyOf: - $ref: '#/components/schemas/TaskInstanceState' - type: 'null' try_number: type: integer title: Try Number max_tries: type: integer title: Max Tries task_display_name: type: string title: Task Display Name dag_display_name: type: string title: Dag Display Name hostname: anyOf: - type: string - type: 'null' title: Hostname unixname: anyOf: - type: string - type: 'null' title: Unixname pool: type: string title: Pool pool_slots: type: integer title: Pool Slots queue: anyOf: - type: string - type: 'null' title: Queue priority_weight: anyOf: - type: integer - type: 'null' title: Priority Weight operator: anyOf: - type: string - type: 'null' title: Operator operator_name: anyOf: - type: string - type: 'null' title: Operator Name queued_when: anyOf: - type: string format: date-time - type: 'null' title: Queued When scheduled_when: anyOf: - type: string format: date-time - type: 'null' title: Scheduled When pid: anyOf: - type: integer - type: 'null' title: Pid executor: anyOf: - type: string - type: 'null' title: Executor executor_config: type: string title: Executor Config dag_version: anyOf: - $ref: '#/components/schemas/DagVersionResponse' - type: 'null' type: object required: - task_id - dag_id - dag_run_id - map_index - start_date - end_date - duration - state - try_number - max_tries - task_display_name - dag_display_name - hostname - unixname - pool - pool_slots - queue - priority_weight - operator - operator_name - queued_when - scheduled_when - pid - executor - executor_config - dag_version title: TaskInstanceHistoryResponse description: TaskInstanceHistory serializer for responses. TaskInstanceState: type: string enum: - removed - scheduled - queued - running - success - restarting - failed - up_for_retry - up_for_reschedule - upstream_failed - skipped - deferred title: TaskInstanceState description: 'All possible states that a Task Instance can be in. Note that None is also allowed, so always use this in a type hint with Optional.' JobResponse: properties: id: type: integer title: Id dag_id: anyOf: - type: string - type: 'null' title: Dag Id state: anyOf: - type: string - type: 'null' title: State job_type: anyOf: - type: string - type: 'null' title: Job Type start_date: anyOf: - type: string format: date-time - type: 'null' title: Start Date end_date: anyOf: - type: string format: date-time - type: 'null' title: End Date latest_heartbeat: anyOf: - type: string format: date-time - type: 'null' title: Latest Heartbeat executor_class: anyOf: - type: string - type: 'null' title: Executor Class hostname: anyOf: - type: string - type: 'null' title: Hostname unixname: anyOf: - type: string - type: 'null' title: Unixname dag_display_name: anyOf: - type: string - type: 'null' title: Dag Display Name type: object required: - id - dag_id - state - job_type - start_date - end_date - latest_heartbeat - executor_class - hostname - unixname title: JobResponse description: Job serializer for responses. HITLDetailHistory: properties: options: items: type: string type: array minItems: 1 title: Options subject: type: string title: Subject body: anyOf: - type: string - type: 'null' title: Body defaults: anyOf: - items: type: string type: array - type: 'null' title: Defaults multiple: type: boolean title: Multiple default: false params: additionalProperties: true type: object title: Params assigned_users: items: $ref: '#/components/schemas/HITLUser' type: array title: Assigned Users created_at: type: string format: date-time title: Created At responded_by_user: anyOf: - $ref: '#/components/schemas/HITLUser' - type: 'null' responded_at: anyOf: - type: string format: date-time - type: 'null' title: Responded At chosen_options: anyOf: - items: type: string type: array - type: 'null' title: Chosen Options params_input: additionalProperties: true type: object title: Params Input response_received: type: boolean title: Response Received default: false task_instance: $ref: '#/components/schemas/TaskInstanceHistoryResponse' type: object required: - options - subject - created_at - task_instance title: HITLDetailHistory description: Schema for Human-in-the-loop detail history. UpdateHITLDetailPayload: properties: chosen_options: items: type: string type: array minItems: 1 title: Chosen Options params_input: additionalProperties: true type: object title: Params Input type: object required: - chosen_options title: UpdateHITLDetailPayload description: Schema for updating the content of a Human-in-the-loop detail. BulkResponse: properties: create: anyOf: - $ref: '#/components/schemas/BulkActionResponse' - type: 'null' description: Details of the bulk create operation, including successful keys and errors. update: anyOf: - $ref: '#/components/schemas/BulkActionResponse' - type: 'null' description: Details of the bulk update operation, including successful keys and errors. delete: anyOf: - $ref: '#/components/schemas/BulkActionResponse' - type: 'null' description: Details of the bulk delete operation, including successful keys and errors. type: object title: BulkResponse description: 'Serializer for responses to bulk entity operations. This represents the results of create, update, and delete actions performed on entity in bulk. Each action (if requested) is represented as a field containing details about successful keys and any encountered errors. Fields are populated in the response only if the respective action was part of the request, else are set None.' DagVersionResponse: properties: id: type: string format: uuid title: Id version_number: type: integer title: Version Number dag_id: type: string title: Dag Id bundle_name: anyOf: - type: string - type: 'null' title: Bundle Name bundle_version: anyOf: - type: string - type: 'null' title: Bundle Version created_at: type: string format: date-time title: Created At dag_display_name: type: string title: Dag Display Name bundle_url: anyOf: - type: string - type: 'null' title: Bundle Url type: object required: - id - version_number - dag_id - bundle_name - bundle_version - created_at - dag_display_name - bundle_url title: DagVersionResponse description: Dag Version serializer for responses. TaskInstanceResponse: properties: id: type: string format: uuid title: Id task_id: type: string title: Task Id dag_id: type: string title: Dag Id dag_run_id: type: string title: Dag Run Id map_index: type: integer title: Map Index logical_date: anyOf: - type: string format: date-time - type: 'null' title: Logical Date run_after: type: string format: date-time title: Run After start_date: anyOf: - type: string format: date-time - type: 'null' title: Start Date end_date: anyOf: - type: string format: date-time - type: 'null' title: End Date duration: anyOf: - type: number - type: 'null' title: Duration state: anyOf: - $ref: '#/components/schemas/TaskInstanceState' - type: 'null' try_number: type: integer title: Try Number max_tries: type: integer title: Max Tries task_display_name: type: string title: Task Display Name dag_display_name: type: string title: Dag Display Name hostname: anyOf: - type: string - type: 'null' title: Hostname unixname: anyOf: - type: string - type: 'null' title: Unixname pool: type: string title: Pool pool_slots: type: integer title: Pool Slots queue: anyOf: - type: string - type: 'null' title: Queue priority_weight: anyOf: - type: integer - type: 'null' title: Priority Weight operator: anyOf: - type: string - type: 'null' title: Operator operator_name: anyOf: - type: string - type: 'null' title: Operator Name queued_when: anyOf: - type: string format: date-time - type: 'null' title: Queued When scheduled_when: anyOf: - type: string format: date-time - type: 'null' title: Scheduled When pid: anyOf: - type: integer - type: 'null' title: Pid executor: anyOf: - type: string - type: 'null' title: Executor executor_config: type: string title: Executor Config note: anyOf: - type: string - type: 'null' title: Note rendered_map_index: anyOf: - type: string - type: 'null' title: Rendered Map Index rendered_fields: additionalProperties: true type: object title: Rendered Fields trigger: anyOf: - $ref: '#/components/schemas/TriggerResponse' - type: 'null' triggerer_job: anyOf: - $ref: '#/components/schemas/JobResponse' - type: 'null' dag_version: anyOf: - $ref: '#/components/schemas/DagVersionResponse' - type: 'null' type: object required: - id - task_id - dag_id - dag_run_id - map_index - logical_date - run_after - start_date - end_date - duration - state - try_number - max_tries - task_display_name - dag_display_name - hostname - unixname - pool - pool_slots - queue - priority_weight - operator - operator_name - queued_when - scheduled_when - pid - executor - executor_config - note - rendered_map_index - trigger - triggerer_job - dag_version title: TaskInstanceResponse description: TaskInstance serializer for responses. BulkBody_BulkTaskInstanceBody_: properties: actions: items: oneOf: - $ref: '#/components/schemas/BulkCreateAction_BulkTaskInstanceBody_' - $ref: '#/components/schemas/BulkUpdateAction_BulkTaskInstanceBody_' - $ref: '#/components/schemas/BulkDeleteAction_BulkTaskInstanceBody_' type: array title: Actions additionalProperties: false type: object required: - actions title: BulkBody[BulkTaskInstanceBody] TaskInstanceCollectionResponse: properties: task_instances: items: $ref: '#/components/schemas/TaskInstanceResponse' type: array title: Task Instances total_entries: anyOf: - type: integer - type: 'null' title: Total Entries description: Total number of matching items. Populated for offset pagination, ``null`` when using cursor pagination. next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: Token pointing to the next page. Populated for cursor pagination, ``null`` when using offset pagination or when there is no next page. previous_cursor: anyOf: - type: string - type: 'null' title: Previous Cursor description: Token pointing to the previous page. Populated for cursor pagination, ``null`` when using offset pagination or when on the first page. type: object required: - task_instances title: TaskInstanceCollectionResponse description: 'Task instance collection response supporting both offset and cursor pagination. A single flat model is used instead of a discriminated union (``Annotated[Offset | Cursor, Field(discriminator=...)]``) because the OpenAPI ``oneOf`` + ``discriminator`` construct is not handled correctly by ``@hey-api/openapi-ts`` / ``@7nohe/openapi-react-query-codegen``: return types degrade to ``unknown`` in JSDoc and can produce incorrect TypeScript types (see hey-api/openapi-ts#1613, #3270).' HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError StructuredLogMessage: properties: timestamp: type: string format: date-time title: Timestamp event: type: string title: Event additionalProperties: true type: object required: - event title: StructuredLogMessage description: An individual log message. BulkUpdateAction_BulkTaskInstanceBody_: properties: action: type: string const: update title: Action description: The action to be performed on the entities. entities: items: $ref: '#/components/schemas/BulkTaskInstanceBody' type: array title: Entities description: A list of entities to be updated. update_mask: anyOf: - items: type: string type: array - type: 'null' title: Update Mask description: A list of field names to update for each entity.Only these fields will be applied from the request body to the database model.Any extra fields provided will be ignored. action_on_non_existence: $ref: '#/components/schemas/BulkActionNotOnExistence' default: fail additionalProperties: false type: object required: - action - entities title: BulkUpdateAction[BulkTaskInstanceBody] BulkActionNotOnExistence: type: string enum: - fail - skip title: BulkActionNotOnExistence description: Bulk Action to be taken if the entity does not exist. BulkDeleteAction_BulkTaskInstanceBody_: properties: action: type: string const: delete title: Action description: The action to be performed on the entities. entities: items: anyOf: - type: string - $ref: '#/components/schemas/BulkTaskInstanceBody' type: array title: Entities description: A list of entity id/key or entity objects to be deleted. action_on_non_existence: $ref: '#/components/schemas/BulkActionNotOnExistence' default: fail additionalProperties: false type: object required: - action - entities title: BulkDeleteAction[BulkTaskInstanceBody] HITLDetail: properties: options: items: type: string type: array minItems: 1 title: Options subject: type: string title: Subject body: anyOf: - type: string - type: 'null' title: Body defaults: anyOf: - items: type: string type: array - type: 'null' title: Defaults multiple: type: boolean title: Multiple default: false params: additionalProperties: true type: object title: Params assigned_users: items: $ref: '#/components/schemas/HITLUser' type: array title: Assigned Users created_at: type: string format: date-time title: Created At responded_by_user: anyOf: - $ref: '#/components/schemas/HITLUser' - type: 'null' responded_at: anyOf: - type: string format: date-time - type: 'null' title: Responded At chosen_options: anyOf: - items: type: string type: array - type: 'null' title: Chosen Options params_input: additionalProperties: true type: object title: Params Input response_received: type: boolean title: Response Received default: false task_instance: $ref: '#/components/schemas/TaskInstanceResponse' type: object required: - options - subject - created_at - task_instance title: HITLDetail description: Schema for Human-in-the-loop detail. BulkCreateAction_BulkTaskInstanceBody_: properties: action: type: string const: create title: Action description: The action to be performed on the entities. entities: items: $ref: '#/components/schemas/BulkTaskInstanceBody' type: array title: Entities description: A list of entities to be created. action_on_existence: $ref: '#/components/schemas/BulkActionOnExistence' default: fail additionalProperties: false type: object required: - action - entities title: BulkCreateAction[BulkTaskInstanceBody] HITLDetailCollection: properties: hitl_details: items: $ref: '#/components/schemas/HITLDetail' type: array title: Hitl Details total_entries: type: integer title: Total Entries type: object required: - hitl_details - total_entries title: HITLDetailCollection description: Schema for a collection of Human-in-the-loop details. BulkActionOnExistence: type: string enum: - fail - skip - overwrite title: BulkActionOnExistence description: Bulk Action to be taken if the entity already exists or not. ExternalLogUrlResponse: properties: url: type: string title: Url type: object required: - url title: ExternalLogUrlResponse description: Response for the external log URL endpoint. TriggerResponse: properties: id: type: integer title: Id classpath: type: string title: Classpath kwargs: type: string title: Kwargs created_date: type: string format: date-time title: Created Date queue: anyOf: - type: string - type: 'null' title: Queue triggerer_id: anyOf: - type: integer - type: 'null' title: Triggerer Id type: object required: - id - classpath - kwargs - created_date - queue - triggerer_id title: TriggerResponse description: Trigger serializer for responses. HITLUser: properties: id: type: string title: Id name: type: string title: Name type: object required: - id - name title: HITLUser description: Schema for a Human-in-the-loop users. TaskDependencyResponse: properties: name: type: string title: Name reason: type: string title: Reason type: object required: - name - reason title: TaskDependencyResponse description: Task Dependency serializer for responses. ClearTaskInstancesBody: properties: dry_run: type: boolean title: Dry Run default: true start_date: anyOf: - type: string format: date-time - type: 'null' title: Start Date end_date: anyOf: - type: string format: date-time - type: 'null' title: End Date only_failed: type: boolean title: Only Failed default: true only_running: type: boolean title: Only Running default: false reset_dag_runs: type: boolean title: Reset Dag Runs default: true task_ids: anyOf: - items: anyOf: - type: string - prefixItems: - type: string - type: integer type: array maxItems: 2 minItems: 2 type: array - type: 'null' title: Task Ids description: A list of `task_id` or [`task_id`, `map_index`]. If only the `task_id` is provided for a mapped task, all of its map indices will be targeted. dag_run_id: anyOf: - type: string - type: 'null' title: Dag Run Id include_upstream: type: boolean title: Include Upstream default: false include_downstream: type: boolean title: Include Downstream default: false include_future: type: boolean title: Include Future default: false include_past: type: boolean title: Include Past default: false run_on_latest_version: type: boolean title: Run On Latest Version description: (Experimental) Run on the latest bundle version of the dag after clearing the task instances. default: false prevent_running_task: type: boolean title: Prevent Running Task default: false note: anyOf: - type: string maxLength: 1000 - type: 'null' title: Note additionalProperties: false type: object title: ClearTaskInstancesBody description: Request body for Clear Task Instances endpoint. TaskInstanceHistoryCollectionResponse: properties: task_instances: items: $ref: '#/components/schemas/TaskInstanceHistoryResponse' type: array title: Task Instances total_entries: type: integer title: Total Entries type: object required: - task_instances - total_entries title: TaskInstanceHistoryCollectionResponse description: TaskInstanceHistory Collection serializer for responses. ExtraLinkCollectionResponse: properties: extra_links: additionalProperties: anyOf: - type: string - type: 'null' type: object title: Extra Links total_entries: type: integer title: Total Entries type: object required: - extra_links - total_entries title: ExtraLinkCollectionResponse description: Extra Links Response. HTTPExceptionResponse: properties: detail: anyOf: - type: string - additionalProperties: true type: object title: Detail type: object required: - detail title: HTTPExceptionResponse description: HTTPException Model used for error response. TaskInstancesLogResponse: properties: content: anyOf: - items: $ref: '#/components/schemas/StructuredLogMessage' type: array - items: type: string type: array title: Content continuation_token: anyOf: - type: string - type: 'null' title: Continuation Token type: object required: - content - continuation_token title: TaskInstancesLogResponse description: Log serializer for responses. TaskInstancesBatchBody: properties: dag_ids: anyOf: - items: type: string type: array - type: 'null' title: Dag Ids dag_run_ids: anyOf: - items: type: string type: array - type: 'null' title: Dag Run Ids task_ids: anyOf: - items: type: string type: array - type: 'null' title: Task Ids state: anyOf: - items: anyOf: - $ref: '#/components/schemas/TaskInstanceState' - type: 'null' type: array - type: 'null' title: State run_after_gte: anyOf: - type: string format: date-time - type: 'null' title: Run After Gte run_after_gt: anyOf: - type: string format: date-time - type: 'null' title: Run After Gt run_after_lte: anyOf: - type: string format: date-time - type: 'null' title: Run After Lte run_after_lt: anyOf: - type: string format: date-time - type: 'null' title: Run After Lt logical_date_gte: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Gte logical_date_gt: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Gt logical_date_lte: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Lte logical_date_lt: anyOf: - type: string format: date-time - type: 'null' title: Logical Date Lt start_date_gte: anyOf: - type: string format: date-time - type: 'null' title: Start Date Gte start_date_gt: anyOf: - type: string format: date-time - type: 'null' title: Start Date Gt start_date_lte: anyOf: - type: string format: date-time - type: 'null' title: Start Date Lte start_date_lt: anyOf: - type: string format: date-time - type: 'null' title: Start Date Lt end_date_gte: anyOf: - type: string format: date-time - type: 'null' title: End Date Gte end_date_gt: anyOf: - type: string format: date-time - type: 'null' title: End Date Gt end_date_lte: anyOf: - type: string format: date-time - type: 'null' title: End Date Lte end_date_lt: anyOf: - type: string format: date-time - type: 'null' title: End Date Lt duration_gte: anyOf: - type: number - type: 'null' title: Duration Gte duration_gt: anyOf: - type: number - type: 'null' title: Duration Gt duration_lte: anyOf: - type: number - type: 'null' title: Duration Lte duration_lt: anyOf: - type: number - type: 'null' title: Duration Lt pool: anyOf: - items: type: string type: array - type: 'null' title: Pool queue: anyOf: - items: type: string type: array - type: 'null' title: Queue executor: anyOf: - items: type: string type: array - type: 'null' title: Executor page_offset: type: integer minimum: 0.0 title: Page Offset default: 0 page_limit: type: integer minimum: 0.0 title: Page Limit default: 100 order_by: anyOf: - type: string - type: 'null' title: Order By additionalProperties: false type: object title: TaskInstancesBatchBody description: Task Instance body for get batch. PatchTaskInstanceBody: properties: new_state: anyOf: - $ref: '#/components/schemas/TaskInstanceState' - type: 'null' note: anyOf: - type: string maxLength: 1000 - type: 'null' title: Note include_upstream: type: boolean title: Include Upstream default: false include_downstream: type: boolean title: Include Downstream default: false include_future: type: boolean title: Include Future default: false include_past: type: boolean title: Include Past default: false additionalProperties: false type: object title: PatchTaskInstanceBody description: Request body for Clear Task Instances endpoint. securitySchemes: OAuth2PasswordBearer: type: oauth2 description: To authenticate Airflow API requests, clients must include a JWT (JSON Web Token) in the Authorization header of each request. This token is used to verify the identity of the client and ensure that they have the appropriate permissions to access the requested resources. You can use the endpoint ``POST /auth/token`` in order to generate a JWT token. Upon successful authentication, the server will issue a JWT token that contains the necessary information (such as user identity and scope) to authenticate subsequent requests. To learn more about Airflow public API authentication, please read https://airflow.apache.org/docs/apache-airflow/stable/security/api.html. flows: password: scopes: {} tokenUrl: /auth/token HTTPBearer: type: http scheme: bearer