openapi: 3.1.0 info: title: Airflow 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' paths: /api/v2/assets: get: tags: - Asset summary: Airflow Get Assets description: Get assets. operationId: get_assets security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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: 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: 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: uri_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: Uri 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: dag_ids in: query required: false schema: type: array items: type: string title: Dag Ids - name: only_active in: query required: false schema: type: boolean default: true title: Only Active - 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, 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 content: application/json: schema: $ref: '#/components/schemas/AssetCollectionResponse' '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/assets/aliases: get: tags: - Asset summary: Airflow Get Asset Aliases description: Get asset aliases. operationId: get_asset_aliases security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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: 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: 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: 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, 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 content: application/json: schema: $ref: '#/components/schemas/AssetAliasCollectionResponse' '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/assets/aliases/{asset_alias_id}: get: tags: - Asset summary: Airflow Get Asset Alias description: Get an asset alias. operationId: get_asset_alias security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: asset_alias_id in: path required: true schema: type: integer title: Asset Alias Id 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/assets/events: get: tags: - Asset summary: Airflow Get Asset Events description: Get asset events. operationId: get_asset_events security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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: `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 schema: anyOf: - type: integer - type: 'null' title: Asset Id - name: source_dag_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Source Dag Id - name: source_task_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Source Task Id - name: source_run_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Source Run Id - name: source_map_index in: query required: false schema: anyOf: - type: integer - type: 'null' title: Source Map Index - name: 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: 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: timestamp_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Timestamp Gte - name: timestamp_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Timestamp Gt - name: timestamp_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Timestamp Lte - name: timestamp_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Timestamp Lt responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AssetEventCollectionResponse' '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 post: tags: - Asset summary: Airflow Create Asset Event description: Create asset events. operationId: create_asset_event security: - OAuth2PasswordBearer: [] - HTTPBearer: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAssetEventsBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AssetEventResponse' '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/assets/{asset_id}/materialize: post: tags: - Asset summary: Airflow Materialize Asset description: Materialize an asset by triggering a DAG run that produces it. operationId: materialize_asset security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: asset_id in: path required: true schema: type: integer title: Asset Id requestBody: content: application/json: schema: anyOf: - $ref: '#/components/schemas/MaterializeAssetBody' - type: 'null' title: Body responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGRunResponse' '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/assets/{asset_id}/queuedEvents: get: tags: - Asset summary: Airflow Get Asset Queued Events description: Get queued asset events for an asset. operationId: get_asset_queued_events security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: asset_id in: path required: true schema: type: integer title: Asset Id - name: before in: query required: false schema: anyOf: - type: string - type: 'null' title: Before responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/QueuedEventCollectionResponse' '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 delete: tags: - Asset summary: Airflow Delete Asset Queued Events description: Delete queued asset events for an asset. operationId: delete_asset_queued_events security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: asset_id in: path required: true schema: type: integer title: Asset Id - name: before in: query required: false schema: anyOf: - type: string - type: 'null' title: Before responses: '204': description: Successful Response '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/assets/{asset_id}: get: tags: - Asset summary: Airflow Get Asset description: Get an asset. operationId: get_asset security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: asset_id in: path required: true schema: type: integer title: Asset Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AssetResponse' '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}/assets/queuedEvents: get: tags: - Asset summary: Airflow Get Dag Asset Queued Events description: Get queued asset events for a DAG. operationId: get_dag_asset_queued_events security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: before in: query required: false schema: anyOf: - type: string - type: 'null' title: Before responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/QueuedEventCollectionResponse' '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 delete: tags: - Asset summary: Airflow Delete Dag Asset Queued Events operationId: delete_dag_asset_queued_events security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: before in: query required: false schema: anyOf: - type: string - type: 'null' title: Before responses: '204': description: Successful Response '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}/assets/{asset_id}/queuedEvents: get: tags: - Asset summary: Airflow Get Dag Asset Queued Event description: Get a queued asset event for a DAG. operationId: get_dag_asset_queued_event security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: asset_id in: path required: true schema: type: integer title: Asset Id - name: before in: query required: false schema: anyOf: - type: string - type: 'null' title: Before responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/QueuedEventResponse' '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 delete: tags: - Asset summary: Airflow Delete Dag Asset Queued Event description: Delete a queued asset event for a DAG. operationId: delete_dag_asset_queued_event security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: asset_id in: path required: true schema: type: integer title: Asset Id - name: before in: query required: false schema: anyOf: - type: string - type: 'null' title: Before responses: '204': description: Successful Response '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/backfills: get: tags: - Backfill summary: Airflow List Backfills operationId: list_backfills security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: query required: true schema: type: string title: Dag 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: `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 content: application/json: schema: $ref: '#/components/schemas/BackfillCollectionResponse' '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 post: tags: - Backfill summary: Airflow Create Backfill operationId: create_backfill security: - OAuth2PasswordBearer: [] - HTTPBearer: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BackfillPostBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BackfillResponse' '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/backfills/{backfill_id}: get: tags: - Backfill summary: Airflow Get Backfill operationId: get_backfill security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: backfill_id in: path required: true schema: type: integer minimum: 0 title: Backfill Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BackfillResponse' '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/backfills/{backfill_id}/pause: put: tags: - Backfill summary: Airflow Pause Backfill operationId: pause_backfill security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: backfill_id in: path required: true schema: type: integer minimum: 0 title: Backfill Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BackfillResponse' '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/backfills/{backfill_id}/unpause: put: tags: - Backfill summary: Airflow Unpause Backfill operationId: unpause_backfill security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: backfill_id in: path required: true schema: type: integer minimum: 0 title: Backfill Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BackfillResponse' '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/backfills/{backfill_id}/cancel: put: tags: - Backfill summary: Airflow Cancel Backfill operationId: cancel_backfill security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: backfill_id in: path required: true schema: type: integer minimum: 0 title: Backfill Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BackfillResponse' '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/backfills/dry_run: post: tags: - Backfill summary: Airflow Create Backfill Dry Run operationId: create_backfill_dry_run requestBody: content: application/json: schema: $ref: '#/components/schemas/BackfillPostBody' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DryRunBackfillCollectionResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OAuth2PasswordBearer: [] - HTTPBearer: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/connections/{connection_id}: delete: tags: - Connection summary: Airflow Delete Connection description: Delete a connection entry. operationId: delete_connection security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: connection_id in: path required: true schema: type: string title: Connection Id responses: '204': description: Successful Response '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 get: tags: - Connection summary: Airflow Get Connection description: Get a connection entry. operationId: get_connection security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: connection_id in: path required: true schema: type: string title: Connection Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectionResponse' '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: - Connection summary: Airflow Patch Connection description: Update a connection entry. operationId: patch_connection security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: connection_id in: path required: true schema: type: string title: Connection Id - 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/ConnectionBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectionResponse' '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/connections: get: tags: - Connection summary: Airflow Get Connections description: Get all connection entries. operationId: get_connections security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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: `conn_id, conn_type, description, host, port, id, team_name, connection_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, team_name, connection_id`' - name: connection_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: Connection 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." responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectionCollectionResponse' '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 post: tags: - Connection summary: Airflow Post Connection description: Create connection entry. operationId: post_connection security: - OAuth2PasswordBearer: [] - HTTPBearer: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectionBody' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectionResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '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 patch: tags: - Connection summary: Airflow Bulk Connections description: Bulk create, update, and delete connections. operationId: bulk_connections security: - OAuth2PasswordBearer: [] - HTTPBearer: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkBody_ConnectionBody_' 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/connections/test: post: tags: - Connection summary: Airflow Test Connection description: 'Test an API connection. This method first creates an in-memory transient conn_id & exports that to an env var, as some hook classes tries to find out the `conn` from their __init__ method & errors out if not found. It also deletes the conn id env connection after the test.' operationId: test_connection requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionBody' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectionTestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OAuth2PasswordBearer: [] - HTTPBearer: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/connections/defaults: post: tags: - Connection summary: Airflow Create Default Connections description: Create default connections. operationId: create_default_connections responses: '204': description: Successful Response '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' security: - OAuth2PasswordBearer: [] - HTTPBearer: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}: get: tags: - DagRun summary: Airflow Get Dag Run operationId: get_dag_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 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGRunResponse' '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 delete: tags: - DagRun summary: Airflow Delete Dag Run description: Delete a DAG Run entry. operationId: delete_dag_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 responses: '204': description: Successful Response '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: - DagRun summary: Airflow Patch Dag Run description: Modify a DAG Run. operationId: patch_dag_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: 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/DAGRunPatchBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGRunResponse' '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}/upstreamAssetEvents: get: tags: - DagRun summary: Airflow Get Upstream Asset Events description: If dag run is asset-triggered, return the asset events that triggered it. operationId: get_upstream_asset_events 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 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AssetEventCollectionResponse' '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}/clear: post: tags: - DagRun summary: Airflow Clear Dag Run operationId: clear_dag_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 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DAGRunClearBody' responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/TaskInstanceCollectionResponse' - $ref: '#/components/schemas/DAGRunResponse' title: Response Clear Dag Run '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: get: tags: - DagRun summary: Airflow Get Dag Runs description: 'Get all DAG Runs. This endpoint allows specifying `~` as the dag_id to retrieve Dag Runs for all DAGs.' operationId: get_dag_runs security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag 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: 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: 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: 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: conf_contains in: query required: false schema: type: string title: Conf Contains - name: run_type in: query required: false schema: type: array items: type: string title: Run Type - name: state in: query required: false schema: type: array items: type: string title: State - name: dag_version in: query required: false schema: type: array items: type: integer title: Dag Version - name: bundle_version in: query required: false schema: anyOf: - type: string - type: 'null' title: Bundle Version - 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, dag_id, run_id, logical_date, run_after, start_date, end_date, updated_at, conf, duration, dag_run_id`' 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, dag_run_id`' - 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: triggering_user_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: Triggering User 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: 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: partition_key_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: Partition Key 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: consuming_asset_pattern in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by consuming asset name or URI using pattern matching title: Consuming Asset Pattern description: Filter by consuming asset name or URI using pattern matching responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGRunCollectionResponse' '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 post: tags: - DagRun summary: Airflow Trigger Dag Run description: Trigger a DAG. operationId: trigger_dag_run security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: title: Dag Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TriggerDAGRunPostBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGRunResponse' '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}/wait: get: tags: - DagRun - experimental summary: 'Airflow Experimental: Wait for a Dag Run to Complete, and Return Task Results if Requested.' description: "🚧 This is an experimental endpoint and may change or be removed without notice.Successful response are streamed as newline-delimited JSON (NDJSON). Each line is a JSON object representing the DAG run state." operationId: wait_dag_run_until_finished 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: interval in: query required: true schema: type: number exclusiveMinimum: 0.0 description: Seconds to wait between dag run state checks title: Interval description: Seconds to wait between dag run state checks - name: result in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' description: Collect result XCom from task. Can be set multiple times. title: Result description: Collect result XCom from task. Can be set multiple times. responses: '200': description: Successful Response content: application/json: schema: {} application/x-ndjson: schema: type: string example: '{"state": "running"} {"state": "success", "results": {"op": 42}} ' '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/list: post: tags: - DagRun summary: Airflow Get List Dag Runs Batch description: Get a list of DAG Runs. operationId: get_list_dag_runs_batch security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: const: '~' type: string title: Dag Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DAGRunsBatchBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGRunCollectionResponse' '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/dagSources/{dag_id}: get: tags: - DagSource summary: Airflow Get Dag Source description: Get source code using file token. operationId: get_dag_source security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: version_number in: query required: false schema: anyOf: - type: integer - type: 'null' title: Version Number - name: accept in: header required: false schema: type: string enum: - application/json - text/plain - '*/*' default: '*/*' title: Accept responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGSourceResponse' text/plain: schema: type: string example: dag code '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 '406': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Acceptable '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dagStats: get: tags: - DagStats summary: Airflow Get Dag Stats description: Get Dag statistics. operationId: get_dag_stats security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_ids in: query required: false schema: type: array items: type: string title: Dag Ids responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DagStatsCollectionResponse' '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/config: get: tags: - Config summary: Airflow Get Config operationId: get_config security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: section in: query required: false schema: anyOf: - type: string - type: 'null' title: Section - name: accept in: header required: false schema: type: string enum: - application/json - text/plain - '*/*' default: '*/*' title: Accept responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Config' text/plain: schema: type: string example: '[core] dags_folder = /opt/airflow/dags base_log_folder = /opt/airflow/logs [smtp] smtp_host = localhost smtp_mail_from = airflow@example.com ' '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 '406': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Acceptable '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/config/section/{section}/option/{option}: get: tags: - Config summary: Airflow Get Config Value operationId: get_config_value security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: section in: path required: true schema: type: string title: Section - name: option in: path required: true schema: type: string title: Option - name: accept in: header required: false schema: type: string enum: - application/json - text/plain - '*/*' default: '*/*' title: Accept responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Config' text/plain: schema: type: string example: '[core] dags_folder = /opt/airflow/dags base_log_folder = /opt/airflow/logs ' '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 '406': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not Acceptable '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dagWarnings: get: tags: - DagWarning summary: Airflow List Dag Warnings description: Get a list of DAG warnings. operationId: list_dag_warnings security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Dag Id - name: warning_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/DagWarningType' - type: 'null' title: Warning Type - 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: `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 content: application/json: schema: $ref: '#/components/schemas/DAGWarningCollectionResponse' '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: get: tags: - DAG summary: Airflow Get Dags description: Get all DAGs. operationId: get_dags security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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: tags in: query required: false schema: type: array items: type: string title: Tags - name: tags_match_mode in: query required: false schema: anyOf: - enum: - any - all type: string - type: 'null' title: Tags Match Mode - name: owners in: query required: false schema: type: array items: type: string title: Owners - 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: dag_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: Dag 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: exclude_stale in: query required: false schema: type: boolean default: true title: Exclude Stale - name: paused in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Paused - name: has_import_errors in: query required: false schema: anyOf: - type: boolean - type: 'null' description: Filter Dags by having import errors. Only Dags that have been successfully loaded before will be returned. title: Has Import Errors description: Filter Dags by having import errors. Only Dags that have been successfully loaded before will be returned. - name: last_dag_run_state in: query required: false schema: anyOf: - $ref: '#/components/schemas/DagRunState' - type: 'null' title: Last Dag Run State - name: bundle_name in: query required: false schema: anyOf: - type: string - type: 'null' title: Bundle Name - name: bundle_version in: query required: false schema: anyOf: - type: string - type: 'null' title: Bundle Version - name: has_asset_schedule in: query required: false schema: anyOf: - type: boolean - type: 'null' description: Filter Dags with asset-based scheduling title: Has Asset Schedule description: Filter Dags with asset-based scheduling - name: asset_dependency in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter Dags by asset dependency (name or URI) title: Asset Dependency description: Filter Dags by asset dependency (name or URI) - name: dag_run_start_date_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Dag Run Start Date Gte - name: dag_run_start_date_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Dag Run Start Date Gt - name: dag_run_start_date_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Dag Run Start Date Lte - name: dag_run_start_date_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Dag Run Start Date Lt - name: dag_run_end_date_gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Dag Run End Date Gte - name: dag_run_end_date_gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Dag Run End Date Gt - name: dag_run_end_date_lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Dag Run End Date Lte - name: dag_run_end_date_lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Dag Run End Date Lt - name: dag_run_state in: query required: false schema: type: array items: type: string title: Dag Run State - 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: `dag_id, dag_display_name, next_dagrun, state, start_date, last_run_state, last_run_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, last_run_state, last_run_start_date`' - name: is_favorite in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Is Favorite - name: timetable_type in: query required: false schema: type: array items: type: string title: Timetable Type responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGCollectionResponse' '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 patch: tags: - DAG summary: Airflow Patch Dags description: 'Patch multiple DAGs. If `dag_id_pattern` is not provided, no DAGs will be matched regardless of other filters. To match all DAGs, pass a wildcard value such as `~` or `%` for `dag_id_pattern`.' operationId: patch_dags security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: update_mask in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Update Mask - 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: tags in: query required: false schema: type: array items: type: string title: Tags - name: tags_match_mode in: query required: false schema: anyOf: - enum: - any - all type: string - type: 'null' title: Tags Match Mode - name: owners in: query required: false schema: type: array items: type: string title: Owners - 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: exclude_stale in: query required: false schema: type: boolean default: true title: Exclude Stale - name: paused in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Paused requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DAGPatchBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGCollectionResponse' '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}: get: tags: - DAG summary: Airflow Get Dag description: Get basic information about a DAG. operationId: get_dag security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGResponse' '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': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unprocessable Entity x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - DAG summary: Airflow Patch Dag description: Patch the specific DAG. operationId: patch_dag security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - 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/DAGPatchBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGResponse' '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 delete: tags: - DAG summary: Airflow Delete Dag description: Delete the specific DAG. operationId: delete_dag security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id 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 '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': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unprocessable Entity x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dags/{dag_id}/details: get: tags: - DAG summary: Airflow Get Dag Details description: Get details of DAG. operationId: get_dag_details security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGDetailsResponse' '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}/favorite: post: tags: - DAG summary: Airflow Favorite Dag description: Mark the DAG as favorite. operationId: favorite_dag security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id responses: '204': description: Successful Response '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}/unfavorite: post: tags: - DAG summary: Airflow Unfavorite Dag description: Unmark the DAG as favorite. operationId: unfavorite_dag security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id responses: '204': description: Successful Response '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/eventLogs/{event_log_id}: get: tags: - Event Log summary: Airflow Get Event Log operationId: get_event_log security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: event_log_id in: path required: true schema: type: integer title: Event Log Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EventLogResponse' '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/eventLogs: get: tags: - Event Log summary: Airflow Get Event Logs description: Get all Event Logs. operationId: get_event_logs security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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, dttm, dag_id, task_id, run_id, event, logical_date, owner, extra, when, event_log_id`' 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, when, event_log_id`' - name: dag_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Dag Id - name: task_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Task Id - name: run_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Run Id - name: map_index in: query required: false schema: anyOf: - type: integer - type: 'null' title: Map Index - name: try_number in: query required: false schema: anyOf: - type: integer - type: 'null' title: Try Number - name: owner in: query required: false schema: anyOf: - type: string - type: 'null' title: Owner - name: event in: query required: false schema: anyOf: - type: string - type: 'null' title: Event - name: excluded_events in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Excluded Events - name: included_events in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Included Events - name: before in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Before - name: after in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: After - 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_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: 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: owner_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: Owner 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: event_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: Event 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." responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EventLogCollectionResponse' '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/{task_id}/links: get: tags: - Extra Links - 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/importErrors/{import_error_id}: get: tags: - Import Error summary: Airflow Get Import Error description: Get an import error. operationId: get_import_error security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: import_error_id in: path required: true schema: type: integer title: Import Error Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ImportErrorResponse' '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/importErrors: get: tags: - Import Error summary: Airflow Get Import Errors description: Get all import errors. operationId: get_import_errors security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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, timestamp, filename, bundle_name, stacktrace, import_error_id`' 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, import_error_id`' - name: filename_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: Filename 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." responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ImportErrorCollectionResponse' '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/jobs: get: tags: - Job summary: Airflow Get Jobs description: Get all jobs. operationId: get_jobs security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: is_alive in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Is Alive - 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: 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, 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 schema: anyOf: - type: string - type: 'null' title: Job State - name: job_type in: query required: false schema: anyOf: - type: string - type: 'null' title: Job Type - name: hostname in: query required: false schema: anyOf: - type: string - type: 'null' title: Hostname - name: executor_class in: query required: false schema: anyOf: - type: string - type: 'null' title: Executor Class responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobCollectionResponse' '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 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/plugins: get: tags: - Plugin summary: Airflow Get Plugins operationId: get_plugins security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PluginCollectionResponse' '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/plugins/importErrors: get: tags: - Plugin summary: Airflow Import Errors operationId: import_errors responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PluginImportErrorCollectionResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' security: - OAuth2PasswordBearer: [] - HTTPBearer: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/pools/{pool_name}: delete: tags: - Pool summary: Airflow Delete Pool description: Delete a pool entry. operationId: delete_pool security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: pool_name in: path required: true schema: type: string title: Pool Name responses: '204': description: Successful Response '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 get: tags: - Pool summary: Airflow Get Pool description: Get a pool. operationId: get_pool security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: pool_name in: path required: true schema: type: string title: Pool Name responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PoolResponse' '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: - Pool summary: Airflow Patch Pool description: Update a Pool. operationId: patch_pool security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: pool_name in: path required: true schema: type: string title: Pool Name - 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/PoolPatchBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PoolResponse' '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/pools: get: tags: - Pool summary: Airflow Get Pools description: Get all pools entries. operationId: get_pools security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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, pool, name`' 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`' - 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." responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PoolCollectionResponse' '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 post: tags: - Pool summary: Airflow Post Pool description: Create a Pool. operationId: post_pool security: - OAuth2PasswordBearer: [] - HTTPBearer: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PoolBody' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PoolResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '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 patch: tags: - Pool summary: Airflow Bulk Pools description: Bulk create, update, and delete pools. operationId: bulk_pools security: - OAuth2PasswordBearer: [] - HTTPBearer: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkBody_PoolBody_' 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/providers: get: tags: - Provider summary: Airflow Get Providers description: Get providers. operationId: get_providers security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProviderCollectionResponse' '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/{task_id}/xcomEntries/{xcom_key}: get: tags: - XCom summary: Airflow Get Xcom Entry description: Get an XCom entry. operationId: get_xcom_entry security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: task_id in: path required: true schema: type: string title: Task Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: xcom_key in: path required: true schema: type: string title: Xcom Key - name: map_index in: query required: false schema: type: integer minimum: -1 default: -1 title: Map Index - name: deserialize in: query required: false schema: type: boolean default: false title: Deserialize - name: stringify in: query required: false schema: type: boolean default: false title: Stringify responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/XComResponseNative' - $ref: '#/components/schemas/XComResponseString' title: Response Get Xcom Entry '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: - XCom summary: Airflow Update Xcom Entry description: Update an existing XCom entry. operationId: update_xcom_entry security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: task_id in: path required: true schema: type: string title: Task Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: xcom_key in: path required: true schema: type: string title: Xcom Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/XComUpdateBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/XComResponseNative' '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 delete: tags: - XCom summary: Airflow Delete Xcom Entry description: Delete an XCom entry. operationId: delete_xcom_entry security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: task_id in: path required: true schema: type: string title: Task Id - name: dag_run_id in: path required: true schema: type: string title: Dag Run Id - name: xcom_key in: path required: true schema: type: string title: Xcom Key - name: map_index in: query required: false schema: type: integer minimum: -1 default: -1 title: Map Index responses: '204': description: Successful Response '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}/xcomEntries: get: tags: - XCom summary: Airflow Get Xcom Entries description: 'Get all XCom entries. This endpoint allows specifying `~` as the dag_id, dag_run_id, task_id to retrieve XCom entries for all DAGs.' operationId: get_xcom_entries 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: xcom_key in: query required: false schema: anyOf: - type: string - type: 'null' title: Xcom Key - name: map_index in: query required: false schema: anyOf: - type: integer minimum: -1 - type: 'null' 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: xcom_key_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: Xcom Key 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: dag_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: Dag 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: 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: 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_filter in: query required: false schema: anyOf: - type: integer - type: 'null' title: Map Index Filter - 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: 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 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/XComCollectionResponse' '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 post: tags: - XCom summary: Airflow Create Xcom Entry description: Create an XCom entry. operationId: create_xcom_entry security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: task_id in: path required: true schema: type: string title: Task 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/XComCreateBody' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/XComResponseNative' '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}: 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}/tasks: get: tags: - Task summary: Airflow Get Tasks description: Get tasks for DAG. operationId: get_tasks security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: order_by in: query required: false schema: type: string default: task_id title: Order By responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskCollectionResponse' '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}/tasks/{task_id}: get: tags: - Task summary: Airflow Get Task description: Get simplified representation of a task. operationId: get_task security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: task_id in: path required: true schema: title: Task Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskResponse' '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/variables/{variable_key}: delete: tags: - Variable summary: Airflow Delete Variable description: Delete a variable entry. operationId: delete_variable security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: variable_key in: path required: true schema: type: string title: Variable Key responses: '204': description: Successful Response '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 get: tags: - Variable summary: Airflow Get Variable description: Get a variable entry. operationId: get_variable security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: variable_key in: path required: true schema: type: string title: Variable Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VariableResponse' '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: - Variable summary: Airflow Patch Variable description: Update a variable by key. operationId: patch_variable security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: variable_key in: path required: true schema: type: string title: Variable Key - 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/VariableBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VariableResponse' '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/variables: get: tags: - Variable summary: Airflow Get Variables description: Get all Variables entries. operationId: get_variables security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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: `key, id, _val, description, is_encrypted, team_name`' 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, team_name`' - name: variable_key_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: Variable Key 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." responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VariableCollectionResponse' '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 post: tags: - Variable summary: Airflow Post Variable description: Create a variable. operationId: post_variable security: - OAuth2PasswordBearer: [] - HTTPBearer: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VariableBody' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VariableResponse' '401': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '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 patch: tags: - Variable summary: Airflow Bulk Variables description: Bulk create, update, and delete variables. operationId: bulk_variables security: - OAuth2PasswordBearer: [] - HTTPBearer: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkBody_VariableBody_' 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/{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/parseDagFile/{file_token}: put: tags: - DAG Parsing summary: Airflow Reparse Dag File description: Request re-parsing a DAG file. operationId: reparse_dag_file security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: file_token in: path required: true schema: type: string title: File Token responses: '201': 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/dagTags: get: tags: - DAG summary: Airflow Get Dag Tags description: Get all DAG tags. operationId: get_dag_tags security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - 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: `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 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: Tag 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." responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DAGTagCollectionResponse' '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}/dagVersions/{version_number}: get: tags: - DagVersion summary: Airflow Get Dag Version description: Get one Dag Version. operationId: get_dag_version security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag Id - name: version_number in: path required: true schema: type: integer title: Version Number responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DagVersionResponse' '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}/dagVersions: get: tags: - DagVersion summary: Airflow Get Dag Versions description: 'Get all DAG Versions. This endpoint allows specifying `~` as the dag_id to retrieve DAG Versions for all DAGs.' operationId: get_dag_versions security: - OAuth2PasswordBearer: [] - HTTPBearer: [] parameters: - name: dag_id in: path required: true schema: type: string title: Dag 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: version_number in: query required: false schema: type: integer title: Version Number - name: bundle_name in: query required: false schema: type: string title: Bundle Name - name: bundle_version in: query required: false schema: anyOf: - type: string - type: 'null' title: Bundle Version - 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, 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 content: application/json: schema: $ref: '#/components/schemas/DAGVersionCollectionResponse' '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: 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 /api/v2/monitor/health: get: tags: - Monitor summary: Airflow Get Health operationId: get_health responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HealthInfoResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/version: get: tags: - Version summary: Airflow Get Version description: Get version information. operationId: get_version responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VersionInfo' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/auth/login: get: tags: - Login summary: Airflow Login description: Redirect to the login URL depending on the AuthManager configured. operationId: login parameters: - name: next in: query required: false schema: anyOf: - type: string - type: 'null' title: Next responses: '200': description: Successful Response content: application/json: schema: {} '307': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Temporary Redirect '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/auth/logout: get: tags: - Login summary: Airflow Logout description: Logout the user. operationId: logout responses: '200': description: Successful Response content: application/json: schema: {} '307': description: Temporary Redirect content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: AppBuilderMenuItemResponse: properties: name: type: string title: Name href: type: string title: Href category: anyOf: - type: string - type: 'null' title: Category additionalProperties: true type: object required: - name - href title: AppBuilderMenuItemResponse description: Serializer for AppBuilder Menu Item responses. AppBuilderViewResponse: properties: name: anyOf: - type: string - type: 'null' title: Name category: anyOf: - type: string - type: 'null' title: Category view: anyOf: - type: string - type: 'null' title: View label: anyOf: - type: string - type: 'null' title: Label additionalProperties: true type: object title: AppBuilderViewResponse description: Serializer for AppBuilder View responses. AssetAliasCollectionResponse: properties: asset_aliases: items: $ref: '#/components/schemas/AssetAliasResponse' type: array title: Asset Aliases total_entries: type: integer title: Total Entries type: object required: - asset_aliases - total_entries title: AssetAliasCollectionResponse description: Asset alias collection response. AssetAliasResponse: properties: id: type: integer title: Id name: type: string title: Name group: type: string title: Group type: object required: - id - name - group title: AssetAliasResponse description: Asset alias serializer for responses. AssetCollectionResponse: properties: assets: items: $ref: '#/components/schemas/AssetResponse' type: array title: Assets total_entries: type: integer title: Total Entries type: object required: - assets - total_entries title: AssetCollectionResponse description: Asset collection response. AssetEventCollectionResponse: properties: asset_events: items: $ref: '#/components/schemas/AssetEventResponse' type: array title: Asset Events total_entries: type: integer title: Total Entries type: object required: - asset_events - total_entries title: AssetEventCollectionResponse description: Asset event collection response. AssetEventResponse: properties: id: type: integer title: Id asset_id: type: integer title: Asset Id uri: anyOf: - type: string - type: 'null' title: Uri name: anyOf: - type: string - type: 'null' title: Name group: anyOf: - type: string - type: 'null' title: Group extra: anyOf: - additionalProperties: $ref: '#/components/schemas/JsonValue' type: object - type: 'null' title: Extra source_task_id: anyOf: - type: string - type: 'null' title: Source Task Id source_dag_id: anyOf: - type: string - type: 'null' title: Source Dag Id source_run_id: anyOf: - type: string - type: 'null' title: Source Run Id source_map_index: type: integer title: Source Map Index created_dagruns: items: $ref: '#/components/schemas/DagRunAssetReference' type: array title: Created Dagruns timestamp: type: string format: date-time title: Timestamp partition_key: anyOf: - type: string - type: 'null' title: Partition Key type: object required: - id - asset_id - source_map_index - created_dagruns - timestamp title: AssetEventResponse description: Asset event serializer for responses. AssetResponse: properties: id: type: integer title: Id name: type: string title: Name uri: type: string title: Uri group: type: string title: Group extra: anyOf: - additionalProperties: $ref: '#/components/schemas/JsonValue' type: object - type: 'null' title: Extra created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At scheduled_dags: items: $ref: '#/components/schemas/DagScheduleAssetReference' type: array title: Scheduled Dags producing_tasks: items: $ref: '#/components/schemas/TaskOutletAssetReference' type: array title: Producing Tasks consuming_tasks: items: $ref: '#/components/schemas/TaskInletAssetReference' type: array title: Consuming Tasks aliases: items: $ref: '#/components/schemas/AssetAliasResponse' type: array title: Aliases watchers: items: $ref: '#/components/schemas/AssetWatcherResponse' type: array title: Watchers last_asset_event: anyOf: - $ref: '#/components/schemas/LastAssetEventResponse' - type: 'null' type: object required: - id - name - uri - group - created_at - updated_at - scheduled_dags - producing_tasks - consuming_tasks - aliases - watchers title: AssetResponse description: Asset serializer for responses. AssetWatcherResponse: properties: name: type: string title: Name trigger_id: type: integer title: Trigger Id created_date: type: string format: date-time title: Created Date type: object required: - name - trigger_id - created_date title: AssetWatcherResponse description: Asset watcher serializer for responses. BackfillCollectionResponse: properties: backfills: items: $ref: '#/components/schemas/BackfillResponse' type: array title: Backfills total_entries: type: integer title: Total Entries type: object required: - backfills - total_entries title: BackfillCollectionResponse description: Backfill Collection serializer for responses. BackfillPostBody: properties: dag_id: type: string title: Dag Id from_date: type: string format: date-time title: From Date to_date: type: string format: date-time title: To Date run_backwards: type: boolean title: Run Backwards default: false dag_run_conf: additionalProperties: true type: object title: Dag Run Conf default: {} reprocess_behavior: $ref: '#/components/schemas/ReprocessBehavior' default: none max_active_runs: type: integer title: Max Active Runs default: 10 run_on_latest_version: type: boolean title: Run On Latest Version default: true additionalProperties: false type: object required: - dag_id - from_date - to_date title: BackfillPostBody description: Object used for create backfill request. BackfillResponse: properties: id: type: integer minimum: 0.0 title: Id dag_id: type: string title: Dag Id from_date: type: string format: date-time title: From Date to_date: type: string format: date-time title: To Date dag_run_conf: anyOf: - additionalProperties: true type: object - type: 'null' title: Dag Run Conf is_paused: type: boolean title: Is Paused reprocess_behavior: $ref: '#/components/schemas/ReprocessBehavior' max_active_runs: type: integer title: Max Active Runs created_at: type: string format: date-time title: Created At completed_at: anyOf: - type: string format: date-time - type: 'null' title: Completed At updated_at: type: string format: date-time title: Updated At dag_display_name: type: string title: Dag Display Name type: object required: - id - dag_id - from_date - to_date - dag_run_conf - is_paused - reprocess_behavior - max_active_runs - created_at - completed_at - updated_at - dag_display_name title: BackfillResponse description: Base serializer for Backfill. BaseInfoResponse: properties: status: anyOf: - type: string - type: 'null' title: Status type: object required: - status title: BaseInfoResponse description: Base info serializer for responses. BulkActionNotOnExistence: type: string enum: - fail - skip title: BulkActionNotOnExistence description: Bulk Action to be taken if the entity does not exist. BulkActionOnExistence: type: string enum: - fail - skip - overwrite title: BulkActionOnExistence description: Bulk Action to be taken if the entity already exists or not. 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.' 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] BulkBody_ConnectionBody_: properties: actions: items: oneOf: - $ref: '#/components/schemas/BulkCreateAction_ConnectionBody_' - $ref: '#/components/schemas/BulkUpdateAction_ConnectionBody_' - $ref: '#/components/schemas/BulkDeleteAction_ConnectionBody_' type: array title: Actions additionalProperties: false type: object required: - actions title: BulkBody[ConnectionBody] BulkBody_PoolBody_: properties: actions: items: oneOf: - $ref: '#/components/schemas/BulkCreateAction_PoolBody_' - $ref: '#/components/schemas/BulkUpdateAction_PoolBody_' - $ref: '#/components/schemas/BulkDeleteAction_PoolBody_' type: array title: Actions additionalProperties: false type: object required: - actions title: BulkBody[PoolBody] BulkBody_VariableBody_: properties: actions: items: oneOf: - $ref: '#/components/schemas/BulkCreateAction_VariableBody_' - $ref: '#/components/schemas/BulkUpdateAction_VariableBody_' - $ref: '#/components/schemas/BulkDeleteAction_VariableBody_' type: array title: Actions additionalProperties: false type: object required: - actions title: BulkBody[VariableBody] 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] BulkCreateAction_ConnectionBody_: properties: action: type: string const: create title: Action description: The action to be performed on the entities. entities: items: $ref: '#/components/schemas/ConnectionBody' 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[ConnectionBody] BulkCreateAction_PoolBody_: properties: action: type: string const: create title: Action description: The action to be performed on the entities. entities: items: $ref: '#/components/schemas/PoolBody' 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[PoolBody] BulkCreateAction_VariableBody_: properties: action: type: string const: create title: Action description: The action to be performed on the entities. entities: items: $ref: '#/components/schemas/VariableBody' 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[VariableBody] 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] BulkDeleteAction_ConnectionBody_: 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/ConnectionBody' 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[ConnectionBody] BulkDeleteAction_PoolBody_: 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/PoolBody' 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[PoolBody] BulkDeleteAction_VariableBody_: 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/VariableBody' 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[VariableBody] 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.' 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. 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] BulkUpdateAction_ConnectionBody_: properties: action: type: string const: update title: Action description: The action to be performed on the entities. entities: items: $ref: '#/components/schemas/ConnectionBody' 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[ConnectionBody] BulkUpdateAction_PoolBody_: properties: action: type: string const: update title: Action description: The action to be performed on the entities. entities: items: $ref: '#/components/schemas/PoolBody' 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[PoolBody] BulkUpdateAction_VariableBody_: properties: action: type: string const: update title: Action description: The action to be performed on the entities. entities: items: $ref: '#/components/schemas/VariableBody' 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[VariableBody] 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. Config: properties: sections: items: $ref: '#/components/schemas/ConfigSection' type: array title: Sections additionalProperties: false type: object required: - sections title: Config description: List of config sections with their options. ConfigOption: properties: key: type: string title: Key value: anyOf: - type: string - prefixItems: - type: string - type: string type: array maxItems: 2 minItems: 2 title: Value additionalProperties: false type: object required: - key - value title: ConfigOption description: Config option. ConfigSection: properties: name: type: string title: Name options: items: $ref: '#/components/schemas/ConfigOption' type: array title: Options additionalProperties: false type: object required: - name - options title: ConfigSection description: Config Section Schema. ConnectionBody: properties: connection_id: type: string maxLength: 200 pattern: ^[\w.-]+$ title: Connection Id conn_type: type: string title: Conn Type description: anyOf: - type: string - type: 'null' title: Description host: anyOf: - type: string - type: 'null' title: Host login: anyOf: - type: string - type: 'null' title: Login schema: anyOf: - type: string - type: 'null' title: Schema port: anyOf: - type: integer - type: 'null' title: Port password: anyOf: - type: string - type: 'null' title: Password extra: anyOf: - type: string - type: 'null' title: Extra team_name: anyOf: - type: string maxLength: 50 - type: 'null' title: Team Name additionalProperties: false type: object required: - connection_id - conn_type title: ConnectionBody description: Connection Serializer for requests body. ConnectionCollectionResponse: properties: connections: items: $ref: '#/components/schemas/ConnectionResponse' type: array title: Connections total_entries: type: integer title: Total Entries type: object required: - connections - total_entries title: ConnectionCollectionResponse description: Connection Collection serializer for responses. ConnectionResponse: properties: connection_id: type: string title: Connection Id conn_type: type: string title: Conn Type description: anyOf: - type: string - type: 'null' title: Description host: anyOf: - type: string - type: 'null' title: Host login: anyOf: - type: string - type: 'null' title: Login schema: anyOf: - type: string - type: 'null' title: Schema port: anyOf: - type: integer - type: 'null' title: Port password: anyOf: - type: string - type: 'null' title: Password extra: anyOf: - type: string - type: 'null' title: Extra team_name: anyOf: - type: string - type: 'null' title: Team Name type: object required: - connection_id - conn_type - description - host - login - schema - port - password - extra - team_name title: ConnectionResponse description: Connection serializer for responses. ConnectionTestResponse: properties: status: type: boolean title: Status message: type: string title: Message type: object required: - status - message title: ConnectionTestResponse description: Connection Test serializer for responses. CreateAssetEventsBody: properties: asset_id: type: integer title: Asset Id partition_key: anyOf: - type: string - type: 'null' title: Partition Key extra: additionalProperties: true type: object title: Extra additionalProperties: false type: object required: - asset_id title: CreateAssetEventsBody description: Create asset events request. DAGCollectionResponse: properties: dags: items: $ref: '#/components/schemas/DAGResponse' type: array title: Dags total_entries: type: integer title: Total Entries type: object required: - dags - total_entries title: DAGCollectionResponse description: DAG Collection serializer for responses. DAGDetailsResponse: properties: dag_id: type: string title: Dag Id dag_display_name: type: string title: Dag Display Name is_paused: type: boolean title: Is Paused is_stale: type: boolean title: Is Stale last_parsed_time: anyOf: - type: string format: date-time - type: 'null' title: Last Parsed Time last_parse_duration: anyOf: - type: number - type: 'null' title: Last Parse Duration last_expired: anyOf: - type: string format: date-time - type: 'null' title: Last Expired bundle_name: anyOf: - type: string - type: 'null' title: Bundle Name bundle_version: anyOf: - type: string - type: 'null' title: Bundle Version relative_fileloc: anyOf: - type: string - type: 'null' title: Relative Fileloc fileloc: type: string title: Fileloc description: anyOf: - type: string - type: 'null' title: Description timetable_summary: anyOf: - type: string - type: 'null' title: Timetable Summary timetable_description: anyOf: - type: string - type: 'null' title: Timetable Description timetable_partitioned: type: boolean title: Timetable Partitioned timetable_periodic: type: boolean title: Timetable Periodic tags: items: $ref: '#/components/schemas/DagTagResponse' type: array title: Tags max_active_tasks: type: integer title: Max Active Tasks max_active_runs: anyOf: - type: integer - type: 'null' title: Max Active Runs max_consecutive_failed_dag_runs: type: integer title: Max Consecutive Failed Dag Runs has_task_concurrency_limits: type: boolean title: Has Task Concurrency Limits has_import_errors: type: boolean title: Has Import Errors next_dagrun_logical_date: anyOf: - type: string format: date-time - type: 'null' title: Next Dagrun Logical Date next_dagrun_data_interval_start: anyOf: - type: string format: date-time - type: 'null' title: Next Dagrun Data Interval Start next_dagrun_data_interval_end: anyOf: - type: string format: date-time - type: 'null' title: Next Dagrun Data Interval End next_dagrun_run_after: anyOf: - type: string format: date-time - type: 'null' title: Next Dagrun Run After allowed_run_types: anyOf: - items: $ref: '#/components/schemas/DagRunType' type: array - type: 'null' title: Allowed Run Types owners: items: type: string type: array title: Owners catchup: type: boolean title: Catchup dag_run_timeout: anyOf: - type: string format: duration - type: 'null' title: Dag Run Timeout asset_expression: anyOf: - additionalProperties: true type: object - type: 'null' title: Asset Expression doc_md: anyOf: - type: string - type: 'null' title: Doc Md 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 is_paused_upon_creation: anyOf: - type: boolean - type: 'null' title: Is Paused Upon Creation params: anyOf: - additionalProperties: true type: object - type: 'null' title: Params render_template_as_native_obj: type: boolean title: Render Template As Native Obj template_search_path: anyOf: - items: type: string type: array - type: 'null' title: Template Search Path timezone: anyOf: - type: string - type: 'null' title: Timezone last_parsed: anyOf: - type: string format: date-time - type: 'null' title: Last Parsed default_args: anyOf: - additionalProperties: true type: object - type: 'null' title: Default Args owner_links: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Owner Links is_favorite: type: boolean title: Is Favorite default: false active_runs_count: type: integer title: Active Runs Count default: 0 is_backfillable: type: boolean title: Is Backfillable description: Whether this DAG's schedule supports backfilling. readOnly: true file_token: type: string title: File Token description: Return file token. readOnly: true concurrency: type: integer title: Concurrency description: 'Return max_active_tasks as concurrency. Deprecated: Use max_active_tasks instead.' deprecated: true readOnly: true latest_dag_version: anyOf: - $ref: '#/components/schemas/DagVersionResponse' - type: 'null' description: Return the latest DagVersion. readOnly: true type: object required: - dag_id - dag_display_name - is_paused - is_stale - last_parsed_time - last_parse_duration - last_expired - bundle_name - bundle_version - relative_fileloc - fileloc - description - timetable_summary - timetable_description - timetable_partitioned - timetable_periodic - tags - max_active_tasks - max_active_runs - max_consecutive_failed_dag_runs - has_task_concurrency_limits - has_import_errors - next_dagrun_logical_date - next_dagrun_data_interval_start - next_dagrun_data_interval_end - next_dagrun_run_after - allowed_run_types - owners - catchup - dag_run_timeout - asset_expression - doc_md - start_date - end_date - is_paused_upon_creation - params - render_template_as_native_obj - template_search_path - timezone - last_parsed - default_args - is_backfillable - file_token - concurrency - latest_dag_version title: DAGDetailsResponse description: Specific serializer for DAG Details responses. DAGPatchBody: properties: is_paused: type: boolean title: Is Paused additionalProperties: false type: object required: - is_paused title: DAGPatchBody description: Dag Serializer for updatable bodies. DAGResponse: properties: dag_id: type: string title: Dag Id dag_display_name: type: string title: Dag Display Name is_paused: type: boolean title: Is Paused is_stale: type: boolean title: Is Stale last_parsed_time: anyOf: - type: string format: date-time - type: 'null' title: Last Parsed Time last_parse_duration: anyOf: - type: number - type: 'null' title: Last Parse Duration last_expired: anyOf: - type: string format: date-time - type: 'null' title: Last Expired bundle_name: anyOf: - type: string - type: 'null' title: Bundle Name bundle_version: anyOf: - type: string - type: 'null' title: Bundle Version relative_fileloc: anyOf: - type: string - type: 'null' title: Relative Fileloc fileloc: type: string title: Fileloc description: anyOf: - type: string - type: 'null' title: Description timetable_summary: anyOf: - type: string - type: 'null' title: Timetable Summary timetable_description: anyOf: - type: string - type: 'null' title: Timetable Description timetable_partitioned: type: boolean title: Timetable Partitioned timetable_periodic: type: boolean title: Timetable Periodic tags: items: $ref: '#/components/schemas/DagTagResponse' type: array title: Tags max_active_tasks: type: integer title: Max Active Tasks max_active_runs: anyOf: - type: integer - type: 'null' title: Max Active Runs max_consecutive_failed_dag_runs: type: integer title: Max Consecutive Failed Dag Runs has_task_concurrency_limits: type: boolean title: Has Task Concurrency Limits has_import_errors: type: boolean title: Has Import Errors next_dagrun_logical_date: anyOf: - type: string format: date-time - type: 'null' title: Next Dagrun Logical Date next_dagrun_data_interval_start: anyOf: - type: string format: date-time - type: 'null' title: Next Dagrun Data Interval Start next_dagrun_data_interval_end: anyOf: - type: string format: date-time - type: 'null' title: Next Dagrun Data Interval End next_dagrun_run_after: anyOf: - type: string format: date-time - type: 'null' title: Next Dagrun Run After allowed_run_types: anyOf: - items: $ref: '#/components/schemas/DagRunType' type: array - type: 'null' title: Allowed Run Types owners: items: type: string type: array title: Owners is_backfillable: type: boolean title: Is Backfillable description: Whether this DAG's schedule supports backfilling. readOnly: true file_token: type: string title: File Token description: Return file token. readOnly: true type: object required: - dag_id - dag_display_name - is_paused - is_stale - last_parsed_time - last_parse_duration - last_expired - bundle_name - bundle_version - relative_fileloc - fileloc - description - timetable_summary - timetable_description - timetable_partitioned - timetable_periodic - tags - max_active_tasks - max_active_runs - max_consecutive_failed_dag_runs - has_task_concurrency_limits - has_import_errors - next_dagrun_logical_date - next_dagrun_data_interval_start - next_dagrun_data_interval_end - next_dagrun_run_after - allowed_run_types - owners - is_backfillable - file_token title: DAGResponse description: DAG serializer for responses. DAGRunClearBody: properties: dry_run: type: boolean title: Dry Run default: true only_failed: type: boolean title: Only Failed 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 Dag Run. default: false additionalProperties: false type: object title: DAGRunClearBody description: DAG Run serializer for clear endpoint body. DAGRunCollectionResponse: properties: dag_runs: items: $ref: '#/components/schemas/DAGRunResponse' type: array title: Dag Runs total_entries: type: integer title: Total Entries type: object required: - dag_runs - total_entries title: DAGRunCollectionResponse description: DAG Run Collection serializer for responses. DAGRunPatchBody: properties: state: anyOf: - $ref: '#/components/schemas/DAGRunPatchStates' - type: 'null' note: anyOf: - type: string maxLength: 1000 - type: 'null' title: Note additionalProperties: false type: object title: DAGRunPatchBody description: DAG Run Serializer for PATCH requests. DAGRunPatchStates: type: string enum: - queued - success - failed title: DAGRunPatchStates description: Enum for DAG Run states when updating a DAG Run. DAGRunResponse: properties: dag_run_id: type: string title: Dag Run Id dag_id: type: string title: Dag Id logical_date: anyOf: - type: string format: date-time - type: 'null' title: Logical Date queued_at: anyOf: - type: string format: date-time - type: 'null' title: Queued At 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 data_interval_start: anyOf: - type: string format: date-time - type: 'null' title: Data Interval Start data_interval_end: anyOf: - type: string format: date-time - type: 'null' title: Data Interval End run_after: type: string format: date-time title: Run After last_scheduling_decision: anyOf: - type: string format: date-time - type: 'null' title: Last Scheduling Decision run_type: $ref: '#/components/schemas/DagRunType' state: $ref: '#/components/schemas/DagRunState' triggered_by: anyOf: - $ref: '#/components/schemas/DagRunTriggeredByType' - type: 'null' triggering_user_name: anyOf: - type: string - type: 'null' title: Triggering User Name conf: anyOf: - additionalProperties: true type: object - type: 'null' title: Conf note: anyOf: - type: string - type: 'null' title: Note dag_versions: items: $ref: '#/components/schemas/DagVersionResponse' type: array title: Dag Versions bundle_version: anyOf: - type: string - type: 'null' title: Bundle Version dag_display_name: type: string title: Dag Display Name partition_key: anyOf: - type: string - type: 'null' title: Partition Key type: object required: - dag_run_id - dag_id - logical_date - queued_at - start_date - end_date - duration - data_interval_start - data_interval_end - run_after - last_scheduling_decision - run_type - state - triggered_by - triggering_user_name - conf - note - dag_versions - bundle_version - dag_display_name - partition_key title: DAGRunResponse description: DAG Run serializer for responses. DAGRunsBatchBody: properties: order_by: anyOf: - type: string - type: 'null' title: Order By page_offset: type: integer minimum: 0.0 title: Page Offset default: 0 page_limit: type: integer minimum: 0.0 title: Page Limit default: 100 dag_ids: anyOf: - items: type: string type: array - type: 'null' title: Dag Ids states: anyOf: - items: anyOf: - $ref: '#/components/schemas/DagRunState' - type: 'null' type: array - type: 'null' title: States 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 conf_contains: anyOf: - type: string - type: 'null' title: Conf Contains additionalProperties: false type: object title: DAGRunsBatchBody description: List DAG Runs body for batch endpoint. DAGSourceResponse: properties: content: anyOf: - type: string - type: 'null' title: Content dag_id: type: string title: Dag Id version_number: anyOf: - type: integer - type: 'null' title: Version Number dag_display_name: type: string title: Dag Display Name type: object required: - content - dag_id - version_number - dag_display_name title: DAGSourceResponse description: DAG Source serializer for responses. DAGTagCollectionResponse: properties: tags: items: type: string type: array title: Tags total_entries: type: integer title: Total Entries type: object required: - tags - total_entries title: DAGTagCollectionResponse description: DAG Tags Collection serializer for responses. DAGVersionCollectionResponse: properties: dag_versions: items: $ref: '#/components/schemas/DagVersionResponse' type: array title: Dag Versions total_entries: type: integer title: Total Entries type: object required: - dag_versions - total_entries title: DAGVersionCollectionResponse description: DAG Version Collection serializer for responses. DAGWarningCollectionResponse: properties: dag_warnings: items: $ref: '#/components/schemas/DAGWarningResponse' type: array title: Dag Warnings total_entries: type: integer title: Total Entries type: object required: - dag_warnings - total_entries title: DAGWarningCollectionResponse description: DAG warning collection serializer for responses. DAGWarningResponse: properties: dag_id: type: string title: Dag Id warning_type: $ref: '#/components/schemas/DagWarningType' message: type: string title: Message timestamp: type: string format: date-time title: Timestamp dag_display_name: type: string title: Dag Display Name type: object required: - dag_id - warning_type - message - timestamp - dag_display_name title: DAGWarningResponse description: DAG Warning serializer for responses. DagProcessorInfoResponse: properties: status: anyOf: - type: string - type: 'null' title: Status latest_dag_processor_heartbeat: anyOf: - type: string - type: 'null' title: Latest Dag Processor Heartbeat type: object required: - status - latest_dag_processor_heartbeat title: DagProcessorInfoResponse description: DagProcessor info serializer for responses. DagRunAssetReference: properties: run_id: type: string title: Run Id dag_id: type: string title: Dag Id logical_date: anyOf: - type: string format: date-time - type: 'null' title: Logical Date start_date: type: string format: date-time title: Start Date end_date: anyOf: - type: string format: date-time - type: 'null' title: End Date state: type: string title: State data_interval_start: anyOf: - type: string format: date-time - type: 'null' title: Data Interval Start data_interval_end: anyOf: - type: string format: date-time - type: 'null' title: Data Interval End partition_key: anyOf: - type: string - type: 'null' title: Partition Key additionalProperties: false type: object required: - run_id - dag_id - logical_date - start_date - end_date - state - data_interval_start - data_interval_end - partition_key title: DagRunAssetReference description: DagRun serializer for asset responses. DagRunState: type: string enum: - queued - running - success - failed title: DagRunState description: 'All possible states that a DagRun can be in. These are "shared" with TaskInstanceState in some parts of the code, so please ensure that their values always match the ones with the same name in TaskInstanceState.' DagRunTriggeredByType: type: string enum: - cli - operator - rest_api - ui - test - timetable - asset - backfill title: DagRunTriggeredByType description: Class with TriggeredBy types for DagRun. DagRunType: type: string enum: - backfill - scheduled - manual - operator_triggered - asset_triggered - asset_materialization title: DagRunType description: Class with DagRun types. DagScheduleAssetReference: properties: dag_id: type: string title: Dag Id created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At additionalProperties: false type: object required: - dag_id - created_at - updated_at title: DagScheduleAssetReference description: DAG schedule reference serializer for assets. DagStatsCollectionResponse: properties: dags: items: $ref: '#/components/schemas/DagStatsResponse' type: array title: Dags total_entries: type: integer title: Total Entries type: object required: - dags - total_entries title: DagStatsCollectionResponse description: DAG Stats Collection serializer for responses. DagStatsResponse: properties: dag_id: type: string title: Dag Id dag_display_name: type: string title: Dag Display Name stats: items: $ref: '#/components/schemas/DagStatsStateResponse' type: array title: Stats type: object required: - dag_id - dag_display_name - stats title: DagStatsResponse description: DAG Stats serializer for responses. DagStatsStateResponse: properties: state: $ref: '#/components/schemas/DagRunState' count: type: integer title: Count type: object required: - state - count title: DagStatsStateResponse description: DagStatsState serializer for responses. DagTagResponse: properties: name: type: string title: Name dag_id: type: string title: Dag Id dag_display_name: type: string title: Dag Display Name type: object required: - name - dag_id - dag_display_name title: DagTagResponse description: DAG Tag serializer for responses. 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. DagWarningType: type: string enum: - asset conflict - non-existent pool - runtime varying value title: DagWarningType description: 'Enum for DAG warning types. This is the set of allowable values for the ``warning_type`` field in the DagWarning model.' DryRunBackfillCollectionResponse: properties: backfills: items: $ref: '#/components/schemas/DryRunBackfillResponse' type: array title: Backfills total_entries: type: integer title: Total Entries type: object required: - backfills - total_entries title: DryRunBackfillCollectionResponse description: Backfill collection serializer for responses in dry-run mode. DryRunBackfillResponse: properties: logical_date: anyOf: - type: string format: date-time - type: 'null' title: Logical Date partition_key: anyOf: - type: string - type: 'null' title: Partition Key partition_date: anyOf: - type: string format: date-time - type: 'null' title: Partition Date type: object required: - logical_date - partition_key - partition_date title: DryRunBackfillResponse description: Backfill serializer for responses in dry-run mode. EventLogCollectionResponse: properties: event_logs: items: $ref: '#/components/schemas/EventLogResponse' type: array title: Event Logs total_entries: type: integer title: Total Entries type: object required: - event_logs - total_entries title: EventLogCollectionResponse description: Event Log Collection Response. EventLogResponse: properties: event_log_id: type: integer title: Event Log Id when: type: string format: date-time title: When dag_id: anyOf: - type: string - type: 'null' title: Dag Id task_id: anyOf: - type: string - type: 'null' title: Task Id run_id: anyOf: - type: string - type: 'null' title: Run Id map_index: anyOf: - type: integer - type: 'null' title: Map Index try_number: anyOf: - type: integer - type: 'null' title: Try Number event: type: string title: Event logical_date: anyOf: - type: string format: date-time - type: 'null' title: Logical Date owner: anyOf: - type: string - type: 'null' title: Owner extra: anyOf: - type: string - type: 'null' title: Extra dag_display_name: anyOf: - type: string - type: 'null' title: Dag Display Name task_display_name: anyOf: - type: string - type: 'null' title: Task Display Name type: object required: - event_log_id - when - dag_id - task_id - run_id - map_index - try_number - event - logical_date - owner - extra title: EventLogResponse description: Event Log Response. ExternalLogUrlResponse: properties: url: type: string title: Url type: object required: - url title: ExternalLogUrlResponse description: Response for the external log URL endpoint. ExternalViewResponse: properties: name: type: string title: Name icon: anyOf: - type: string - type: 'null' title: Icon icon_dark_mode: anyOf: - type: string - type: 'null' title: Icon Dark Mode url_route: anyOf: - type: string - type: 'null' title: Url Route category: anyOf: - type: string - type: 'null' title: Category href: type: string title: Href destination: type: string enum: - nav - dag - dag_run - task - task_instance - base title: Destination default: nav additionalProperties: true type: object required: - name - href title: ExternalViewResponse description: Serializer for External View Plugin 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. FastAPIAppResponse: properties: app: type: string title: App url_prefix: type: string title: Url Prefix name: type: string title: Name additionalProperties: true type: object required: - app - url_prefix - name title: FastAPIAppResponse description: Serializer for Plugin FastAPI App responses. FastAPIRootMiddlewareResponse: properties: middleware: type: string title: Middleware name: type: string title: Name additionalProperties: true type: object required: - middleware - name title: FastAPIRootMiddlewareResponse description: Serializer for Plugin FastAPI root middleware responses. 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. 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. 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. 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. 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. 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. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError HealthInfoResponse: properties: metadatabase: $ref: '#/components/schemas/BaseInfoResponse' scheduler: $ref: '#/components/schemas/SchedulerInfoResponse' triggerer: $ref: '#/components/schemas/TriggererInfoResponse' dag_processor: anyOf: - $ref: '#/components/schemas/DagProcessorInfoResponse' - type: 'null' type: object required: - metadatabase - scheduler - triggerer title: HealthInfoResponse description: Health serializer for responses. ImportErrorCollectionResponse: properties: import_errors: items: $ref: '#/components/schemas/ImportErrorResponse' type: array title: Import Errors total_entries: type: integer title: Total Entries type: object required: - import_errors - total_entries title: ImportErrorCollectionResponse description: Import Error Collection Response. ImportErrorResponse: properties: import_error_id: type: integer title: Import Error Id timestamp: type: string format: date-time title: Timestamp filename: type: string title: Filename bundle_name: anyOf: - type: string - type: 'null' title: Bundle Name stack_trace: type: string title: Stack Trace type: object required: - import_error_id - timestamp - filename - bundle_name - stack_trace title: ImportErrorResponse description: Import Error Response. JobCollectionResponse: properties: jobs: items: $ref: '#/components/schemas/JobResponse' type: array title: Jobs total_entries: type: integer title: Total Entries type: object required: - jobs - total_entries title: JobCollectionResponse description: Job Collection Response. 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. JsonValue: {} LastAssetEventResponse: properties: id: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Id timestamp: anyOf: - type: string format: date-time - type: 'null' title: Timestamp type: object title: LastAssetEventResponse description: Last asset event response serializer. MaterializeAssetBody: properties: dag_run_id: anyOf: - type: string - type: 'null' title: Dag Run Id data_interval_start: anyOf: - type: string format: date-time - type: 'null' title: Data Interval Start data_interval_end: anyOf: - type: string format: date-time - type: 'null' title: Data Interval End logical_date: anyOf: - type: string format: date-time - type: 'null' title: Logical Date run_after: anyOf: - type: string format: date-time - type: 'null' title: Run After conf: anyOf: - additionalProperties: true type: object - type: 'null' title: Conf note: anyOf: - type: string - type: 'null' title: Note partition_key: anyOf: - type: string - type: 'null' title: Partition Key additionalProperties: false type: object title: MaterializeAssetBody description: Materialize asset request. 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. PluginCollectionResponse: properties: plugins: items: $ref: '#/components/schemas/PluginResponse' type: array title: Plugins total_entries: type: integer title: Total Entries type: object required: - plugins - total_entries title: PluginCollectionResponse description: Plugin Collection serializer. PluginImportErrorCollectionResponse: properties: import_errors: items: $ref: '#/components/schemas/PluginImportErrorResponse' type: array title: Import Errors total_entries: type: integer title: Total Entries type: object required: - import_errors - total_entries title: PluginImportErrorCollectionResponse description: Plugin Import Error Collection serializer. PluginImportErrorResponse: properties: source: type: string title: Source error: type: string title: Error type: object required: - source - error title: PluginImportErrorResponse description: Plugin Import Error serializer for responses. PluginResponse: properties: name: type: string title: Name macros: items: type: string type: array title: Macros flask_blueprints: items: type: string type: array title: Flask Blueprints fastapi_apps: items: $ref: '#/components/schemas/FastAPIAppResponse' type: array title: Fastapi Apps fastapi_root_middlewares: items: $ref: '#/components/schemas/FastAPIRootMiddlewareResponse' type: array title: Fastapi Root Middlewares external_views: items: $ref: '#/components/schemas/ExternalViewResponse' type: array title: External Views description: Aggregate all external views. Both 'external_views' and 'appbuilder_menu_items' are included here. react_apps: items: $ref: '#/components/schemas/ReactAppResponse' type: array title: React Apps appbuilder_views: items: $ref: '#/components/schemas/AppBuilderViewResponse' type: array title: Appbuilder Views appbuilder_menu_items: items: $ref: '#/components/schemas/AppBuilderMenuItemResponse' type: array title: Appbuilder Menu Items deprecated: true global_operator_extra_links: items: type: string type: array title: Global Operator Extra Links operator_extra_links: items: type: string type: array title: Operator Extra Links source: type: string title: Source listeners: items: type: string type: array title: Listeners timetables: items: type: string type: array title: Timetables type: object required: - name - macros - flask_blueprints - fastapi_apps - fastapi_root_middlewares - external_views - react_apps - appbuilder_views - appbuilder_menu_items - global_operator_extra_links - operator_extra_links - source - listeners - timetables title: PluginResponse description: Plugin serializer. PoolBody: properties: name: type: string maxLength: 256 title: Name slots: type: integer minimum: -1.0 title: Slots description: Number of slots. Use -1 for unlimited. description: anyOf: - type: string - type: 'null' title: Description include_deferred: type: boolean title: Include Deferred default: false team_name: anyOf: - type: string maxLength: 50 - type: 'null' title: Team Name additionalProperties: false type: object required: - name - slots title: PoolBody description: Pool serializer for post bodies. PoolCollectionResponse: properties: pools: items: $ref: '#/components/schemas/PoolResponse' type: array title: Pools total_entries: type: integer title: Total Entries type: object required: - pools - total_entries title: PoolCollectionResponse description: Pool Collection serializer for responses. PoolPatchBody: properties: pool: anyOf: - type: string - type: 'null' title: Pool slots: anyOf: - type: integer minimum: -1.0 description: Number of slots. Use -1 for unlimited. - type: 'null' title: Slots description: anyOf: - type: string - type: 'null' title: Description include_deferred: anyOf: - type: boolean - type: 'null' title: Include Deferred team_name: anyOf: - type: string maxLength: 50 - type: 'null' title: Team Name additionalProperties: false type: object title: PoolPatchBody description: Pool serializer for patch bodies. PoolResponse: properties: name: type: string title: Name slots: type: integer minimum: -1.0 title: Slots description: Number of slots. Use -1 for unlimited. description: anyOf: - type: string - type: 'null' title: Description include_deferred: type: boolean title: Include Deferred occupied_slots: type: integer title: Occupied Slots running_slots: type: integer title: Running Slots queued_slots: type: integer title: Queued Slots scheduled_slots: type: integer title: Scheduled Slots open_slots: type: integer title: Open Slots deferred_slots: type: integer title: Deferred Slots team_name: anyOf: - type: string - type: 'null' title: Team Name type: object required: - name - slots - include_deferred - occupied_slots - running_slots - queued_slots - scheduled_slots - open_slots - deferred_slots - team_name title: PoolResponse description: Pool serializer for responses. ProviderCollectionResponse: properties: providers: items: $ref: '#/components/schemas/ProviderResponse' type: array title: Providers total_entries: type: integer title: Total Entries type: object required: - providers - total_entries title: ProviderCollectionResponse description: Provider Collection serializer for responses. ProviderResponse: properties: package_name: type: string title: Package Name description: type: string title: Description version: type: string title: Version documentation_url: anyOf: - type: string - type: 'null' title: Documentation Url type: object required: - package_name - description - version - documentation_url title: ProviderResponse description: Provider serializer for responses. QueuedEventCollectionResponse: properties: queued_events: items: $ref: '#/components/schemas/QueuedEventResponse' type: array title: Queued Events total_entries: type: integer title: Total Entries type: object required: - queued_events - total_entries title: QueuedEventCollectionResponse description: Queued Event Collection serializer for responses. QueuedEventResponse: properties: dag_id: type: string title: Dag Id asset_id: type: integer title: Asset Id created_at: type: string format: date-time title: Created At dag_display_name: type: string title: Dag Display Name type: object required: - dag_id - asset_id - created_at - dag_display_name title: QueuedEventResponse description: Queued Event serializer for responses.. ReactAppResponse: properties: name: type: string title: Name icon: anyOf: - type: string - type: 'null' title: Icon icon_dark_mode: anyOf: - type: string - type: 'null' title: Icon Dark Mode url_route: anyOf: - type: string - type: 'null' title: Url Route category: anyOf: - type: string - type: 'null' title: Category bundle_url: type: string title: Bundle Url destination: type: string enum: - nav - dag - dag_run - task - task_instance - base - dashboard title: Destination default: nav additionalProperties: true type: object required: - name - bundle_url title: ReactAppResponse description: Serializer for React App Plugin responses. ReprocessBehavior: type: string enum: - failed - completed - none title: ReprocessBehavior description: 'Internal enum for setting reprocess behavior in a backfill. :meta private:' SchedulerInfoResponse: properties: status: anyOf: - type: string - type: 'null' title: Status latest_scheduler_heartbeat: anyOf: - type: string - type: 'null' title: Latest Scheduler Heartbeat type: object required: - status - latest_scheduler_heartbeat title: SchedulerInfoResponse description: Scheduler info serializer for responses. 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. TaskCollectionResponse: properties: tasks: items: $ref: '#/components/schemas/TaskResponse' type: array title: Tasks total_entries: type: integer title: Total Entries type: object required: - tasks - total_entries title: TaskCollectionResponse description: Task collection serializer for responses. 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. 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. TaskInletAssetReference: properties: dag_id: type: string title: Dag Id task_id: type: string title: Task Id created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At additionalProperties: false type: object required: - dag_id - task_id - created_at - updated_at title: TaskInletAssetReference description: Task inlet reference serializer for assets. 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).' 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. 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. 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. 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.' 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. 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. TaskOutletAssetReference: properties: dag_id: type: string title: Dag Id task_id: type: string title: Task Id created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At additionalProperties: false type: object required: - dag_id - task_id - created_at - updated_at title: TaskOutletAssetReference description: Task outlet reference serializer for assets. TaskResponse: properties: task_id: anyOf: - type: string - type: 'null' title: Task Id task_display_name: anyOf: - type: string - type: 'null' title: Task Display Name owner: anyOf: - type: string - type: 'null' title: Owner 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 trigger_rule: anyOf: - type: string - type: 'null' title: Trigger Rule depends_on_past: type: boolean title: Depends On Past wait_for_downstream: type: boolean title: Wait For Downstream retries: anyOf: - type: number - type: 'null' title: Retries queue: anyOf: - type: string - type: 'null' title: Queue pool: anyOf: - type: string - type: 'null' title: Pool pool_slots: anyOf: - type: number - type: 'null' title: Pool Slots execution_timeout: anyOf: - $ref: '#/components/schemas/TimeDelta' - type: 'null' retry_delay: anyOf: - $ref: '#/components/schemas/TimeDelta' - type: 'null' retry_exponential_backoff: type: number title: Retry Exponential Backoff priority_weight: anyOf: - type: number - type: 'null' title: Priority Weight weight_rule: anyOf: - type: string - type: 'null' title: Weight Rule ui_color: anyOf: - type: string - type: 'null' title: Ui Color ui_fgcolor: anyOf: - type: string - type: 'null' title: Ui Fgcolor template_fields: anyOf: - items: type: string type: array - type: 'null' title: Template Fields downstream_task_ids: anyOf: - items: type: string type: array - type: 'null' title: Downstream Task Ids doc_md: anyOf: - type: string - type: 'null' title: Doc Md operator_name: anyOf: - type: string - type: 'null' title: Operator Name params: anyOf: - additionalProperties: true type: object - type: 'null' title: Params class_ref: anyOf: - additionalProperties: true type: object - type: 'null' title: Class Ref is_mapped: anyOf: - type: boolean - type: 'null' title: Is Mapped extra_links: items: type: string type: array title: Extra Links description: Extract and return extra_links. readOnly: true type: object required: - task_id - task_display_name - owner - start_date - end_date - trigger_rule - depends_on_past - wait_for_downstream - retries - queue - pool - pool_slots - execution_timeout - retry_delay - retry_exponential_backoff - priority_weight - weight_rule - ui_color - ui_fgcolor - template_fields - downstream_task_ids - doc_md - operator_name - params - class_ref - is_mapped - extra_links title: TaskResponse description: Task serializer for responses. TimeDelta: properties: __type: type: string title: Type default: TimeDelta days: type: integer title: Days seconds: type: integer title: Seconds microseconds: type: integer title: Microseconds type: object required: - days - seconds - microseconds title: TimeDelta description: TimeDelta can be used to interact with datetime.timedelta objects. TriggerDAGRunPostBody: properties: dag_run_id: anyOf: - type: string - type: 'null' title: Dag Run Id data_interval_start: anyOf: - type: string format: date-time - type: 'null' title: Data Interval Start data_interval_end: anyOf: - type: string format: date-time - type: 'null' title: Data Interval End logical_date: anyOf: - type: string format: date-time - type: 'null' title: Logical Date run_after: anyOf: - type: string format: date-time - type: 'null' title: Run After conf: anyOf: - additionalProperties: true type: object - type: 'null' title: Conf note: anyOf: - type: string - type: 'null' title: Note partition_key: anyOf: - type: string - type: 'null' title: Partition Key additionalProperties: false type: object required: - logical_date title: TriggerDAGRunPostBody description: Trigger DAG Run Serializer for POST body. 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. TriggererInfoResponse: properties: status: anyOf: - type: string - type: 'null' title: Status latest_triggerer_heartbeat: anyOf: - type: string - type: 'null' title: Latest Triggerer Heartbeat type: object required: - status - latest_triggerer_heartbeat title: TriggererInfoResponse description: Triggerer info serializer for responses. 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. 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 VariableBody: properties: key: type: string maxLength: 250 title: Key value: $ref: '#/components/schemas/JsonValue' description: anyOf: - type: string - type: 'null' title: Description team_name: anyOf: - type: string maxLength: 50 - type: 'null' title: Team Name additionalProperties: false type: object required: - key - value title: VariableBody description: Variable serializer for bodies. VariableCollectionResponse: properties: variables: items: $ref: '#/components/schemas/VariableResponse' type: array title: Variables total_entries: type: integer title: Total Entries type: object required: - variables - total_entries title: VariableCollectionResponse description: Variable Collection serializer for responses. VariableResponse: properties: key: type: string title: Key value: type: string title: Value description: anyOf: - type: string - type: 'null' title: Description is_encrypted: type: boolean title: Is Encrypted team_name: anyOf: - type: string - type: 'null' title: Team Name type: object required: - key - value - description - is_encrypted - team_name title: VariableResponse description: Variable serializer for responses. VersionInfo: properties: version: type: string title: Version git_version: anyOf: - type: string - type: 'null' title: Git Version type: object required: - version - git_version title: VersionInfo description: Version information serializer for responses. XComCollectionResponse: properties: xcom_entries: items: $ref: '#/components/schemas/XComResponse' type: array title: Xcom Entries total_entries: type: integer title: Total Entries type: object required: - xcom_entries - total_entries title: XComCollectionResponse description: XCom Collection serializer for responses. XComCreateBody: properties: key: type: string title: Key value: title: Value map_index: type: integer title: Map Index default: -1 additionalProperties: false type: object required: - key - value title: XComCreateBody description: Payload serializer for creating an XCom entry. XComResponse: properties: key: type: string title: Key timestamp: type: string format: date-time title: Timestamp logical_date: anyOf: - type: string format: date-time - type: 'null' title: Logical Date map_index: type: integer title: Map Index task_id: type: string title: Task Id dag_id: type: string title: Dag Id run_id: type: string title: Run Id dag_display_name: type: string title: Dag Display Name task_display_name: type: string title: Task Display Name run_after: type: string format: date-time title: Run After type: object required: - key - timestamp - logical_date - map_index - task_id - dag_id - run_id - dag_display_name - task_display_name - run_after title: XComResponse description: Serializer for a xcom item. XComResponseNative: properties: key: type: string title: Key timestamp: type: string format: date-time title: Timestamp logical_date: anyOf: - type: string format: date-time - type: 'null' title: Logical Date map_index: type: integer title: Map Index task_id: type: string title: Task Id dag_id: type: string title: Dag Id run_id: type: string title: Run Id dag_display_name: type: string title: Dag Display Name task_display_name: type: string title: Task Display Name run_after: type: string format: date-time title: Run After value: title: Value type: object required: - key - timestamp - logical_date - map_index - task_id - dag_id - run_id - dag_display_name - task_display_name - run_after - value title: XComResponseNative description: XCom response serializer with native return type. XComResponseString: properties: key: type: string title: Key timestamp: type: string format: date-time title: Timestamp logical_date: anyOf: - type: string format: date-time - type: 'null' title: Logical Date map_index: type: integer title: Map Index task_id: type: string title: Task Id dag_id: type: string title: Dag Id run_id: type: string title: Run Id dag_display_name: type: string title: Dag Display Name task_display_name: type: string title: Task Display Name run_after: type: string format: date-time title: Run After value: anyOf: - type: string - type: 'null' title: Value type: object required: - key - timestamp - logical_date - map_index - task_id - dag_id - run_id - dag_display_name - task_display_name - run_after - value title: XComResponseString description: XCom response serializer with string return type. XComUpdateBody: properties: value: title: Value map_index: type: integer title: Map Index default: -1 additionalProperties: false type: object required: - value title: XComUpdateBody description: Payload serializer for updating an XCom entry. 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