@itentialopensource/adapter-apache_airflow

{ "openapi": "3.0.0", "info": { "title": "Airflow API (Stable)", "description": "# Overview\n\nTo facilitate management, Apache Airflow supports a range of REST API endpoints across its\nobjects.\nThis section provides an overview of the API design, methods, and supported use cases.\n\nMost of the endpoints accept `JSON` as input and return `JSON` responses.\nThis means that you must usually add the following headers to your request:\n```\nContent-type: application/json\nAccept: application/json\n```\n\n## Resources\n\nThe term `resource` refers to a single type of object in the Airflow metadata. An API is broken up by its\nendpoint's corresponding resource.\nThe name of a resource is typically plural and expressed in camelCase. Example: `dagRuns`.\n\nResource names are used as part of endpoint URLs, as well as in API parameters and responses.\n\n## CRUD Operations\n\nThe platform supports **C**reate, **R**ead, **U**pdate, and **D**elete operations on most resources.\nYou can review the standards for these operations and their standard parameters below.\n\nSome endpoints have special behavior as exceptions.\n\n### Create\n\nTo create a resource, you typically submit an HTTP `POST` request with the resource's required metadata\nin the request body.\nThe response returns a `201 Created` response code upon success with the resource's metadata, including\nits internal `id`, in the response body.\n\n### Read\n\nThe HTTP `GET` request can be used to read a resource or to list a number of resources.\n\nA resource's `id` can be submitted in the request parameters to read a specific resource.\nThe response usually returns a `200 OK` response code upon success, with the resource's metadata in\nthe response body.\n\nIf a `GET` request does not include a specific resource `id`, it is treated as a list request.\nThe response usually returns a `200 OK` response code upon success, with an object containing a list\nof resources' metadata in the response body.\n\nWhen reading resources, some common query parameters are usually available. e.g.:\n```\nv1/connections?limit=25&offset=25\n```\n\n|Query Parameter|Type|Description|\n|---------------|----|-----------|\n|limit|integer|Maximum number of objects to fetch. Usually 25 by default|\n|offset|integer|Offset after which to start returning objects. For use with limit query parameter.|\n\n### Update\n\nUpdating a resource requires the resource `id`, and is typically done using an HTTP `PATCH` request,\nwith the fields to modify in the request body.\nThe response usually returns a `200 OK` response code upon success, with information about the modified\nresource in the response body.\n\n### Delete\n\nDeleting a resource requires the resource `id` and is typically executing via an HTTP `DELETE` request.\nThe response usually returns a `204 No Content` response code upon success.\n\n## Conventions\n\n- Resource names are plural and expressed in camelCase.\n- Names are consistent between URL parameter name and field name.\n\n- Field names are in snake_case.\n```json\n{\n \"name\": \"string\",\n \"slots\": 0,\n \"occupied_slots\": 0,\n \"used_slots\": 0,\n \"queued_slots\": 0,\n \"open_slots\": 0\n}\n```\n\n### Update Mask\n\nUpdate mask is available as a query parameter in patch endpoints. It is used to notify the\nAPI which fields you want to update. Using `update_mask` makes it easier to update objects\nby helping the server know which fields to update in an object instead of updating all fields.\nThe update request ignores any fields that aren't specified in the field mask, leaving them with\ntheir current values.\n\nExample:\n```\n resource = request.get('/resource/my-id').json()\n resource['my_field'] = 'new-value'\n request.patch('/resource/my-id?update_mask=my_field', data=json.dumps(resource))\n```\n\n## Versioning and Endpoint Lifecycle\n\n- API versioning is not synchronized to specific releases of the Apache Airflow.\n- APIs are designed to be backward compatible.\n- Any changes to the API will first go through a deprecation phase.\n\n# Summary of Changes\n\n| Airflow version | Description |\n|-|-|\n| v2.0 | Initial release |\n| v2.0.2 | Added /plugins endpoint |\n| v2.1 | New providers endpoint |\n\n# Trying the API\n\nYou can use a third party client, such as [curl](https://curl.haxx.se/), [HTTPie](https://httpie.org/),\n[Postman](https://www.postman.com/) or [the Insomnia rest client](https://insomnia.rest/) to test\nthe Apache Airflow API.\n\nNote that you will need to pass credentials data.\n\nFor e.g., here is how to pause a DAG with [curl](https://curl.haxx.se/), when basic authorization is used:\n```bash\ncurl -X PATCH 'https://example.com/api/v1/dags/{dag_id}?update_mask=is_paused' \\\n-H 'Content-Type: application/json' \\\n--user \"username:password\" \\\n-d '{\n \"is_paused\": true\n}'\n```\n\nUsing a graphical tool such as [Postman](https://www.postman.com/) or [Insomnia](https://insomnia.rest/),\nit is possible to import the API specifications directly:\n\n1. Download the API specification by clicking the **Download** button at top of this document\n2. Import the JSON specification in the graphical tool of your choice.\n - In *Postman*, you can click the **import** button at the top\n - With *Insomnia*, you can just drag-and-drop the file on the UI\n\nNote that with *Postman*, you can also generate code snippets by selecting a request and clicking on\nthe **Code** button.\n\n## Enabling CORS\n\n[Cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)\nis a browser security feature that restricts HTTP requests that are\ninitiated from scripts running in the browser.\n\nFor details on enabling/configuring CORS, see\n[Enabling CORS](https://airflow.apache.org/docs/apache-airflow/stable/security/api.html).\n\n# Authentication\n\nTo be able to meet the requirements of many organizations, Airflow supports many authentication methods,\nand it is even possible to add your own method.\n\nIf you want to check which auth backend is currently set, you can use\n`airflow config get-value api auth_backend` command as in the example below.\n```bash\n$ airflow config get-value api auth_backend\nairflow.api.auth.backend.basic_auth\n```\nThe default is to deny all requests.\n\nFor details on configuring the authentication, see\n[API Authorization](https://airflow.apache.org/docs/apache-airflow/stable/security/api.html).\n\n# Errors\n\nWe follow the error response format proposed in [RFC 7807](https://tools.ietf.org/html/rfc7807)\nalso known as Problem Details for HTTP APIs. As with our normal API responses,\nyour client must be prepared to gracefully handle additional members of the response.\n\n## Unauthenticated\n\nThis indicates that the request has not been applied because it lacks valid authentication\ncredentials for the target resource. Please check that you have valid credentials.\n\n## PermissionDenied\n\nThis response means that the server understood the request but refuses to authorize\nit because it lacks sufficient rights to the resource. It happens when you do not have the\nnecessary permission to execute the action you performed. You need to get the appropriate\npermissions in other to resolve this error.\n\n## BadRequest\n\nThis response means that the server cannot or will not process the request due to something\nthat is perceived to be a client error (e.g., malformed request syntax, invalid request message\nframing, or deceptive request routing). To resolve this, please ensure that your syntax is correct.\n\n## NotFound\n\nThis client error response indicates that the server cannot find the requested resource.\n\n## MethodNotAllowed\n\nIndicates that the request method is known by the server but is not supported by the target resource.\n\n## NotAcceptable\n\nThe target resource does not have a current representation that would be acceptable to the user\nagent, according to the proactive negotiation header fields received in the request, and the\nserver is unwilling to supply a default representation.\n\n## AlreadyExists\n\nThe request could not be completed due to a conflict with the current state of the target\nresource, e.g. the resource it tries to create already exists.\n\n## Unknown\n\nThis means that the server encountered an unexpected condition that prevented it from\nfulfilling the request.\n", "contact": { "name": "Apache Software Foundation", "url": "https://airflow.apache.org", "email": "dev@airflow.apache.org" }, "version": "1.0.0" }, "servers": [ { "url": "/api/v1", "description": "Apache Airflow Stable API.", "variables": {} } ], "paths": { "/config": { "get": { "tags": [ "Config" ], "summary": "get_config", "description": "Get current configuration", "operationId": "get_config", "parameters": [], "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Config" }, "example": { "sections": [ { "name": "core", "options": [ { "key": "dags_folder", "value": "/home/user/my-dags-folder" } ] }, { "name": "smtp", "options": [ { "key": "smtp_host", "value": "localhost" }, { "key": "smtp_mail_from", "value": "airflow@example.com" } ] } ] } }, "text/plain": { "schema": { "type": "string", "example": "[core]\ndags_folder = /home/user/my-dags-folder\n[smtp]\nsmtp_host = localhost\nsmtp_mail_from = airflow@example.com\n" }, "example": "[core]\ndags_folder = /home/user/my-dags-folder\n[smtp]\nsmtp_host = localhost\nsmtp_mail_from = airflow@example.com\n" } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/connections": { "get": { "tags": [ "Connection" ], "summary": "get_connections", "description": "List connections", "operationId": "get_connections", "parameters": [ { "name": "limit", "in": "query", "description": "The numbers of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "description": "The number of items to skip before starting to collect the result set.", "style": "form", "explode": true, "schema": { "minimum": 0.0, "type": "integer", "format": "int32" } }, { "name": "order_by", "in": "query", "description": "The name of the field to order the results by.\nPrefix a field name with `-` to reverse the sort order.", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionCollection" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false }, "post": { "tags": [ "Connection" ], "summary": "post_connection", "description": "Create a connection", "operationId": "post_connection", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } }, "400": { "description": "Client specified an invalid argument.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/connections/{connection_id}": { "get": { "tags": [ "Connection" ], "summary": "get_connection", "description": "Get a connection", "operationId": "get_connection", "parameters": [ { "name": "connection_id", "in": "path", "description": "The connection ID.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false }, "patch": { "tags": [ "Connection" ], "summary": "patch_connection", "description": "Update a connection", "operationId": "patch_connection", "parameters": [ { "name": "connection_id", "in": "path", "description": "The connection ID.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "update_mask", "in": "query", "description": "The fields to update on the resource. If absent or empty, all modifiable fields are updated.\nA comma-separated list of fully qualified names of fields.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } }, "400": { "description": "Client specified an invalid argument.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false }, "delete": { "tags": [ "Connection" ], "summary": "delete_connection", "description": "Delete a connection", "operationId": "delete_connection", "parameters": [ { "name": "connection_id", "in": "path", "description": "The connection ID.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success.", "headers": {}, "content": {} }, "400": { "description": "Client specified an invalid argument.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/connections/test": { "post": { "tags": [ "Connection" ], "summary": "test_connection", "description": "Test a connection", "operationId": "test_connection", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTest" } } } }, "400": { "description": "Client specified an invalid argument.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/dags": { "get": { "tags": [ "DAG" ], "summary": "get_dags", "description": "List DAGs", "operationId": "get_dags", "parameters": [ { "name": "limit", "in": "query", "description": "The numbers of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "description": "The number of items to skip before starting to collect the result set.", "style": "form", "explode": true, "schema": { "minimum": 0.0, "type": "integer", "format": "int32" } }, { "name": "order_by", "in": "query", "description": "The name of the field to order the results by.\nPrefix a field name with `-` to reverse the sort order.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "tags", "in": "query", "description": "List of tags to filter results", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "only_active", "in": "query", "description": "Only return active DAGs.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DAGCollection" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/dags/{dag_id}": { "get": { "tags": [ "DAG" ], "summary": "get_dag", "description": "Presents only information available in database (DAGModel).\nIf you need detailed information, consider using GET /dags/{dag_id}/details.\n", "operationId": "get_dag", "parameters": [ { "name": "dag_id", "in": "path", "description": "The DAG ID.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DAG" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false }, "patch": { "tags": [ "DAG" ], "summary": "patch_dag", "description": "Update a DAG", "operationId": "patch_dag", "parameters": [ { "name": "dag_id", "in": "path", "description": "The DAG ID.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "update_mask", "in": "query", "description": "The fields to update on the resource. If absent or empty, all modifiable fields are updated.\nA comma-separated list of fully qualified names of fields.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DAG" } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DAG" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false }, "delete": { "tags": [ "DAG" ], "summary": "delete_dag", "description": "Deletes all metadata related to the DAG, including finished DAG Runs and Tasks. Logs are not deleted. This action cannot be undone.\n", "operationId": "delete_dag", "parameters": [ { "name": "dag_id", "in": "path", "description": "The DAG ID.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success.", "headers": {}, "content": {} }, "400": { "description": "Client specified an invalid argument.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "An existing resource conflicts with the request.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/dags/{dag_id}/clearTaskInstances": { "post": { "tags": [ "DAG" ], "summary": "post_clear_task_instances", "description": "Clears a set of task instances associated with the DAG for a specified date range.\n", "operationId": "post_clear_task_instances", "parameters": [ { "name": "dag_id", "in": "path", "description": "The DAG ID.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters of action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearTaskInstance" } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskInstanceReferenceCollection" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/dags/{dag_id}/updateTaskInstancesState": { "post": { "tags": [ "DAG" ], "summary": "post_set_task_instances_state", "description": "Updates the state for multiple task instances simultaneously.\n", "operationId": "post_set_task_instances_state", "parameters": [ { "name": "dag_id", "in": "path", "description": "The DAG ID.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters of action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskInstancesState" } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskInstanceReferenceCollection" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/dags/{dag_id}/details": { "get": { "tags": [ "DAG" ], "summary": "get_dag_details", "description": "The response contains many DAG attributes, so the response can be large. If possible, consider using GET /dags/{dag_id}.\n", "operationId": "get_dag_details", "parameters": [ { "name": "dag_id", "in": "path", "description": "The DAG ID.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DAGDetail" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/dags/{dag_id}/tasks": { "get": { "tags": [ "DAG" ], "summary": "get_tasks", "description": "Get tasks for DAG", "operationId": "get_tasks", "parameters": [ { "name": "dag_id", "in": "path", "description": "The DAG ID.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "order_by", "in": "query", "description": "The name of the field to order the results by.\nPrefix a field name with `-` to reverse the sort order.", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskCollection" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/dags/{dag_id}/tasks/{task_id}": { "get": { "tags": [ "DAG" ], "summary": "get_task", "description": "Get simplified representation of a task", "operationId": "get_task", "parameters": [ { "name": "dag_id", "in": "path", "description": "The DAG ID.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "task_id", "in": "path", "description": "The task ID.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/dagSources/{file_token}": { "get": { "tags": [ "DAG" ], "summary": "get_dag_source", "description": "Get a source code using file token.\n", "operationId": "get_dag_source", "parameters": [ { "name": "file_token", "in": "path", "description": "The key containing the encrypted path to the file. Encryption and decryption take place only on\nthe server. This prevents the client from reading an non-DAG file. This also ensures API\nextensibility, because the format of encrypted data may change.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DagSourcesResponse" } }, "plain/text": { "schema": { "type": "object" } } } }, "401": { "description": "Request not authenticated due to missing, invalid, authentication info.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Client does not have sufficient permission.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "A specified resource is not found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "A specified Accept header is not allowed.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false } }, "/dags/{dag_id}/dagRuns": { "get": { "tags": [ "DAGRun" ], "summary": "get_dag_runs", "description": "This endpoint allows specifying `~` as the dag_id to retrieve DAG runs for all DAGs.\n", "operationId": "get_dag_runs", "parameters": [ { "name": "dag_id", "in": "path", "description": "The DAG ID.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The numbers of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "description": "The number of items to skip before start