AgentMode

{ "resources": [ { "server_url": "", "path": "/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}", "method": "get", "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": { "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" }, "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" } ] }, "conf": { "additionalProperties": true, "type": "object", "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" } }, "type": "object", "required": [ "dag_run_id", "dag_id", "logical_date", "queued_at", "start_date", "end_date", "data_interval_start", "data_interval_end", "run_after", "last_scheduling_decision", "run_type", "state", "triggered_by", "conf", "note", "dag_versions", "bundle_version" ], "title": "DAGRunResponse", "description": "DAG Run serializer for responses." } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" } } } } }, "request_body_parameters": {}, "description": "", "tags": [ "DagRun" ], "operationId": "get_dag_run" }, { "server_url": "", "path": "/api/v2/dags/{dag_id}/dagRuns", "method": "get", "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_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Run After Lte" } }, { "name": "logical_date_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Logical Date Gte" } }, { "name": "logical_date_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Logical Date Lte" } }, { "name": "start_date_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date Gte" } }, { "name": "start_date_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date Lte" } }, { "name": "end_date_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Gte" } }, { "name": "end_date_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Lte" } }, { "name": "updated_at_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At Gte" } }, { "name": "updated_at_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At Lte" } }, { "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": "order_by", "in": "query", "required": false, "schema": { "type": "string", "default": "id", "title": "Order By" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "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." } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" } } } } }, "request_body_parameters": {}, "description": "Get all DAG Runs.\n\nThis endpoint allows specifying `~` as the dag_id to retrieve Dag Runs for all DAGs.", "tags": [ "DagRun" ], "operationId": "get_dag_runs" }, { "server_url": "", "path": "/api/v2/dags", "method": "get", "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" } ], "title": "Dag Id Pattern" } }, { "name": "dag_display_name_pattern", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dag Display Name Pattern" } }, { "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": "last_dag_run_state", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/DagRunState" }, { "type": "null" } ], "title": "Last Dag Run State" } }, { "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_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Dag Run Start Date Lte" } }, { "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_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Dag Run End Date Lte" } }, { "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": "string", "default": "dag_id", "title": "Order By" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "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." } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Forbidden" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" } } } } }, "request_body_parameters": {}, "description": "Get all DAGs.", "tags": [ "DAG" ], "operationId": "get_dags" }, { "server_url": "", "path": "/api/v2/dags/{dag_id}", "method": "get", "parameters": [ { "name": "dag_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Dag Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "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_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" }, "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" }, "owners": { "items": { "type": "string" }, "type": "array", "title": "Owners" }, "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_expired", "bundle_name", "bundle_version", "relative_fileloc", "fileloc", "description", "timetable_summary", "timetable_description", "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", "owners", "file_token" ], "title": "DAGResponse", "description": "DAG serializer for responses." } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Forbidden" }, "400": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unprocessable Entity" } }, "request_body_parameters": {}, "description": "Get basic information about a DAG.", "tags": [ "DAG" ], "operationId": "get_dag" }, { "server_url": "", "path": "/api/v2/dags/{dag_id}/details", "method": "get", "parameters": [ { "name": "dag_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Dag Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "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_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" }, "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" }, "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" }, "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.", "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_expired", "bundle_name", "bundle_version", "relative_fileloc", "fileloc", "description", "timetable_summary", "timetable_description", "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", "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", "file_token", "concurrency", "latest_dag_version" ], "title": "DAGDetailsResponse", "description": "Specific serializer for DAG Details responses." } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Forbidden" }, "400": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" } } } } }, "request_body_parameters": {}, "description": "Get details of DAG.", "tags": [ "DAG" ], "operationId": "get_dag_details" }, { "server_url": "", "path": "/api/v2/jobs", "method": "get", "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_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date Lte" } }, { "name": "end_date_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Gte" } }, { "name": "end_date_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Lte" } }, { "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": "string", "default": "id", "title": "Order By" } }, { "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": { "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." } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Forbidden" }, "400": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Bad Request" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" } } } } }, "request_body_parameters": {}, "description": "Get all jobs.", "tags": [ "Job" ], "operationId": "get_jobs" }, { "server_url": "", "path": "/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances", "method": "get", "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": "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_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Run After Lte" } }, { "name": "logical_date_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Logical Date Gte" } }, { "name": "logical_date_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Logical Date Lte" } }, { "name": "start_date_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date Gte" } }, { "name": "start_date_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date Lte" } }, { "name": "end_date_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Gte" } }, { "name": "end_date_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Lte" } }, { "name": "updated_at_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At Gte" } }, { "name": "updated_at_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At Lte" } }, { "name": "duration_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration Gte" } }, { "name": "duration_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration Lte" } }, { "name": "task_display_name_pattern", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Display Name Pattern" } }, { "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": "queue", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "title": "Queue" } }, { "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": "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": "string", "default": "map_index", "title": "Order By" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "properties": { "task_instances": { "items": { "$ref": "#/components/schemas/TaskInstanceResponse" }, "type": "array", "title": "Task Instances" }, "total_entries": { "type": "integer", "title": "Total Entries" } }, "type": "object", "required": [ "task_instances", "total_entries" ], "title": "TaskInstanceCollectionResponse", "description": "Task Instance Collection serializer for responses." } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" } } } } }, "request_body_parameters": {}, "description": "Get list of task instances.\n\nThis endpoint allows specifying `~` as the dag_id, dag_run_id to retrieve Task Instances for all DAGs\nand DAG runs.", "tags": [ "Task Instance" ], "operationId": "get_task_instances" }, { "server_url": "", "path": "/api/v2/dags/{dag_id}/tasks", "method": "get", "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": { "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." } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Forbidden" }, "400": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" } } } } }, "request_body_parameters": {}, "description": "Get tasks for DAG.", "tags": [ "Task" ], "operationId": "get_tasks" }, { "server_url": "", "path": "/api/v2/dags/{dag_id}/tasks/{task_id}", "method": "get", "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": { "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": "boolean", "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." } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Forbidden" }, "400": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" } } } } }, "request_body_parameters": {}, "description": "Get simplified representation of a task.", "tags": [ "Task" ], "operationId": "get_task" }, { "server_url": "", "path": "/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{try_number}", "method": "get", "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": "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", "text/plain", "*/*" ], "default": "*/*", "title": "Accept" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "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." } }, "text/plain": { "schema": { "type": "string", "example": "content\n" } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "HTTPExceptionResponse", "description": "HTTPException Model used for error response." } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" } } } } }, "request_body_parameters": {}, "description": "Get logs for a specific task instance.", "tags": [ "Task Instance" ], "operationId": "get_log" } ], "tools": [] }