UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 119 kB
{"openapi":"3.0.3","servers":[{"description":"Apache Airflow Stable API.","url":"/api/v1"},{"url":"https://apache.local"}],"info":{"contact":{"email":"dev@airflow.apache.org","name":"Apache Software Foundation","url":"https://airflow.apache.org","x-twitter":"TheASF"},"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# 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_backends` command as in the example below.\n```bash\n$ airflow config get-value api auth_backends\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","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"title":"Airflow API (Stable)","version":"2.5.3","x-apisguru-categories":["messaging"],"x-logo":{"url":"https://twitter.com/TheASF/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://airflow.apache.org/docs/apache-airflow/stable/_specs/v1.yaml","version":"3.0"}],"x-providerName":"apache.org","x-serviceName":"airflow"},"externalDocs":{"url":"https://airflow.apache.org/docs/apache-airflow/stable/"},"security":[],"tags":[{"name":"Config"},{"name":"Connection"},{"name":"DAG"},{"name":"DAGRun"},{"name":"EventLog"},{"name":"ImportError"},{"name":"Monitoring"},{"name":"Pool"},{"name":"Provider"},{"name":"TaskInstance"},{"name":"Variable"},{"name":"XCom"},{"name":"Plugin"},{"name":"Role"},{"name":"Permission"},{"name":"User"},{"name":"DagWarning"},{"name":"Dataset"}],"paths":{"/config":{"get":{"operationId":"get_config","responses":{"200":{"content":{"application/json":{"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"}]}]},"schema":{"$ref":"#/components/schemas/Config"}},"text/plain":{"example":"[core]\ndags_folder = /home/user/my-dags-folder\n[smtp]\nsmtp_host = localhost\nsmtp_mail_from = airflow@example.com\n","schema":{"type":"string"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"Get current configuration","tags":["Config"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.config_endpoint"}},"/connections":{"get":{"operationId":"get_connections","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/OrderBy"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"List connections","tags":["Connection"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.connection_endpoint"},"post":{"operationId":"post_connection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"Create a connection","tags":["Connection"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.connection_endpoint"}},"/connections/test":{"post":{"description":"Test a connection.\n\n*New in version 2.2.0*\n","operationId":"test_connection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionTest"}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Test a connection","tags":["Connection"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.connection_endpoint"}},"/connections/{connection_id}":{"delete":{"operationId":"delete_connection","responses":{"204":{"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Delete a connection","tags":["Connection"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.connection_endpoint"},"get":{"operationId":"get_connection","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get a connection","tags":["Connection"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.connection_endpoint"},"parameters":[{"$ref":"#/components/parameters/ConnectionID"}],"patch":{"operationId":"patch_connection","parameters":[{"$ref":"#/components/parameters/UpdateMask"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update a connection","tags":["Connection"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.connection_endpoint"}},"/dagSources/{file_token}":{"get":{"description":"Get a source code using file token.\n","operationId":"get_dag_source","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"string"}},"type":"object"}},"plain/text":{"schema":{"type":"string"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"406":{"$ref":"#/components/responses/NotAcceptable"}},"summary":"Get a source code","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_source_endpoint"},"parameters":[{"$ref":"#/components/parameters/FileToken"}]},"/dagWarnings":{"get":{"operationId":"get_dag_warnings","parameters":[{"description":"If set, only return DAG warnings with this dag_id.","in":"query","name":"dag_id","required":false,"schema":{"type":"string"}},{"description":"If set, only return DAG warnings with this type.","in":"query","name":"warning_type","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/OrderBy"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DagWarningCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"List dag warnings","tags":["DagWarning"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_warning_endpoint"}},"/dags":{"get":{"description":"List DAGs in the database.\n`dag_id_pattern` can be set to match dags of a specific pattern\n","operationId":"get_dags","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/OrderBy"},{"$ref":"#/components/parameters/FilterTags"},{"$ref":"#/components/parameters/OnlyActive"},{"description":"If set, only return DAGs with dag_ids matching this pattern.\n","in":"query","name":"dag_id_pattern","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAGCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"}},"summary":"List DAGs","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_endpoint"},"patch":{"description":"Update DAGs of a given dag_id_pattern using UpdateMask.\nThis endpoint allows specifying `~` as the dag_id_pattern to update all DAGs.\n*New in version 2.3.0*\n","operationId":"patch_dags","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/FilterTags"},{"$ref":"#/components/parameters/UpdateMask"},{"$ref":"#/components/parameters/OnlyActive"},{"description":"If set, only update DAGs with dag_ids matching this pattern.\n","in":"query","name":"dag_id_pattern","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"is_paused":true},"schema":{"$ref":"#/components/schemas/DAG"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAGCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update DAGs","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_endpoint"}},"/dags/{dag_id}":{"delete":{"description":"Deletes all metadata related to the DAG, including finished DAG Runs and Tasks.\nLogs are not deleted. This action cannot be undone.\n\n*New in version 2.2.0*\n","operationId":"delete_dag","responses":{"204":{"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/AlreadyExists"}},"summary":"Delete a DAG","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_endpoint"},"get":{"description":"Presents only information available in database (DAGModel).\nIf you need detailed information, consider using GET /dags/{dag_id}/details.\n","operationId":"get_dag","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAG"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get basic information about a DAG","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"}],"patch":{"operationId":"patch_dag","parameters":[{"$ref":"#/components/parameters/UpdateMask"}],"requestBody":{"content":{"application/json":{"example":{"is_paused":true},"schema":{"$ref":"#/components/schemas/DAG"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAG"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update a DAG","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_endpoint"}},"/dags/{dag_id}/clearTaskInstances":{"parameters":[{"$ref":"#/components/parameters/DAGID"}],"post":{"description":"Clears a set of task instances associated with the DAG for a specified date range.\n","operationId":"post_clear_task_instances","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearTaskInstances"}}},"description":"Parameters of action","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstanceReferenceCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Clear a set of task instances","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"}},"/dags/{dag_id}/dagRuns":{"get":{"description":"This endpoint allows specifying `~` as the dag_id to retrieve DAG runs for all DAGs.\n","operationId":"get_dag_runs","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/FilterExecutionDateGTE"},{"$ref":"#/components/parameters/FilterExecutionDateLTE"},{"$ref":"#/components/parameters/FilterStartDateGTE"},{"$ref":"#/components/parameters/FilterStartDateLTE"},{"$ref":"#/components/parameters/FilterEndDateGTE"},{"$ref":"#/components/parameters/FilterEndDateLTE"},{"$ref":"#/components/parameters/FilterState"},{"$ref":"#/components/parameters/OrderBy"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAGRunCollection"}}},"description":"List of DAG runs."},"401":{"$ref":"#/components/responses/Unauthenticated"}},"summary":"List DAG runs","tags":["DAGRun"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_run_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"}],"post":{"operationId":"post_dag_run","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAGRun"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAGRun"}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/AlreadyExists"}},"summary":"Trigger a new DAG run","tags":["DAGRun"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_run_endpoint"}},"/dags/{dag_id}/dagRuns/{dag_run_id}":{"delete":{"operationId":"delete_dag_run","responses":{"204":{"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Delete a DAG run","tags":["DAGRun"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_run_endpoint"},"get":{"operationId":"get_dag_run","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAGRun"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get a DAG run","tags":["DAGRun"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_run_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"}],"patch":{"description":"Modify a DAG run.\n\n*New in version 2.2.0*\n","operationId":"update_dag_run_state","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDagRunState"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAGRun"}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Modify a DAG run","tags":["DAGRun"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_run_endpoint"}},"/dags/{dag_id}/dagRuns/{dag_run_id}/clear":{"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"}],"post":{"description":"Clear a DAG run.\n\n*New in version 2.4.0*\n","operationId":"clear_dag_run","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearDagRun"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DAGRun"},{"$ref":"#/components/schemas/TaskInstanceCollection"}]}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Clear a DAG run","tags":["DAGRun"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_run_endpoint"}},"/dags/{dag_id}/dagRuns/{dag_run_id}/setNote":{"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"}],"patch":{"description":"Update the manual user note of a DagRun.\n\n*New in version 2.5.0*\n","operationId":"set_dag_run_note","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDagRunNote"}}},"description":"Parameters of set DagRun note.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAGRun"}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update the DagRun note.","tags":["DAGRun"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_run_endpoint"}},"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances":{"get":{"description":"This endpoint allows specifying `~` as the dag_id, dag_run_id to retrieve DAG runs for all DAGs and DAG runs.\n","operationId":"get_task_instances","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstanceCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"List task instances","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"},{"$ref":"#/components/parameters/FilterExecutionDateGTE"},{"$ref":"#/components/parameters/FilterExecutionDateLTE"},{"$ref":"#/components/parameters/FilterStartDateGTE"},{"$ref":"#/components/parameters/FilterStartDateLTE"},{"$ref":"#/components/parameters/FilterEndDateGTE"},{"$ref":"#/components/parameters/FilterEndDateLTE"},{"$ref":"#/components/parameters/FilterDurationGTE"},{"$ref":"#/components/parameters/FilterDurationLTE"},{"$ref":"#/components/parameters/FilterState"},{"$ref":"#/components/parameters/FilterPool"},{"$ref":"#/components/parameters/FilterQueue"}]},"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}":{"get":{"operationId":"get_task_instance","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstance"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get a task instance","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"},{"$ref":"#/components/parameters/TaskID"}],"patch":{"description":"Updates the state for single task instance.\n*New in version 2.5.0*\n","operationId":"patch_task_instance","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskInstance"}}},"description":"Parameters of action","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstanceReference"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Updates the state of a task instance","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"}},"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links":{"get":{"description":"List extra links for task instance.\n","operationId":"get_extra_links","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtraLinkCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"List extra links","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.extra_link_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"},{"$ref":"#/components/parameters/TaskID"}]},"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMapped":{"get":{"description":"Get details of all mapped task instances.\n\n*New in version 2.3.0*\n","operationId":"get_mapped_task_instances","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/FilterExecutionDateGTE"},{"$ref":"#/components/parameters/FilterExecutionDateLTE"},{"$ref":"#/components/parameters/FilterStartDateGTE"},{"$ref":"#/components/parameters/FilterStartDateLTE"},{"$ref":"#/components/parameters/FilterEndDateGTE"},{"$ref":"#/components/parameters/FilterEndDateLTE"},{"$ref":"#/components/parameters/FilterDurationGTE"},{"$ref":"#/components/parameters/FilterDurationLTE"},{"$ref":"#/components/parameters/FilterState"},{"$ref":"#/components/parameters/FilterPool"},{"$ref":"#/components/parameters/FilterQueue"},{"$ref":"#/components/parameters/OrderBy"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstanceCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"List mapped task instances","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"},{"$ref":"#/components/parameters/TaskID"}]},"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number}":{"get":{"description":"Get logs for a specific task instance and its try number.","operationId":"get_log","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"string"},"continuation_token":{"type":"string"}},"type":"object"}},"text/plain":{"schema":{"type":"string"}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get logs","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.log_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"},{"$ref":"#/components/parameters/TaskID"},{"$ref":"#/components/parameters/TaskTryNumber"},{"$ref":"#/components/parameters/FullContent"},{"$ref":"#/components/parameters/FilterMapIndex"},{"$ref":"#/components/parameters/ContinuationToken"}]},"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/setNote":{"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"},{"$ref":"#/components/parameters/TaskID"}],"patch":{"description":"Update the manual user note of a non-mapped Task Instance.\n\n*New in version 2.5.0*\n","operationId":"set_task_instance_note","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetTaskInstanceNote"}}},"description":"Parameters of set Task Instance note.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstance"}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update the TaskInstance note.","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"}},"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries":{"get":{"description":"This endpoint allows specifying `~` as the dag_id, dag_run_id, task_id to retrieve XCOM entries for for all DAGs, DAG runs and task instances. XCom values won't be returned as they can be large. Use this endpoint to get a list of XCom entries and then fetch individual entry to get value.","operationId":"get_xcom_entries","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XComCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"List XCom entries","tags":["XCom"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.xcom_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"},{"$ref":"#/components/parameters/TaskID"}]},"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}":{"get":{"operationId":"get_xcom_entry","parameters":[{"description":"Whether to deserialize an XCom value when using a custom XCom backend.\n\nThe XCom API endpoint calls `orm_deserialize_value` by default since an XCom may contain value\nthat is potentially expensive to deserialize in the web server. Setting this to true overrides\nthe consideration, and calls `deserialize_value` instead.\n\nThis parameter is not meaningful when using the default XCom backend.\n\n*New in version 2.4.0*\n","in":"query","name":"deserialize","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XCom"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get an XCom entry","tags":["XCom"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.xcom_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"},{"$ref":"#/components/parameters/TaskID"},{"$ref":"#/components/parameters/XComKey"}]},"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}":{"get":{"description":"Get details of a mapped task instance.\n\n*New in version 2.3.0*\n","operationId":"get_mapped_task_instance","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstance"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get a mapped task instance","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"},{"$ref":"#/components/parameters/TaskID"},{"$ref":"#/components/parameters/MapIndex"}],"patch":{"description":"Updates the state for single mapped task instance.\n*New in version 2.5.0*\n","operationId":"patch_mapped_task_instance","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskInstance"}}},"description":"Parameters of action"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstanceReference"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Updates the state of a mapped task instance","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"}},"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/setNote":{"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"},{"$ref":"#/components/parameters/TaskID"},{"$ref":"#/components/parameters/MapIndex"}],"patch":{"description":"Update the manual user note of a mapped Task Instance.\n\n*New in version 2.5.0*\n","operationId":"set_mapped_task_instance_note","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetTaskInstanceNote"}}},"description":"Parameters of set Task Instance note.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstance"}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update the TaskInstance note.","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"}},"/dags/{dag_id}/dagRuns/{dag_run_id}/upstreamDatasetEvents":{"get":{"description":"Get datasets for a dag run.\n\n*New in version 2.4.0*\n","operationId":"get_upstream_dataset_events","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetEventCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get dataset events for a DAG run","tags":["DAGRun","Dataset"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_run_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/DAGRunID"}]},"/dags/{dag_id}/details":{"get":{"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","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAGDetail"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get a simplified representation of DAG","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"}]},"/dags/{dag_id}/tasks":{"get":{"operationId":"get_tasks","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get tasks for DAG","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/OrderBy"}]},"/dags/{dag_id}/tasks/{task_id}":{"get":{"operationId":"get_task","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get simplified representation of a task","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_endpoint"},"parameters":[{"$ref":"#/components/parameters/DAGID"},{"$ref":"#/components/parameters/TaskID"}]},"/dags/{dag_id}/updateTaskInstancesState":{"parameters":[{"$ref":"#/components/parameters/DAGID"}],"post":{"description":"Updates the state for multiple task instances simultaneously.\n","operationId":"post_set_task_instances_state","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskInstancesState"}}},"description":"Parameters of action","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstanceReferenceCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Set a state of task instances","tags":["DAG"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"}},"/dags/~/dagRuns/list":{"post":{"description":"This endpoint is a POST to allow filtering across a large number of DAG IDs, where as a GET it would run in to maximum HTTP request URL length limit.\n","operationId":"get_dag_runs_batch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDagRunsForm"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DAGRunCollection"}}},"description":"Success."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"List DAG runs (batch)","tags":["DAGRun"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dag_run_endpoint"}},"/dags/~/dagRuns/~/taskInstances/list":{"post":{"description":"List task instances from all DAGs and DAG runs.\nThis endpoint is a POST to allow filtering across a large number of DAG IDs, where as a GET it would run in to maximum HTTP request URL length limits.\n","operationId":"get_task_instances_batch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTaskInstanceForm"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInstanceCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"List task instances (batch)","tags":["TaskInstance"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.task_instance_endpoint"}},"/datasets":{"get":{"operationId":"get_datasets","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/OrderBy"},{"description":"If set, only return datasets with uris matching this pattern.\n","in":"query","name":"uri_pattern","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"List datasets","tags":["Dataset"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dataset_endpoint"}},"/datasets/events":{"get":{"description":"Get dataset events","operationId":"get_dataset_events","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetEventCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get dataset events","tags":["Dataset"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dataset_endpoint"},"parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/OrderBy"},{"$ref":"#/components/parameters/FilterDatasetID"},{"$ref":"#/components/parameters/FilterSourceDAGID"},{"$ref":"#/components/parameters/FilterSourceTaskID"},{"$ref":"#/components/parameters/FilterSourceRunID"},{"$ref":"#/components/parameters/FilterSourceMapIndex"}]},"/datasets/{uri}":{"get":{"description":"Get a dataset by uri.","operationId":"get_dataset","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get a dataset","tags":["Dataset"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.dataset_endpoint"},"parameters":[{"$ref":"#/components/parameters/DatasetURI"}]},"/eventLogs":{"get":{"description":"List log entries from event log.","operationId":"get_event_logs","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/OrderBy"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventLogCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"List log entries","tags":["EventLog"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.event_log_endpoint"}},"/eventLogs/{event_log_id}":{"get":{"operationId":"get_event_log","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventLog"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get a log entry","tags":["EventLog"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.event_log_endpoint"},"parameters":[{"$ref":"#/components/parameters/EventLogID"}]},"/health":{"get":{"description":"Get the status of Airflow's metadatabase and scheduler. It includes info about\nmetadatabase and last heartbeat of scheduler.\n","operationId":"get_health","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthInfo"}}},"description":"Success."}},"summary":"Get instance status","tags":["Monitoring"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.health_endpoint"}},"/importErrors":{"get":{"operationId":"get_import_errors","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/OrderBy"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportErrorCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"List import errors","tags":["ImportError"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.import_error_endpoint"}},"/importErrors/{import_error_id}":{"get":{"operationId":"get_import_error","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportError"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get an import error","tags":["ImportError"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.import_error_endpoint"},"parameters":[{"$ref":"#/components/parameters/ImportErrorID"}]},"/permissions":{"get":{"description":"Get a list of permissions.\n\n*New in version 2.1.0*\n","operationId":"get_permissions","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionCollection"}}},"description":"Success."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"List permissions","tags":["Permission"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.role_and_permission_endpoint"}},"/plugins":{"get":{"description":"Get a list of loaded plugins.\n\n*New in version 2.1.0*\n","operationId":"get_plugins","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginCollection"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get a list of loaded plugins","tags":["Plugin"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.plugin_endpoint"}},"/pools":{"get":{"operationId":"get_pools","parameters":[{"$ref":"#/components/parameters/PageLimit"},{"$ref":"#/components/parameters/PageOffset"},{"$ref":"#/components/parameters/OrderBy"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolCollection"}}},"description":"List of pools."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"summary":"List pools","tags":["Pool"],"x-openapi-router-controller":"airflow.api_connexion.endpoints.pool_endpoint"},"post":{"operationId":"post_pool","requ