@itentialopensource/adapter-apache_airflow
Version:
This adapter integrates with system described as: Apache Airflow
1,548 lines (1,547 loc) • 240 kB
JSON
{
"openapi": "3.1.0",
"info": {
"title": "",
"version": "1.0.0"
},
"paths": {
"/config": {
"get": {
"tags": [
"Config"
],
"operationId": "getConfig",
"description": "The parameters and request body are for method: getConfig. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/connections": {
"get": {
"tags": [
"Connections"
],
"operationId": "getConnections",
"description": "The parameters and request body are for method: getConnections. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"connections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"connection_id": {
"type": "string"
},
"conn_type": {
"type": "string"
},
"host": {
"type": "string"
},
"login": {
"type": "string"
},
"schema": {
"type": "string"
},
"port": {
"type": "number"
}
}
}
},
"total_entries": {
"type": "number"
}
}
},
"example": {
"connections": [
{
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 2
},
{
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 2
},
{
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 6
},
{
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 8
},
{
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 10
},
{
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 7
},
{
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 5
},
{
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 4
},
{
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 10
}
],
"total_entries": 5
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Connections"
],
"operationId": "postConnection",
"description": "The parameters and request body are for method: postConnection. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"connection_id": {
"type": "string"
},
"conn_type": {
"type": "string"
},
"host": {
"type": "string"
},
"login": {
"type": "string"
},
"schema": {
"type": "string"
},
"port": {
"type": "number"
},
"password": {
"type": "string"
},
"extra": {
"type": "string"
}
}
},
"example": {
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 6,
"password": "string",
"extra": "string"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/connections/{}": {
"get": {
"tags": [
"Connections"
],
"operationId": "getConnection",
"description": "The parameters and request body are for method: getConnection. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"connection_id": {
"type": "string"
},
"conn_type": {
"type": "string"
},
"host": {
"type": "string"
},
"login": {
"type": "string"
},
"schema": {
"type": "string"
},
"port": {
"type": "number"
},
"password": {
"type": "string"
},
"extra": {
"type": "string"
}
}
},
"example": {
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 5,
"password": "string",
"extra": "string"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"Connections"
],
"operationId": "patchConnection",
"description": "The parameters and request body are for method: patchConnection. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"connection_id": {
"type": "string"
},
"conn_type": {
"type": "string"
},
"host": {
"type": "string"
},
"login": {
"type": "string"
},
"schema": {
"type": "string"
},
"port": {
"type": "number"
},
"password": {
"type": "string"
},
"extra": {
"type": "string"
}
}
},
"example": {
"connection_id": "string",
"conn_type": "string",
"host": "string",
"login": "string",
"schema": "string",
"port": 1,
"password": "string",
"extra": "string"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"delete": {
"tags": [
"Connections"
],
"operationId": "deleteConnection",
"description": "The parameters and request body are for method: deleteConnection. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/connections/test": {
"post": {
"tags": [
"Connections"
],
"operationId": "testConnection",
"description": "The parameters and request body are for method: testConnection. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
}
}
},
"example": {
"status": true,
"message": "string"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/dags": {
"get": {
"tags": [
"Dags"
],
"operationId": "getDags",
"description": "The parameters and request body are for method: getDags. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dag_id": {
"type": "string"
},
"root_dag_id": {
"type": "string"
},
"is_paused": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"is_subdag": {
"type": "boolean"
},
"fileloc": {
"type": "string"
},
"file_token": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"schedule_interval": {
"type": "object"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
}
},
"total_entries": {
"type": "number"
}
}
},
"example": {
"dags": [
{
"dag_id": "string",
"root_dag_id": "string",
"is_paused": false,
"is_active": false,
"is_subdag": true,
"fileloc": "string",
"file_token": "string",
"owners": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"description": "string",
"schedule_interval": null,
"tags": [
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
}
]
},
{
"dag_id": "string",
"root_dag_id": "string",
"is_paused": true,
"is_active": true,
"is_subdag": false,
"fileloc": "string",
"file_token": "string",
"owners": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"description": "string",
"schedule_interval": null,
"tags": [
{
"name": "string"
},
{
"name": "string"
}
]
},
{
"dag_id": "string",
"root_dag_id": "string",
"is_paused": false,
"is_active": false,
"is_subdag": true,
"fileloc": "string",
"file_token": "string",
"owners": [
"string",
"string",
"string"
],
"description": "string",
"schedule_interval": null,
"tags": [
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
}
]
},
{
"dag_id": "string",
"root_dag_id": "string",
"is_paused": true,
"is_active": false,
"is_subdag": true,
"fileloc": "string",
"file_token": "string",
"owners": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"description": "string",
"schedule_interval": null,
"tags": [
{
"name": "string"
}
]
}
],
"total_entries": 9
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/dags/{}": {
"get": {
"tags": [
"Dags"
],
"operationId": "getDag",
"description": "The parameters and request body are for method: getDag. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dag_id": {
"type": "string"
},
"root_dag_id": {
"type": "string"
},
"is_paused": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"is_subdag": {
"type": "boolean"
},
"fileloc": {
"type": "string"
},
"file_token": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"schedule_interval": {
"type": "object"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"example": {
"dag_id": "string",
"root_dag_id": "string",
"is_paused": false,
"is_active": false,
"is_subdag": true,
"fileloc": "string",
"file_token": "string",
"owners": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"description": "string",
"schedule_interval": null,
"tags": [
{
"name": "string"
}
]
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"Dags"
],
"operationId": "patchDag",
"description": "The parameters and request body are for method: patchDag. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dag_id": {
"type": "string"
},
"root_dag_id": {
"type": "string"
},
"is_paused": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"is_subdag": {
"type": "boolean"
},
"fileloc": {
"type": "string"
},
"file_token": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"schedule_interval": {
"type": "object"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"example": {
"dag_id": "string",
"root_dag_id": "string",
"is_paused": true,
"is_active": true,
"is_subdag": false,
"fileloc": "string",
"file_token": "string",
"owners": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"description": "string",
"schedule_interval": null,
"tags": [
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
}
]
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"delete": {
"tags": [
"Dags"
],
"operationId": "deleteDag",
"description": "The parameters and request body are for method: deleteDag. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/dags/{}/clearTaskInstances": {
"post": {
"tags": [
"Dags"
],
"operationId": "postClearTaskInstances",
"description": "The parameters and request body are for method: postClearTaskInstances. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"task_instances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"task_id": {
"type": "string"
},
"dag_id": {
"type": "string"
},
"execution_date": {
"type": "string"
},
"dag_run_id": {
"type": "string"
}
}
}
}
}
},
"example": {
"task_instances": [
{
"task_id": "string",
"dag_id": "string",
"execution_date": "string",
"dag_run_id": "string"
},
{
"task_id": "string",
"dag_id": "string",
"execution_date": "string",
"dag_run_id": "string"
},
{
"task_id": "string",
"dag_id": "string",
"execution_date": "string",
"dag_run_id": "string"
}
]
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/dags/{}/updateTaskInstancesState": {
"post": {
"tags": [
"Dags"
],
"operationId": "postSetTaskInstancesState",
"description": "The parameters and request body are for method: postSetTaskInstancesState. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"task_instances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"task_id": {
"type": "string"
},
"dag_id": {
"type": "string"
},
"execution_date": {
"type": "string"
},
"dag_run_id": {
"type": "string"
}
}
}
}
}
},
"example": {
"task_instances": [
{
"task_id": "string",
"dag_id": "string",
"execution_date": "string",
"dag_run_id": "string"
},
{
"task_id": "string",
"dag_id": "string",
"execution_date": "string",
"dag_run_id": "string"
},
{
"task_id": "string",
"dag_id": "string",
"execution_date": "string",
"dag_run_id": "string"
}
]
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/dags/{}/details": {
"get": {
"tags": [
"Dags"
],
"operationId": "getDagDetails",
"description": "The parameters and request body are for method: getDagDetails. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dag_id": {
"type": "string"
},
"root_dag_id": {
"type": "string"
},
"is_paused": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"is_subdag": {
"type": "boolean"
},
"fileloc": {
"type": "string"
},
"file_token": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"schedule_interval": {
"type": "object"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"timezone": {
"type": "string"
},
"catchup": {
"type": "boolean"
},
"orientation": {
"type": "string"
},
"concurrency": {
"type": "number"
},
"start_date": {
"type": "string"
},
"dag_run_timeout": {
"type": "object"
},
"doc_md": {
"type": "string"
},
"default_view": {
"type": "string"
},
"params": {
"type": "object"
}
}
},
"example": {
"dag_id": "string",
"root_dag_id": "string",
"is_paused": false,
"is_active": true,
"is_subdag": false,
"fileloc": "string",
"file_token": "string",
"owners": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"description": "string",
"schedule_interval": null,
"tags": [
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
}
],
"timezone": "string",
"catchup": false,
"orientation": "string",
"concurrency": 5,
"start_date": "string",
"dag_run_timeout": null,
"doc_md": "string",
"default_view": "string",
"params": {}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/dags/{}/tasks": {
"get": {
"tags": [
"Dags"
],
"operationId": "getTasks",
"description": "The parameters and request body are for method: getTasks. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"class_ref": {
"type": "object",
"properties": {
"module_path": {
"type": "string"
},
"class_name": {
"type": "string"
}
}
},
"task_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"trigger_rule": {
"type": "string"
},
"extra_links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"class_ref": {
"type": "object",
"properties": {
"module_path": {
"type": "string"
},
"class_name": {
"type": "string"
}
}
}
}
}
},
"depends_on_past": {
"type": "boolean"
},
"wait_for_downstream": {
"type": "boolean"
},
"retries": {
"type": "number"
},
"queue": {
"type": "string"
},
"pool": {
"type": "string"
},
"pool_slots": {
"type": "number"
},
"execution_timeout": {
"type": "object"
},
"retry_delay": {
"type": "object"
},
"retry_exponential_backoff": {
"type": "boolean"
},
"priority_weight": {
"type": "number"
},
"weight_rule": {
"type": "string"
},
"ui_color": {
"type": "string"
},
"ui_fgcolor": {
"type": "string"
},
"template_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"sub_dag": {
"type": "object",
"properties": {
"dag_id": {
"type": "string"
},
"root_dag_id": {
"type": "string"
},
"is_paused": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"is_subdag": {
"type": "boolean"
},
"fileloc": {
"type": "string"
},
"file_token": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"schedule_interval": {
"type": "object"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"downstream_task_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"tasks": [
{
"class_ref": {
"module_path": "string",
"class_name": "string"
},
"task_id": "string",
"owner": "string",
"start_date": "string",
"end_date": "string",
"trigger_rule": "all_success",
"extra_links": [
{
"class_ref": {
"module_path": "string",
"class_name": "string"
}
},
{
"class_ref": {
"module_path": "string",
"class_name": "string"
}
},
{
"class_ref": {
"module_path": "string",
"class_name": "string"
}
},
{
"class_ref": {
"module_path": "string",
"class_name": "string"
}
},
{
"class_ref": {
"module_path": "string",
"class_name": "string"
}
},
{
"class_ref": {
"module_path": "string",
"class_name": "string"
}
},
{
"class_ref": {
"module_path": "string",
"class_name": "string"
}
},
{
"class_ref": {
"module_path": "string",
"class_name": "string"
}
},
{
"class_ref": {
"module_path": "string",
"class_name": "string"
}
}
],
"depends_on_past": false,
"wait_for_downstream": false,
"retries": 6,
"queue": "string",
"pool": "string",
"pool_slots": 3,
"execution_timeout": null,
"retry_delay": null,
"retry_exponential_backoff": false,
"priority_weight": 5,
"weight_rule": "downstream",
"ui_color": "string",
"ui_fgcolor": "string",
"template_fields": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sub_dag": {
"dag_id": "string",
"root_dag_id": "string",
"is_paused": true,
"is_active": true,
"is_subdag": false,
"fileloc": "string",
"file_token": "string",
"owners": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"description": "string",
"schedule_interval": null,
"tags": [
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{