@itentialopensource/adapter-apache_airflow
Version:
This adapter integrates with system described as: Apache Airflow
1,709 lines (1,708 loc) • 154 kB
JSON
{
"id": "@itentialopensource/adapter-apache_airflow",
"type": "Adapter",
"export": "ApacheAirflow",
"title": "Apache_airflow",
"src": "adapter.js",
"roles": [
"admin"
],
"methods": [
{
"name": "iapUpdateAdapterConfiguration",
"summary": "Updates the adapter configuration",
"description": "Updates the adapter configuration file with the provided changes",
"input": [
{
"name": "configFile",
"type": "string",
"info": "The name of the file to change",
"required": true,
"schema": {
"title": "configFile",
"type": "string"
}
},
{
"name": "changes",
"type": "object",
"info": "JSON object containing the configuration changes",
"required": true,
"schema": {
"title": "changes",
"type": "object"
}
},
{
"name": "entity",
"type": "string",
"info": "The entity in which the changes are being made",
"required": false,
"schema": {
"title": "entity",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of file to change - action, schema, or mock",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "action",
"type": "string",
"info": "The action to be changed",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name" : "replace",
"type": "boolean",
"info": "True to replace entire mock data, false to merge/append",
"required": false,
"schema": {
"title": "replace",
"type" : "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUpdateAdapterConfiguration"
},
"task": true
},
{
"name": "iapSuspendAdapter",
"summary": "Suspends the adapter",
"description": "Suspends the adapter",
"input": [
{
"name": "mode",
"type": "enum",
"enumerals": [
"pause",
"error"
],
"info": "How incoming requests are handled. Defaults to 'pause'",
"description": "How incoming requests are handled. Defaults to 'pause'",
"schema": {
"title": "mode",
"type": "string"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapSuspendAdapter"
},
"task": true
},
{
"name": "iapUnsuspendAdapter",
"summary": "Unsuspends the adapter",
"description": "Unsuspends the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUnsuspendAdapter"
},
"task": true
},
{
"name": "iapGetAdapterQueue",
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
"description": "Return the requests that are waiting in the queue if throttling is enabled",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter queue",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetAdapterQueue"
},
"task": true
},
{
"name": "iapFindAdapterPath",
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
"description": "Provides the ability to see if a particular API path is supported by the adapter",
"input": [
{
"name": "apiPath",
"type": "string",
"info": "The API Path you want to check - make sure to not include base path and version",
"description": "The API Path you want to check - make sure to not include base path and version",
"schema": {
"title": "apiPath",
"type": "string"
},
"required": true
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapFindAdapterPath"
},
"task": true
},
{
"name": "iapTroubleshootAdapter",
"summary": "Runs troubleshoot script for adapter",
"description": "Runs troubleshoot script for adapter",
"input": [
{
"name": "props",
"type": "object",
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
"required": true,
"schema": {
"title": "props",
"type": "object"
}
},
{
"name": "persistFlag",
"type": "boolean",
"info": "Whether the input properties should be saved",
"required": true,
"schema": {
"title": "persistFlag",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapTroubleshootAdapter"
},
"task": true
},
{
"name": "iapRunAdapterHealthcheck",
"summary": "Runs healthcheck script for adapter",
"description": "Runs healthcheck script for adapter",
"input": [],
"output": {
"name": "result",
"type": "boolean",
"description": "Whether healthcheck passed or failed",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterHealthcheck"
},
"task": true
},
{
"name": "iapRunAdapterConnectivity",
"summary": "Runs connectivity check script for adapter",
"description": "Runs connectivity check script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterConnectivity"
},
"task": true
},
{
"name": "iapRunAdapterBasicGet",
"summary": "Runs basicGet script for adapter",
"description": "Runs basicGet script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterBasicGet"
},
"task": true
},
{
"name": "iapMoveAdapterEntitiesToDB",
"summary": "Moves entities from an adapter into the IAP database",
"description": "Moves entities from an adapter into the IAP database",
"input": [],
"output": {
"name": "res",
"type": "object",
"description": "A JSON Object containing status, code and the response from the mongo transaction",
"schema": {
"title": "res",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapMoveAdapterEntitiesToDB"
},
"task": true
},
{
"name": "iapDeactivateTasks",
"summary": "Deactivate the inputted tasks",
"description": "Deactivate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to deactivate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapDeactivateTasks"
},
"task": true
},
{
"name": "iapActivateTasks",
"summary": "Activate the inputted tasks",
"description": "activate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to activate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapActivateTasks"
},
"task": true
},
{
"name": "iapPopulateEntityCache",
"summary": "Populate the cache for the given entities",
"description": "Populate the cache for the given entities",
"input": [
{
"name": "entityTypes",
"type": "array",
"info": "the entity type(s) to populate",
"required": true,
"schema": {
"title": "entityTypes",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapPopulateEntityCache"
},
"task": true
},
{
"name": "iapRetrieveEntitiesCache",
"summary": "Retrieves data from cache for specified entity type",
"description": "Retrieves data from cache for specified entity type",
"input": [
{
"name": "entityType",
"type": "string",
"info": "entity of which to retrieve",
"required": true,
"schema": {
"title": "entityType",
"type": "string"
}
},
{
"name": "options",
"type": "object",
"info": "settings of which data to return and how to return it",
"required": false,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRetrieveEntitiesCache"
},
"task": true
},
{
"name": "getDevice",
"summary": "Get the Appliance",
"description": "Get the Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevice"
},
"task": false
},
{
"name": "getDevicesFiltered",
"summary": "Get Appliances that match the filter",
"description": "Get Appliances that match the filter",
"input": [
{
"name": "options",
"type": "object",
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
"required": true,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "array",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevicesFiltered"
},
"task": false
},
{
"name": "isAlive",
"summary": "Checks the status for the provided Appliance",
"description": "Checks the status for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "boolean",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAlive"
},
"task": false
},
{
"name": "getConfig",
"summary": "Gets a config for the provided Appliance",
"description": "Gets a config for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "format",
"type": "string",
"info": "The format to be returned - this is ignored as we always return json",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfig"
},
"task": false
},
{
"name": "iapGetDeviceCount",
"summary": "Gets a device count from the system",
"description": "Gets a device count from the system",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetDeviceCount"
},
"task": false
},
{
"name": "iapExpandedGenericAdapterRequest",
"summary": "Makes the requested generic call with additional options",
"description": "Makes the requested generic call with additional options via metadata",
"input": [
{
"name": "metadata",
"type": "object",
"info": "metadata for the call (optional)",
"description": "metadata for the call - allows for many enhancements (optional)",
"schema": {
"title": "metadata",
"type": "object"
},
"required": false
},
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": false
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": false
},
{
"name": "pathVars",
"type": "object",
"info": "the parameters to be put within the url path (optional)",
"description": "the parameters to be put within the url path (optional)",
"schema": {
"title": "pathVars",
"type": "object"
},
"required": false
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapExpandedGenericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequest",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequestNoBasePath",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequestNoBasePath"
},
"task": true
},
{
"name": "iapRunAdapterLint",
"summary": "Run the adapter lint script to return the results",
"description": "Run the adapter lint script to return the results",
"input": [],
"output": {
"name": "result",
"type": "string",
"description": "A string containing the run results",
"schema": {
"title": "result",
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterLint"
},
"task": true
},
{
"name": "iapRunAdapterTests",
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterTests"
},
"task": true
},
{
"name": "iapGetAdapterInventory",
"summary": "Provide inventory information abbout the adapter",
"description": "Provide inventory information abbout the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapGetAdapterInventory"
},
"task": true
},
{
"name": "getAirflowConfig",
"summary": "get_config",
"description": "Get current configuration",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getAirflowConfig"
},
"task": true
},
{
"name": "getConnections",
"summary": "get_connections",
"description": "List connections",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "ConnectionCollection",
"type": "object",
"properties": {
"connections": {
"type": "array",
"items": {
"title": "ConnectionCollectionItem",
"type": "object",
"properties": {
"connection_id": {
"type": "string",
"description": "The connection ID."
},
"conn_type": {
"type": "string",
"description": "The connection type."
},
"host": {
"type": "string",
"description": "Host of the connection.",
"x-nullable": true
},
"login": {
"type": "string",
"description": "Login of the connection.",
"x-nullable": true
},
"schema": {
"type": "string",
"description": "Schema of the connection.",
"x-nullable": true
},
"port": {
"type": "integer",
"description": "Port of the connection.",
"x-nullable": true
}
},
"description": "Connection collection item.\nThe password and extra fields are only available when retrieving a single object due to the sensitivity of this data."
},
"description": ""
},
"total_entries": {
"type": "integer",
"description": "Count of objects in the current result set."
}
},
"description": "Collection of connections."
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getConnections"
},
"task": true
},
{
"name": "postConnection",
"summary": "post_connection",
"description": "Create a connection",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "Connection",
"type": "object",
"properties": {
"connection_id": {
"type": "string",
"description": "The connection ID."
},
"conn_type": {
"type": "string",
"description": "The connection type."
},
"host": {
"type": "string",
"description": "Host of the connection.",
"x-nullable": true
},
"login": {
"type": "string",
"description": "Login of the connection.",
"x-nullable": true
},
"schema": {
"type": "string",
"description": "Schema of the connection.",
"x-nullable": true
},
"port": {
"type": "integer",
"description": "Port of the connection.",
"x-nullable": true
},
"password": {
"type": "string",
"description": "Password of the connection."
},
"extra": {
"type": "string",
"description": "Other values that cannot be put into another field, e.g. RSA keys.",
"x-nullable": true
}
},
"description": "Full representation of the connection."
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/postConnection"
},
"task": true
},
{
"name": "getConnection",
"summary": "get_connection",
"description": "Get a connection",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "Connection",
"type": "object",
"properties": {
"connection_id": {
"type": "string",
"description": "The connection ID."
},
"conn_type": {
"type": "string",
"description": "The connection type."
},
"host": {
"type": "string",
"description": "Host of the connection.",
"x-nullable": true
},
"login": {
"type": "string",
"description": "Login of the connection.",
"x-nullable": true
},
"schema": {
"type": "string",
"description": "Schema of the connection.",
"x-nullable": true
},
"port": {
"type": "integer",
"description": "Port of the connection.",
"x-nullable": true
},
"password": {
"type": "string",
"description": "Password of the connection."
},
"extra": {
"type": "string",
"description": "Other values that cannot be put into another field, e.g. RSA keys.",
"x-nullable": true
}
},
"description": "Full representation of the connection."
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getConnection"
},
"task": true
},
{
"name": "patchConnection",
"summary": "patch_connection",
"description": "Update a connection",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "Connection",
"type": "object",
"properties": {
"connection_id": {
"type": "string",
"description": "The connection ID."
},
"conn_type": {
"type": "string",
"description": "The connection type."
},
"host": {
"type": "string",
"description": "Host of the connection.",
"x-nullable": true
},
"login": {
"type": "string",
"description": "Login of the connection.",
"x-nullable": true
},
"schema": {
"type": "string",
"description": "Schema of the connection.",
"x-nullable": true
},
"port": {
"type": "integer",
"description": "Port of the connection.",
"x-nullable": true
},
"password": {
"type": "string",
"description": "Password of the connection."
},
"extra": {
"type": "string",
"description": "Other values that cannot be put into another field, e.g. RSA keys.",
"x-nullable": true
}
},
"description": "Full representation of the connection."
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/patchConnection"
},
"task": true
},
{
"name": "deleteConnection",
"summary": "delete_connection",
"description": "Delete a connection",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/deleteConnection"
},
"task": true
},
{
"name": "testConnection",
"summary": "test_connection",
"description": "Test a connection",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "ConnectionTest",
"type": "object",
"properties": {
"status": {
"type": "boolean",
"description": "The status of the request."
},
"message": {
"type": "string",
"description": "The success or failure message of the request."
}
},
"description": "Connection test results."
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/testConnection"
},
"task": true
},
{
"name": "getDags",
"summary": "get_dags",
"description": "List DAGs",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "DAGCollection",
"type": "object",
"properties": {
"dags": {
"type": "array",
"items": {
"title": "DAG",
"type": "object",
"properties": {
"dag_id": {
"type": "string",
"description": "The ID of the DAG."
},
"root_dag_id": {
"type": "string",
"description": "If the DAG is SubDAG then it is the top level DAG identifier. Otherwise, null.",
"x-nullable": true
},
"is_paused": {
"type": "boolean",
"description": "Whether the DAG is paused.",
"x-nullable": true
},
"is_active": {
"type": "boolean",
"description": "Whether the DAG is currently seen by the scheduler(s).",
"x-nullable": true
},
"is_subdag": {
"type": "boolean",
"description": "Whether the DAG is SubDAG."
},
"fileloc": {
"type": "string",
"description": "The absolute path to the file."
},
"file_token": {
"type": "string",
"description": "The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change."
},
"owners": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"description": {
"type": "string",
"description": "User-provided DAG description, which can consist of several sentences or paragraphs that describe DAG contents.",
"x-nullable": true
},
"schedule_interval": {
"description": "Schedule interval. Defines how often DAG runs, this object gets added to your latest task instance's\nexecution_date to figure out the next schedule."
},
"tags": {
"type": "array",
"items": {
"title": "Tag",
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"description": "Tag"
},
"description": "List of tags.",
"x-nullable": true
}
},
"description": "DAG"
},
"description": ""
},
"total_entries": {
"type": "integer",
"description": "Count of objects in the current result set."
}
},
"description": "Collection of DAGs."
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getDags"
},
"task": true
},
{
"name": "getDag",
"summary": "get_dag",
"description": "Presents only information available in database (DAGModel).\nIf you need detailed information, consider using GET /dags/{dag_id}/details.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "DAG",
"type": "object",
"properties": {
"dag_id": {
"type": "string",
"description": "The ID of the DAG."
},
"root_dag_id": {
"type": "string",
"description": "If the DAG is SubDAG then it is the top level DAG identifier. Otherwise, null.",
"x-nullable": true
},
"is_paused": {
"type": "boolean",
"description": "Whether the DAG is paused.",
"x-nullable": true
},
"is_active": {
"type": "boolean",
"description": "Whether the DAG is currently seen by the scheduler(s).",
"x-nullable": true
},
"is_subdag": {
"type": "boolean",
"description": "Whether the DAG is SubDAG."
},
"fileloc": {
"type": "string",
"description": "The absolute path to the file."
},
"file_token": {
"type": "string",
"description": "The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change."
},
"owners": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"description": {
"type": "string",
"description": "User-provided DAG description, which can consist of several sentences or paragraphs that describe DAG contents.",
"x-nullable": true
},
"schedule_interval": {
"description": "Schedule interval. Defines how often DAG runs, this object gets added to your latest task instance's\nexecution_date to figure out the next schedule."
},
"tags": {
"type": "array",
"items": {
"title": "Tag",
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"description": "Tag"
},
"description": "List of tags.",
"x-nullable": true
}
},
"description": "DAG"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getDag"
},
"task": true
},
{
"name": "patchDag",
"summary": "patch_dag",
"description": "Update a DAG",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "DAG",
"type": "object",
"properties": {
"dag_id": {
"type": "string",
"description": "The ID of the DAG."
},
"root_dag_id": {
"type": "string",
"description": "If the DAG is SubDAG then it is the top level DAG identifier. Otherwise, null.",
"x-nullable": true
},
"is_paused": {
"type": "boolean",
"description": "Whether the DAG is paused.",
"x-nullable": true
},
"is_active": {
"type": "boolean",
"description": "Whether the DAG is currently seen by the scheduler(s).",
"x-nullable": true
},
"is_subdag": {
"type": "boolean",
"description": "Whether the DAG is SubDAG."
},
"fileloc": {
"type": "string",
"description": "The absolute path to the file."
},
"file_token": {
"type": "string",
"description": "The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change."
},
"owners": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"description": {
"type": "string",
"description": "User-provided DAG description, which can consist of several sentences or paragraphs that describe DAG contents.",
"x-nullable": true
},
"schedule_interval": {
"description": "Schedule interval. Defines how often DAG runs, this object gets added to your latest task instance's\nexecution_date to figure out the next schedule."
},
"tags": {
"type": "array",
"items": {
"title": "Tag",
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"description": "Tag"
},
"description": "List of tags.",
"x-nullable": true
}
},
"description": "DAG"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/patchDag"
},
"task": true
},
{
"name": "deleteDag",
"summary": "delete_dag",
"description": "Deletes all metadata related to the DAG, including finished DAG Runs and Tasks. Logs are not deleted. This action cannot be undone.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/deleteDag"
},
"task": true
},
{
"name": "postClearTaskInstances",
"summary": "post_clear_task_instances",
"description": "Clears a set of task instances associated with the DAG for a specified date range.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "TaskInstanceReferenceCollection",
"type": "object",
"properties": {
"task_instances": {
"type": "array",
"items": {
"title": "TaskInstanceReference",
"type": "object",
"properties": {
"task_id": {
"type": "string",
"description": "The task ID."
},
"dag_id": {
"type": "string",
"description": "The DAG ID."
},
"execution_date": {
"type": "string"
},
"dag_run_id": {
"type": "string",
"description": "The DAG run ID."
}
}
},
"description": ""
}
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/postClearTaskInstances"
},
"task": true
},
{
"name": "postSetTaskInstancesState",
"summary": "post_set_task_instances_state",
"description": "Updates the state for multiple task instances simultaneously.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "TaskInstanceReferenceCollection",
"type": "object",
"properties": {
"task_instances": {
"type": "array",
"items": {
"title": "TaskInstanceReference",
"type": "object",
"properties": {
"task_id": {
"type": "string",
"description": "The task ID."
},
"dag_id": {
"type": "string",
"description": "The DAG ID."
},
"execution_date": {
"type": "string"
},