{ "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" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" } ] }, "downstream_task_ids": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "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" } } ], "depends_on_past": true, "wait_for_downstream": false, "retries": 1, "queue": "string", "pool": "string", "pool_slots": 4, "execution_timeout": null, "retry_delay": null, "retry_exponential_backoff": true, "priority_weight": 4, "weight_rule": "downstream", "ui_color": "string", "ui_fgcolor": "string", "template_fields": [ "string", "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" ], "description": "string", "schedule_interval": null, "tags": [ { "name": "string" }, { "name": "string" } ] }, "downstream_task_ids": [ "string", "string" ] }, { "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" } } ], "depends_on_past": false, "wait_for_downstream": false, "retries": 8, "queue": "string", "pool": "string", "pool_slots": 8, "execution_timeout": null, "retry_delay": null, "retry_exponential_backoff": false, "priority_weight": 10, "weight_rule": "downstream", "ui_color": "string", "ui_fgcolor": "string", "template_fields": [ "string", "string", "string", "string" ], "sub_dag": { "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" ], "description": "string", "schedule_interval": null, "tags": [ { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" } ] }, "downstream_task_ids": [ "string", "string", "string", "string" ] }, { "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" } } ], "depends_on_past": true, "wait_for_downstream": false, "retries": 7, "queue": "string", "pool": "string", "pool_slots": 3, "execution_timeout": null, "retry_delay": null, "retry_exponential_backoff": false, "priority_weight": 7, "weight_rule": "downstream", "ui_color": "string", "ui_fgcolor": "string", "template_fields": [ "string" ], "sub_dag": { "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", "string" ], "description": "string", "schedule_interval": null, "tags": [ { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" } ] }, "downstream_task_ids": [ "string" ] } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/{}/tasks/{pathv2}": { "get": { "tags": [ "Dags" ], "operationId": "getTask", "description": "The parameters and request body are for method: getTask. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "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": { "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" } }, { "class_ref": { "module_path": "string", "class_name": "string" } } ], "depends_on_past": false, "wait_for_downstream": true, "retries": 3, "queue": "string", "pool": "string", "pool_slots": 2, "execution_timeout": null, "retry_delay": null, "retry_exponential_backoff": false, "priority_weight": 4, "weight_rule": "downstream", "ui_color": "string", "ui_fgcolor": "string", "template_fields": [ "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" ], "description": "string", "schedule_interval": null, "tags": [ { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" } ] }, "downstream_task_ids": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/{}/dagRuns": { "get": { "tags": [ "Dags" ], "operationId": "getDagRuns", "description": "The parameters and request body are for method: getDagRuns. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dag_runs": { "type": "array", "items": { "type": "object", "properties": { "dag_run_id": { "type": "string" }, "dag_id": { "type": "string" }, "logical_date": { "type": "string" }, "execution_date": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "state": { "type": "string" }, "external_trigger": { "type": "boolean" }, "conf": { "type": "object" } } } }, "total_entries": { "type": "number" } } }, "example": { "dag_runs": [ { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} } ], "total_entries": 2 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Dags" ], "operationId": "postDagRun", "description": "The parameters and request body are for method: postDagRun. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dag_run_id": { "type": "string" }, "dag_id": { "type": "string" }, "logical_date": { "type": "string" }, "execution_date": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "state": { "type": "string" }, "external_trigger": { "type": "boolean" }, "conf": { "type": "object" } } }, "example": { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/~/dagRuns/list": { "post": { "tags": [ "Dags" ], "operationId": "getDagRunsBatch", "description": "The parameters and request body are for method: getDagRunsBatch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dag_runs": { "type": "array", "items": { "type": "object", "properties": { "dag_run_id": { "type": "string" }, "dag_id": { "type": "string" }, "logical_date": { "type": "string" }, "execution_date": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "state": { "type": "string" }, "external_trigger": { "type": "boolean" }, "conf": { "type": "object" } } } }, "total_entries": { "type": "number" } } }, "example": { "dag_runs": [ { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} }, { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} } ], "total_entries": 9 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/{}/dagRuns/{pathv2}": { "get": { "tags": [ "Dags" ], "operationId": "getDagRun", "description": "The parameters and request body are for method: getDagRun. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dag_run_id": { "type": "string" }, "dag_id": { "type": "string" }, "logical_date": { "type": "string" }, "execution_date": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "state": { "type": "string" }, "external_trigger": { "type": "boolean" }, "conf": { "type": "object" } } }, "example": { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Dags" ], "operationId": "deleteDagRun", "description": "The parameters and request body are for method: deleteDagRun. 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": {} } } } }, "patch": { "tags": [ "Dags" ], "operationId": "updateDagRunState", "description": "The parameters and request body are for method: updateDagRunState. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dag_run_id": { "type": "string" }, "dag_id": { "type": "string" }, "logical_date": { "type": "string" }, "execution_date": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "state": { "type": "string" }, "external_trigger": { "type": "boolean" }, "conf": { "type": "object" } } }, "example": { "dag_run_id": "string", "dag_id": "string", "logical_date": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "state": "queued", "external_trigger": true, "conf": {} } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/{}/dagRuns/{pathv2}/taskInstances": { "get": { "tags": [ "Dags" ], "operationId": "getTaskInstances", "description": "The parameters and request body are for method: getTaskInstances. 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" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "duration": { "type": "number" }, "state": { "type": "string" }, "try_number": { "type": "number" }, "max_tries": { "type": "number" }, "hostname": { "type": "string" }, "unixname": { "type": "string" }, "pool": { "type": "string" }, "pool_slots": { "type": "number" }, "queue": { "type": "string" }, "priority_weight": { "type": "number" }, "operator": { "type": "string" }, "queued_when": { "type": "string" }, "pid": { "type": "number" }, "executor_config": { "type": "string" }, "sla_miss": { "type": "object", "properties": { "task_id": { "type": "string" }, "dag_id": { "type": "string" }, "execution_date": { "type": "string" }, "email_sent": { "type": "boolean" }, "timestamp": { "type": "string" }, "description": { "type": "string" }, "notification_sent": { "type": "boolean" } } } } } }, "total_entries": { "type": "number" } } }, "example": { "task_instances": [ { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 10, "state": "success", "try_number": 1, "max_tries": 6, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 6, "queue": "string", "priority_weight": 6, "operator": "string", "queued_when": "string", "pid": 5, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": true, "timestamp": "string", "description": "string", "notification_sent": false } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 1, "state": "success", "try_number": 5, "max_tries": 6, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 1, "queue": "string", "priority_weight": 4, "operator": "string", "queued_when": "string", "pid": 6, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": false, "timestamp": "string", "description": "string", "notification_sent": false } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 6, "state": "success", "try_number": 6, "max_tries": 2, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 8, "queue": "string", "priority_weight": 10, "operator": "string", "queued_when": "string", "pid": 1, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": true, "timestamp": "string", "description": "string", "notification_sent": false } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 10, "state": "success", "try_number": 1, "max_tries": 8, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 5, "queue": "string", "priority_weight": 6, "operator": "string", "queued_when": "string", "pid": 2, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": false, "timestamp": "string", "description": "string", "notification_sent": true } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 5, "state": "success", "try_number": 6, "max_tries": 1, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 1, "queue": "string", "priority_weight": 4, "operator": "string", "queued_when": "string", "pid": 5, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": false, "timestamp": "string", "description": "string", "notification_sent": false } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 3, "state": "success", "try_number": 7, "max_tries": 9, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 10, "queue": "string", "priority_weight": 5, "operator": "string", "queued_when": "string", "pid": 2, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": true, "timestamp": "string", "description": "string", "notification_sent": true } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 9, "state": "success", "try_number": 6, "max_tries": 2, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 7, "queue": "string", "priority_weight": 1, "operator": "string", "queued_when": "string", "pid": 7, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": true, "timestamp": "string", "description": "string", "notification_sent": true } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 1, "state": "success", "try_number": 9, "max_tries": 3, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 6, "queue": "string", "priority_weight": 4, "operator": "string", "queued_when": "string", "pid": 8, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": false, "timestamp": "string", "description": "string", "notification_sent": false } } ], "total_entries": 1 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/{}/dagRuns/{pathv2}/taskInstances/{pathv3}": { "get": { "tags": [ "Dags" ], "operationId": "getTaskInstance", "description": "The parameters and request body are for method: getTaskInstance. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "task_id": { "type": "string" }, "dag_id": { "type": "string" }, "execution_date": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "duration": { "type": "number" }, "state": { "type": "string" }, "try_number": { "type": "number" }, "max_tries": { "type": "number" }, "hostname": { "type": "string" }, "unixname": { "type": "string" }, "pool": { "type": "string" }, "pool_slots": { "type": "number" }, "queue": { "type": "string" }, "priority_weight": { "type": "number" }, "operator": { "type": "string" }, "queued_when": { "type": "string" }, "pid": { "type": "number" }, "executor_config": { "type": "string" }, "sla_miss": { "type": "object", "properties": { "task_id": { "type": "string" }, "dag_id": { "type": "string" }, "execution_date": { "type": "string" }, "email_sent": { "type": "boolean" }, "timestamp": { "type": "string" }, "description": { "type": "string" }, "notification_sent": { "type": "boolean" } } } } }, "example": { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 10, "state": "success", "try_number": 2, "max_tries": 10, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 9, "queue": "string", "priority_weight": 4, "operator": "string", "queued_when": "string", "pid": 4, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": false, "timestamp": "string", "description": "string", "notification_sent": true } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/~/dagRuns/~/taskInstances/list": { "post": { "tags": [ "Dags" ], "operationId": "getTaskInstancesBatch", "description": "The parameters and request body are for method: getTaskInstancesBatch. 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" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "duration": { "type": "number" }, "state": { "type": "string" }, "try_number": { "type": "number" }, "max_tries": { "type": "number" }, "hostname": { "type": "string" }, "unixname": { "type": "string" }, "pool": { "type": "string" }, "pool_slots": { "type": "number" }, "queue": { "type": "string" }, "priority_weight": { "type": "number" }, "operator": { "type": "string" }, "queued_when": { "type": "string" }, "pid": { "type": "number" }, "executor_config": { "type": "string" }, "sla_miss": { "type": "object", "properties": { "task_id": { "type": "string" }, "dag_id": { "type": "string" }, "execution_date": { "type": "string" }, "email_sent": { "type": "boolean" }, "timestamp": { "type": "string" }, "description": { "type": "string" }, "notification_sent": { "type": "boolean" } } } } } }, "total_entries": { "type": "number" } } }, "example": { "task_instances": [ { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 4, "state": "success", "try_number": 5, "max_tries": 6, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 8, "queue": "string", "priority_weight": 6, "operator": "string", "queued_when": "string", "pid": 6, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": true, "timestamp": "string", "description": "string", "notification_sent": false } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 6, "state": "success", "try_number": 4, "max_tries": 2, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 5, "queue": "string", "priority_weight": 3, "operator": "string", "queued_when": "string", "pid": 9, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": true, "timestamp": "string", "description": "string", "notification_sent": true } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 7, "state": "success", "try_number": 7, "max_tries": 7, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 5, "queue": "string", "priority_weight": 7, "operator": "string", "queued_when": "string", "pid": 5, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": false, "timestamp": "string", "description": "string", "notification_sent": false } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 6, "state": "success", "try_number": 4, "max_tries": 8, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 3, "queue": "string", "priority_weight": 5, "operator": "string", "queued_when": "string", "pid": 5, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": true, "timestamp": "string", "description": "string", "notification_sent": false } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 9, "state": "success", "try_number": 10, "max_tries": 10, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 9, "queue": "string", "priority_weight": 3, "operator": "string", "queued_when": "string", "pid": 9, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": true, "timestamp": "string", "description": "string", "notification_sent": true } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 9, "state": "success", "try_number": 5, "max_tries": 8, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 2, "queue": "string", "priority_weight": 8, "operator": "string", "queued_when": "string", "pid": 5, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": false, "timestamp": "string", "description": "string", "notification_sent": true } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 3, "state": "success", "try_number": 10, "max_tries": 9, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 10, "queue": "string", "priority_weight": 7, "operator": "string", "queued_when": "string", "pid": 10, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": false, "timestamp": "string", "description": "string", "notification_sent": false } }, { "task_id": "string", "dag_id": "string", "execution_date": "string", "start_date": "string", "end_date": "string", "duration": 5, "state": "success", "try_number": 4, "max_tries": 5, "hostname": "string", "unixname": "string", "pool": "string", "pool_slots": 6, "queue": "string", "priority_weight": 1, "operator": "string", "queued_when": "string", "pid": 1, "executor_config": "string", "sla_miss": { "task_id": "string", "dag_id": "string", "execution_date": "string", "email_sent": true, "timestamp": "string", "description": "string", "notification_sent": false } } ], "total_entries": 9 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/{}/dagRuns/{pathv2}/taskInstances/{pathv3}/links": { "get": { "tags": [ "Dags" ], "operationId": "getExtraLinks", "description": "The parameters and request body are for method: getExtraLinks. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "extra_links": { "type": "array", "items": { "type": "object", "properties": { "class_ref": { "type": "object", "properties": { "module_path": { "type": "string" }, "class_name": { "type": "string" } } }, "name": { "type": "string" }, "href": { "type": "string" } } } } } }, "example": { "extra_links": [ { "class_ref": { "module_path": "string", "class_name": "string" }, "name": "string", "href": "string" }, { "class_ref": { "module_path": "string", "class_name": "string" }, "name": "string", "href": "string" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/{}/dagRuns/{pathv2}/taskInstances/{pathv3}/logs/{pathv4}": { "get": { "tags": [ "Dags" ], "operationId": "getLog", "description": "The parameters and request body are for method: getLog. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "continuation_token": { "type": "string" }, "content": { "type": "string" } } }, "example": { "continuation_token": "string", "content": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/{}/dagRuns/{pathv2}/taskInstances/{pathv3}/xcomEntries": { "get": { "tags": [ "Dags" ], "operationId": "getXcomEntries", "description": "The parameters and request body are for method: getXcomEntries. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "xcom_entries": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "timestamp": { "type": "string" }, "execution_date": { "type": "string" }, "task_id": { "type": "string" }, "dag_id": { "type": "string" } } } }, "total_entries": { "type": "number" } } }, "example": { "xcom_entries": [ { "key": "string", "timestamp": "string", "execution_date": "string", "task_id": "string", "dag_id": "string" }, { "key": "string", "timestamp": "string", "execution_date": "string", "task_id": "string", "dag_id": "string" }, { "key": "string", "timestamp": "string", "execution_date": "string", "task_id": "string", "dag_id": "string" }, { "key": "string", "timestamp": "string", "execution_date": "string", "task_id": "string", "dag_id": "string" }, { "key": "string", "timestamp": "string", "execution_date": "string", "task_id": "string", "dag_id": "string" }, { "key": "string", "timestamp": "string", "execution_date": "string", "task_id": "string", "dag_id": "string" }, { "key": "string", "timestamp": "string", "execution_date": "string", "task_id": "string", "dag_id": "string" } ], "total_entries": 4 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dags/{}/dagRuns/{pathv2}/taskInstances/{pathv3}/xcomEntries/{pathv4}": { "get": { "tags": [ "Dags" ], "operationId": "getXcomEntry", "description": "The parameters and request body are for method: getXcomEntry. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "timestamp": { "type": "string" }, "execution_date": { "type": "string" }, "task_id": { "type": "string" }, "dag_id": { "type": "string" }, "value": { "type": "string" } } }, "example": { "key": "string", "timestamp": "string", "execution_date": "string", "task_id": "string", "dag_id": "string", "value": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dagSources/{}": { "get": { "tags": [ "DagSources" ], "operationId": "getDagSource", "description": "The parameters and request body are for method: getDagSource. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string" } } }, "example": { "content": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/eventLogs": { "get": { "tags": [ "EventLogs" ], "operationId": "getEventLogs", "description": "The parameters and request body are for method: getEventLogs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "event_logs": { "type": "array", "items": { "type": "object", "properties": { "event_log_id": { "type": "number" }, "when": { "type": "string" }, "dag_id": { "type": "string" }, "task_id": { "type": "string" }, "event": { "type": "string" }, "execution_date": { "type": "string" }, "owner": { "type": "string" }, "extra": { "type": "string" } } } }, "total_entries": { "type": "number" } } }, "example": { "event_logs": [ { "event_log_id": 2, "when": "string", "dag_id": "string", "task_id": "string", "event": "string", "execution_date": "string", "owner": "string", "extra": "string" }, { "event_log_id": 9, "when": "string", "dag_id": "string", "task_id": "string", "event": "string", "execution_date": "string", "owner": "string", "extra": "string" }, { "event_log_id": 8, "when": "string", "dag_id": "string", "task_id": "string", "event": "string", "execution_date": "string", "owner": "string", "extra": "string" }, { "event_log_id": 4, "when": "string", "dag_id": "string", "task_id": "string", "event": "string", "execution_date": "string", "owner": "string", "extra": "string" } ], "total_entries": 6 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/eventLogs/{}": { "get": { "tags": [ "EventLogs" ], "operationId": "getEventLog", "description": "The parameters and request body are for method: getEventLog. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "event_log_id": { "type": "number" }, "when": { "type": "string" }, "dag_id": { "type": "string" }, "task_id": { "type": "string" }, "event": { "type": "string" }, "execution_date": { "type": "string" }, "owner": { "type": "string" }, "extra": { "type": "string" } } }, "example": { "event_log_id": 7, "when": "string", "dag_id": "string", "task_id": "string", "event": "string", "execution_date": "string", "owner": "string", "extra": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/importErrors": { "get": { "tags": [ "ImportErrors" ], "operationId": "getImportErrors", "description": "The parameters and request body are for method: getImportErrors. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "import_errors": { "type": "array", "items": { "type": "object", "properties": { "import_error_id": { "type": "number" }, "timestamp": { "type": "string" }, "filename": { "type": "string" }, "stack_trace": { "type": "string" } } } }, "total_entries": { "type": "number" } } }, "example": { "import_errors": [ { "import_error_id": 5, "timestamp": "string", "filename": "string", "stack_trace": "string" }, { "import_error_id": 10, "timestamp": "string", "filename": "string", "stack_trace": "string" }, { "import_error_id": 10, "timestamp": "string", "filename": "string", "stack_trace": "string" }, { "import_error_id": 9, "timestamp": "string", "filename": "string", "stack_trace": "string" }, { "import_error_id": 5, "timestamp": "string", "filename": "string", "stack_trace": "string" }, { "import_error_id": 4, "timestamp": "string", "filename": "string", "stack_trace": "string" }, { "import_error_id": 6, "timestamp": "string", "filename": "string", "stack_trace": "string" } ], "total_entries": 10 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/importErrors/{}": { "get": { "tags": [ "ImportErrors" ], "operationId": "getImportError", "description": "The parameters and request body are for method: getImportError. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "import_error_id": { "type": "number" }, "timestamp": { "type": "string" }, "filename": { "type": "string" }, "stack_trace": { "type": "string" } } }, "example": { "import_error_id": 3, "timestamp": "string", "filename": "string", "stack_trace": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/health": { "get": { "tags": [ "Health" ], "operationId": "getHealth", "description": "The parameters and request body are for method: getHealth. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadatabase": { "type": "object", "properties": { "status": { "type": "string" } } }, "scheduler": { "type": "object", "properties": { "status": { "type": "string" }, "latest_scheduler_heartbeat": { "type": "string" } } } } }, "example": { "metadatabase": { "status": "healthy" }, "scheduler": { "status": "healthy", "latest_scheduler_heartbeat": "string" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/version": { "get": { "tags": [ "Version" ], "operationId": "getVersion", "description": "The parameters and request body are for method: getVersion. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string" }, "git_version": { "type": "string" } } }, "example": { "version": "string", "git_version": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pools": { "get": { "tags": [ "Pools" ], "operationId": "getPools", "description": "The parameters and request body are for method: getPools. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "pools": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "slots": { "type": "number" }, "occupied_slots": { "type": "number" }, "used_slots": { "type": "number" }, "queued_slots": { "type": "number" }, "open_slots": { "type": "number" } } } }, "total_entries": { "type": "number" } } }, "example": { "pools": [ { "name": "string", "slots": 2, "occupied_slots": 8, "used_slots": 4, "queued_slots": 5, "open_slots": 5 }, { "name": "string", "slots": 1, "occupied_slots": 7, "used_slots": 7, "queued_slots": 4, "open_slots": 4 }, { "name": "string", "slots": 3, "occupied_slots": 3, "used_slots": 10, "queued_slots": 1, "open_slots": 4 }, { "name": "string", "slots": 10, "occupied_slots": 7, "used_slots": 9, "queued_slots": 7, "open_slots": 5 }, { "name": "string", "slots": 7, "occupied_slots": 8, "used_slots": 8, "queued_slots": 4, "open_slots": 9 }, { "name": "string", "slots": 6, "occupied_slots": 6, "used_slots": 4, "queued_slots": 1, "open_slots": 7 }, { "name": "string", "slots": 2, "occupied_slots": 1, "used_slots": 9, "queued_slots": 8, "open_slots": 6 }, { "name": "string", "slots": 9, "occupied_slots": 2, "used_slots": 10, "queued_slots": 7, "open_slots": 2 }, { "name": "string", "slots": 5, "occupied_slots": 5, "used_slots": 4, "queued_slots": 4, "open_slots": 1 }, { "name": "string", "slots": 6, "occupied_slots": 4, "used_slots": 7, "queued_slots": 4, "open_slots": 4 } ], "total_entries": 7 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Pools" ], "operationId": "postPool", "description": "The parameters and request body are for method: postPool. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "slots": { "type": "number" }, "occupied_slots": { "type": "number" }, "used_slots": { "type": "number" }, "queued_slots": { "type": "number" }, "open_slots": { "type": "number" } } }, "example": { "name": "string", "slots": 4, "occupied_slots": 3, "used_slots": 5, "queued_slots": 10, "open_slots": 6 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pools/{}": { "get": { "tags": [ "Pools" ], "operationId": "getPool", "description": "The parameters and request body are for method: getPool. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "slots": { "type": "number" }, "occupied_slots": { "type": "number" }, "used_slots": { "type": "number" }, "queued_slots": { "type": "number" }, "open_slots": { "type": "number" } } }, "example": { "name": "string", "slots": 1, "occupied_slots": 8, "used_slots": 2, "queued_slots": 8, "open_slots": 8 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Pools" ], "operationId": "patchPool", "description": "The parameters and request body are for method: patchPool. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "slots": { "type": "number" }, "occupied_slots": { "type": "number" }, "used_slots": { "type": "number" }, "queued_slots": { "type": "number" }, "open_slots": { "type": "number" } } }, "example": { "name": "string", "slots": 8, "occupied_slots": 1, "used_slots": 7, "queued_slots": 8, "open_slots": 1 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Pools" ], "operationId": "deletePool", "description": "The parameters and request body are for method: deletePool. 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": {} } } } } }, "/providers": { "get": { "tags": [ "Providers" ], "operationId": "getProviders", "description": "The parameters and request body are for method: getProviders. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "providers": { "type": "array", "items": { "type": "object", "properties": { "package_name": { "type": "string" }, "description": { "type": "string" }, "version": { "type": "string" } } } }, "total_entries": { "type": "number" } } }, "example": { "providers": [ { "package_name": "string", "description": "string", "version": "string" }, { "package_name": "string", "description": "string", "version": "string" } ], "total_entries": 4 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/variables": { "get": { "tags": [ "Variables" ], "operationId": "getVariables", "description": "The parameters and request body are for method: getVariables. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "variables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" } } } }, "total_entries": { "type": "number" } } }, "example": { "variables": [ { "key": "string" }, { "key": "string" } ], "total_entries": 2 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Variables" ], "operationId": "postVariables", "description": "The parameters and request body are for method: postVariables. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "example": { "key": "string", "value": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/variables/{}": { "get": { "tags": [ "Variables" ], "operationId": "getVariable", "description": "The parameters and request body are for method: getVariable. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "example": { "key": "string", "value": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Variables" ], "operationId": "patchVariable", "description": "The parameters and request body are for method: patchVariable. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "example": { "key": "string", "value": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Variables" ], "operationId": "deleteVariable", "description": "The parameters and request body are for method: deleteVariable. 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": {} } } } } }, "/plugins": { "get": { "tags": [ "Plugins" ], "operationId": "getPlugins", "description": "The parameters and request body are for method: getPlugins. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "plugins": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "string" }, "name": { "type": "string" }, "hooks": { "type": "array", "items": { "type": "string" } }, "executors": { "type": "array", "items": { "type": "string" } }, "macros": { "type": "array", "items": { "type": "object" } }, "flask_blueprints": { "type": "array", "items": { "type": "object" } }, "appbuilder_views": { "type": "array", "items": { "type": "object" } }, "appbuilder_menu_items": { "type": "array", "items": { "type": "object" } }, "global_operator_extra_links": { "type": "array", "items": { "type": "object" } }, "operator_extra_links": { "type": "array", "items": { "type": "object" } }, "source": { "type": "string" } } } }, "total_entries": { "type": "number" } } }, "example": { "plugins": [ { "number": "string", "name": "string", "hooks": [ "string" ], "executors": [ "string", "string", "string", "string", "string", "string" ], "macros": [ {}, {}, {}, {}, {}, {}, {}, {} ], "flask_blueprints": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "appbuilder_views": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ], "appbuilder_menu_items": [ {}, {}, {} ], "global_operator_extra_links": [ {}, {} ], "operator_extra_links": [ {}, {}, {}, {}, {} ], "source": "string" }, { "number": "string", "name": "string", "hooks": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "executors": [ "string", "string", "string" ], "macros": [ {}, {}, {}, {} ], "flask_blueprints": [ {}, {}, {}, {}, {}, {} ], "appbuilder_views": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "appbuilder_menu_items": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ], "global_operator_extra_links": [ {}, {}, {} ], "operator_extra_links": [ {}, {}, {} ], "source": "string" }, { "number": "string", "name": "string", "hooks": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "executors": [ "string", "string", "string", "string", "string", "string" ], "macros": [ {}, {}, {}, {} ], "flask_blueprints": [ {}, {}, {}, {}, {}, {}, {}, {} ], "appbuilder_views": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ], "appbuilder_menu_items": [ {}, {} ], "global_operator_extra_links": [ {} ], "operator_extra_links": [ {}, {}, {}, {} ], "source": "string" }, { "number": "string", "name": "string", "hooks": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "executors": [ "string", "string", "string", "string", "string" ], "macros": [ {}, {}, {}, {}, {}, {}, {} ], "flask_blueprints": [ {}, {}, {}, {}, {} ], "appbuilder_views": [ {}, {}, {}, {}, {}, {}, {} ], "appbuilder_menu_items": [ {}, {}, {}, {} ], "global_operator_extra_links": [ {}, {}, {} ], "operator_extra_links": [ {}, {}, {} ], "source": "string" }, { "number": "string", "name": "string", "hooks": [ "string", "string" ], "executors": [ "string" ], "macros": [ {} ], "flask_blueprints": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "appbuilder_views": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "appbuilder_menu_items": [ {}, {}, {}, {}, {}, {} ], "global_operator_extra_links": [ {}, {}, {}, {}, {}, {}, {}, {} ], "operator_extra_links": [ {}, {}, {}, {}, {}, {} ], "source": "string" }, { "number": "string", "name": "string", "hooks": [ "string", "string", "string" ], "executors": [ "string", "string", "string", "string", "string", "string", "string" ], "macros": [ {}, {}, {}, {}, {} ], "flask_blueprints": [ {}, {} ], "appbuilder_views": [ {}, {}, {}, {}, {} ], "appbuilder_menu_items": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "global_operator_extra_links": [ {} ], "operator_extra_links": [ {}, {}, {} ], "source": "string" }, { "number": "string", "name": "string", "hooks": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "executors": [ "string", "string", "string", "string", "string", "string", "string" ], "macros": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "flask_blueprints": [ {}, {}, {}, {}, {}, {}, {} ], "appbuilder_views": [ {}, {} ], "appbuilder_menu_items": [ {}, {}, {} ], "global_operator_extra_links": [ {}, {} ], "operator_extra_links": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "source": "string" }, { "number": "string", "name": "string", "hooks": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "executors": [ "string", "string", "string", "string" ], "macros": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "flask_blueprints": [ {}, {}, {}, {}, {} ], "appbuilder_views": [ {}, {}, {} ], "appbuilder_menu_items": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "global_operator_extra_links": [ {}, {}, {}, {}, {} ], "operator_extra_links": [ {}, {} ], "source": "string" }, { "number": "string", "name": "string", "hooks": [ "string", "string" ], "executors": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "macros": [ {}, {}, {}, {}, {}, {} ], "flask_blueprints": [ {}, {}, {}, {}, {}, {}, {} ], "appbuilder_views": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "appbuilder_menu_items": [ {}, {}, {}, {} ], "global_operator_extra_links": [ {}, {}, {}, {}, {}, {}, {} ], "operator_extra_links": [ {}, {}, {}, {} ], "source": "string" }, { "number": "string", "name": "string", "hooks": [ "string", "string", "string" ], "executors": [ "string" ], "macros": [ {}, {}, {}, {}, {}, {}, {} ], "flask_blueprints": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "appbuilder_views": [ {}, {}, {}, {}, {}, {}, {} ], "appbuilder_menu_items": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "global_operator_extra_links": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "operator_extra_links": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ], "source": "string" } ], "total_entries": 3 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/roles": { "get": { "tags": [ "Roles" ], "operationId": "getRoles", "description": "The parameters and request body are for method: getRoles. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "object", "properties": { "name": { "type": "string" } } }, "resource": { "type": "object", "properties": { "name": { "type": "string" } } } } } } } } }, "total_entries": { "type": "number" } } }, "example": { "roles": [ { "name": "string", "actions": [ { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } } ] }, { "name": "string", "actions": [ { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } } ] }, { "name": "string", "actions": [ { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } } ] }, { "name": "string", "actions": [ { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } } ] }, { "name": "string", "actions": [ { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } } ] } ], "total_entries": 4 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Roles" ], "operationId": "postRole", "description": "The parameters and request body are for method: postRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "object", "properties": { "name": { "type": "string" } } }, "resource": { "type": "object", "properties": { "name": { "type": "string" } } } } } } } }, "example": { "name": "string", "actions": [ { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/roles/{}": { "get": { "tags": [ "Roles" ], "operationId": "getRole", "description": "The parameters and request body are for method: getRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "object", "properties": { "name": { "type": "string" } } }, "resource": { "type": "object", "properties": { "name": { "type": "string" } } } } } } } }, "example": { "name": "string", "actions": [ { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Roles" ], "operationId": "patchRole", "description": "The parameters and request body are for method: patchRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "object", "properties": { "name": { "type": "string" } } }, "resource": { "type": "object", "properties": { "name": { "type": "string" } } } } } } } }, "example": { "name": "string", "actions": [ { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Roles" ], "operationId": "deleteRole", "description": "The parameters and request body are for method: deleteRole. 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": {} } } } } }, "/permissions": { "get": { "tags": [ "Permissions" ], "operationId": "getPermissions", "description": "The parameters and request body are for method: getPermissions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } } } }, "total_entries": { "type": "number" } } }, "example": { "actions": [ { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" } ], "total_entries": 10 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users": { "get": { "tags": [ "Users" ], "operationId": "getUsers", "description": "The parameters and request body are for method: getUsers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "active": { "type": "boolean" }, "last_login": { "type": "string" }, "login_count": { "type": "number" }, "failed_login_count": { "type": "number" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } } } }, "created_on": { "type": "string" }, "changed_on": { "type": "string" } } } }, "total_entries": { "type": "number" } } }, "example": { "users": [ { "first_name": "string", "last_name": "string", "username": "string", "email": "string", "active": false, "last_login": "string", "login_count": 6, "failed_login_count": 9, "roles": [ { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" } ], "created_on": "string", "changed_on": "string" }, { "first_name": "string", "last_name": "string", "username": "string", "email": "string", "active": true, "last_login": "string", "login_count": 7, "failed_login_count": 6, "roles": [ { "name": "string" } ], "created_on": "string", "changed_on": "string" }, { "first_name": "string", "last_name": "string", "username": "string", "email": "string", "active": false, "last_login": "string", "login_count": 3, "failed_login_count": 1, "roles": [ { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" } ], "created_on": "string", "changed_on": "string" }, { "first_name": "string", "last_name": "string", "username": "string", "email": "string", "active": true, "last_login": "string", "login_count": 3, "failed_login_count": 8, "roles": [ { "name": "string" }, { "name": "string" }, { "name": "string" } ], "created_on": "string", "changed_on": "string" }, { "first_name": "string", "last_name": "string", "username": "string", "email": "string", "active": true, "last_login": "string", "login_count": 2, "failed_login_count": 5, "roles": [ { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" } ], "created_on": "string", "changed_on": "string" }, { "first_name": "string", "last_name": "string", "username": "string", "email": "string", "active": true, "last_login": "string", "login_count": 7, "failed_login_count": 7, "roles": [ { "name": "string" }, { "name": "string" } ], "created_on": "string", "changed_on": "string" } ], "total_entries": 1 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Users" ], "operationId": "postUser", "description": "The parameters and request body are for method: postUser. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "active": { "type": "boolean" }, "last_login": { "type": "string" }, "login_count": { "type": "number" }, "failed_login_count": { "type": "number" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } } } }, "created_on": { "type": "string" }, "changed_on": { "type": "string" }, "password": { "type": "string" } } }, "example": { "first_name": "string", "last_name": "string", "username": "string", "email": "string", "active": false, "last_login": "string", "login_count": 8, "failed_login_count": 10, "roles": [ { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" } ], "created_on": "string", "changed_on": "string", "password": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users/{}": { "get": { "tags": [ "Users" ], "operationId": "getUser", "description": "The parameters and request body are for method: getUser. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "active": { "type": "boolean" }, "last_login": { "type": "string" }, "login_count": { "type": "number" }, "failed_login_count": { "type": "number" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } } } }, "created_on": { "type": "string" }, "changed_on": { "type": "string" } } }, "example": { "first_name": "string", "last_name": "string", "username": "string", "email": "string", "active": false, "last_login": "string", "login_count": 7, "failed_login_count": 8, "roles": [ { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" }, { "name": "string" } ], "created_on": "string", "changed_on": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Users" ], "operationId": "patchUser", "description": "The parameters and request body are for method: patchUser. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "object", "properties": { "name": { "type": "string" } } }, "resource": { "type": "object", "properties": { "name": { "type": "string" } } } } } } } }, "example": { "name": "string", "actions": [ { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } }, { "action": { "name": "string" }, "resource": { "name": "string" } } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Users" ], "operationId": "deleteUser", "description": "The parameters and request body are for method: deleteUser. 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": {} } } } } } }, "components": { "schemas": {} } }