| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information |
| # regarding copyright ownership. The ASF licenses this file |
| # to you under the Apache License, Version 2.0 (the |
| # "License"); you may not use this file except in compliance |
| # with the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, |
| # software distributed under the License is distributed on an |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| # KIND, either express or implied. See the License for the |
| # specific language governing permissions and limitations |
| # under the License. |
| |
| """ |
| Airflow API (Stable) |
| |
| # Overview To facilitate management, Apache Airflow supports a range of REST API endpoints across its objects. This section provides an overview of the API design, methods, and supported use cases. Most of the endpoints accept `JSON` as input and return `JSON` responses. This means that you must usually add the following headers to your request: ``` Content-type: application/json Accept: application/json ``` ## Resources The term `resource` refers to a single type of object in the Airflow metadata. An API is broken up by its endpoint's corresponding resource. The name of a resource is typically plural and expressed in camelCase. Example: `dagRuns`. Resource names are used as part of endpoint URLs, as well as in API parameters and responses. ## CRUD Operations The platform supports **C**reate, **R**ead, **U**pdate, and **D**elete operations on most resources. You can review the standards for these operations and their standard parameters below. Some endpoints have special behavior as exceptions. ### Create To create a resource, you typically submit an HTTP `POST` request with the resource's required metadata in the request body. The response returns a `201 Created` response code upon success with the resource's metadata, including its internal `id`, in the response body. ### Read The HTTP `GET` request can be used to read a resource or to list a number of resources. A resource's `id` can be submitted in the request parameters to read a specific resource. The response usually returns a `200 OK` response code upon success, with the resource's metadata in the response body. If a `GET` request does not include a specific resource `id`, it is treated as a list request. The response usually returns a `200 OK` response code upon success, with an object containing a list of resources' metadata in the response body. When reading resources, some common query parameters are usually available. e.g.: ``` v1/connections?limit=25&offset=25 ``` |Query Parameter|Type|Description| |---------------|----|-----------| |limit|integer|Maximum number of objects to fetch. Usually 25 by default| |offset|integer|Offset after which to start returning objects. For use with limit query parameter.| ### Update Updating a resource requires the resource `id`, and is typically done using an HTTP `PATCH` request, with the fields to modify in the request body. The response usually returns a `200 OK` response code upon success, with information about the modified resource in the response body. ### Delete Deleting a resource requires the resource `id` and is typically executing via an HTTP `DELETE` request. The response usually returns a `204 No Content` response code upon success. ## Conventions - Resource names are plural and expressed in camelCase. - Names are consistent between URL parameter name and field name. - Field names are in snake_case. ```json { \"name\": \"string\", \"slots\": 0, \"occupied_slots\": 0, \"used_slots\": 0, \"queued_slots\": 0, \"open_slots\": 0 } ``` ### Update Mask Update mask is available as a query parameter in patch endpoints. It is used to notify the API which fields you want to update. Using `update_mask` makes it easier to update objects by helping the server know which fields to update in an object instead of updating all fields. The update request ignores any fields that aren't specified in the field mask, leaving them with their current values. Example: ``` resource = request.get('/resource/my-id').json() resource['my_field'] = 'new-value' request.patch('/resource/my-id?update_mask=my_field', data=json.dumps(resource)) ``` ## Versioning and Endpoint Lifecycle - API versioning is not synchronized to specific releases of the Apache Airflow. - APIs are designed to be backward compatible. - Any changes to the API will first go through a deprecation phase. # Summary of Changes | Airflow version | Description | |-|-| | v2.0 | Initial release | | v2.0.2 | Added /plugins endpoint | | v2.1 | New providers endpoint | # Trying the API You can use a third party client, such as [curl](https://curl.haxx.se/), [HTTPie](https://httpie.org/), [Postman](https://www.postman.com/) or [the Insomnia rest client](https://insomnia.rest/) to test the Apache Airflow API. Note that you will need to pass credentials data. For e.g., here is how to pause a DAG with [curl](https://curl.haxx.se/), when basic authorization is used: ```bash curl -X POST 'https://example.com/api/v1/dags/{dag_id}?update_mask=is_paused' \\ -H 'Content-Type: application/json' \\ --user \"username:password\" \\ -d '{ \"is_paused\": true }' ``` Using a graphical tool such as [Postman](https://www.postman.com/) or [Insomnia](https://insomnia.rest/), it is possible to import the API specifications directly: 1. Download the API specification by clicking the **Download** button at top of this document 2. Import the JSON specification in the graphical tool of your choice. - In *Postman*, you can click the **import** button at the top - With *Insomnia*, you can just drag-and-drop the file on the UI Note that with *Postman*, you can also generate code snippets by selecting a request and clicking on the **Code** button. ## Enabling CORS [Cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is a browser security feature that restricts HTTP requests that are initiated from scripts running in the browser. For details on enabling/configuring CORS, see [Enabling CORS](https://airflow.apache.org/docs/apache-airflow/stable/security/api.html). # Authentication To be able to meet the requirements of many organizations, Airflow supports many authentication methods, and it is even possible to add your own method. If you want to check which auth backend is currently set, you can use `airflow config get-value api auth_backend` command as in the example below. ```bash $ airflow config get-value api auth_backend airflow.api.auth.backend.basic_auth ``` The default is to deny all requests. For details on configuring the authentication, see [API Authorization](https://airflow.apache.org/docs/apache-airflow/stable/security/api.html). # Errors We follow the error response format proposed in [RFC 7807](https://tools.ietf.org/html/rfc7807) also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response. ## Unauthenticated This indicates that the request has not been applied because it lacks valid authentication credentials for the target resource. Please check that you have valid credentials. ## PermissionDenied This response means that the server understood the request but refuses to authorize it because it lacks sufficient rights to the resource. It happens when you do not have the necessary permission to execute the action you performed. You need to get the appropriate permissions in other to resolve this error. ## BadRequest This response means that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). To resolve this, please ensure that your syntax is correct. ## NotFound This client error response indicates that the server cannot find the requested resource. ## MethodNotAllowed Indicates that the request method is known by the server but is not supported by the target resource. ## NotAcceptable The target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request, and the server is unwilling to supply a default representation. ## AlreadyExists The request could not be completed due to a conflict with the current state of the target resource, meaning that the resource already exists ## Unknown This means that the server encountered an unexpected condition that prevented it from fulfilling the request. # noqa: E501 |
| |
| The version of the OpenAPI document: 1.0.0 |
| Contact: dev@airflow.apache.org |
| Generated by: https://openapi-generator.tech |
| """ |
| |
| |
| import io |
| import json |
| import logging |
| import re |
| import ssl |
| from urllib.parse import urlencode |
| |
| import urllib3 |
| |
| from airflow_client.client.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError |
| |
| |
| logger = logging.getLogger(__name__) |
| |
| |
| class RESTResponse(io.IOBase): |
| |
| def __init__(self, resp): |
| self.urllib3_response = resp |
| self.status = resp.status |
| self.reason = resp.reason |
| self.data = resp.data |
| |
| def getheaders(self): |
| """Returns a dictionary of the response headers.""" |
| return self.urllib3_response.getheaders() |
| |
| def getheader(self, name, default=None): |
| """Returns a given response header.""" |
| return self.urllib3_response.getheader(name, default) |
| |
| |
| class RESTClientObject(object): |
| |
| def __init__(self, configuration, pools_size=4, maxsize=None): |
| # urllib3.PoolManager will pass all kw parameters to connectionpool |
| # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 |
| # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 |
| # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 |
| # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 |
| |
| # cert_reqs |
| if configuration.verify_ssl: |
| cert_reqs = ssl.CERT_REQUIRED |
| else: |
| cert_reqs = ssl.CERT_NONE |
| |
| addition_pool_args = {} |
| if configuration.assert_hostname is not None: |
| addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 |
| |
| if configuration.retries is not None: |
| addition_pool_args['retries'] = configuration.retries |
| |
| if configuration.socket_options is not None: |
| addition_pool_args['socket_options'] = configuration.socket_options |
| |
| if maxsize is None: |
| if configuration.connection_pool_maxsize is not None: |
| maxsize = configuration.connection_pool_maxsize |
| else: |
| maxsize = 4 |
| |
| # https pool manager |
| if configuration.proxy: |
| self.pool_manager = urllib3.ProxyManager( |
| num_pools=pools_size, |
| maxsize=maxsize, |
| cert_reqs=cert_reqs, |
| ca_certs=configuration.ssl_ca_cert, |
| cert_file=configuration.cert_file, |
| key_file=configuration.key_file, |
| proxy_url=configuration.proxy, |
| proxy_headers=configuration.proxy_headers, |
| **addition_pool_args |
| ) |
| else: |
| self.pool_manager = urllib3.PoolManager( |
| num_pools=pools_size, |
| maxsize=maxsize, |
| cert_reqs=cert_reqs, |
| ca_certs=configuration.ssl_ca_cert, |
| cert_file=configuration.cert_file, |
| key_file=configuration.key_file, |
| **addition_pool_args |
| ) |
| |
| def request(self, method, url, query_params=None, headers=None, |
| body=None, post_params=None, _preload_content=True, |
| _request_timeout=None): |
| """Perform requests. |
| |
| :param method: http request method |
| :param url: http request url |
| :param query_params: query parameters in the url |
| :param headers: http request headers |
| :param body: request json body, for `application/json` |
| :param post_params: request post parameters, |
| `application/x-www-form-urlencoded` |
| and `multipart/form-data` |
| :param _preload_content: if False, the urllib3.HTTPResponse object will |
| be returned without reading/decoding response |
| data. Default is True. |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| """ |
| method = method.upper() |
| assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', |
| 'PATCH', 'OPTIONS'] |
| |
| if post_params and body: |
| raise ApiValueError( |
| "body parameter cannot be used with post_params parameter." |
| ) |
| |
| post_params = post_params or {} |
| headers = headers or {} |
| |
| timeout = None |
| if _request_timeout: |
| if isinstance(_request_timeout, (int, float)): # noqa: E501,F821 |
| timeout = urllib3.Timeout(total=_request_timeout) |
| elif (isinstance(_request_timeout, tuple) and |
| len(_request_timeout) == 2): |
| timeout = urllib3.Timeout( |
| connect=_request_timeout[0], read=_request_timeout[1]) |
| |
| if 'Content-Type' not in headers: |
| headers['Content-Type'] = 'application/json' |
| |
| try: |
| # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` |
| if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: |
| if query_params: |
| url += '?' + urlencode(query_params) |
| if re.search('json', headers['Content-Type'], re.IGNORECASE): |
| request_body = None |
| if body is not None: |
| request_body = json.dumps(body) |
| r = self.pool_manager.request( |
| method, url, |
| body=request_body, |
| preload_content=_preload_content, |
| timeout=timeout, |
| headers=headers) |
| elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 |
| r = self.pool_manager.request( |
| method, url, |
| fields=post_params, |
| encode_multipart=False, |
| preload_content=_preload_content, |
| timeout=timeout, |
| headers=headers) |
| elif headers['Content-Type'] == 'multipart/form-data': |
| # must del headers['Content-Type'], or the correct |
| # Content-Type which generated by urllib3 will be |
| # overwritten. |
| del headers['Content-Type'] |
| r = self.pool_manager.request( |
| method, url, |
| fields=post_params, |
| encode_multipart=True, |
| preload_content=_preload_content, |
| timeout=timeout, |
| headers=headers) |
| # Pass a `string` parameter directly in the body to support |
| # other content types than Json when `body` argument is |
| # provided in serialized form |
| elif isinstance(body, str) or isinstance(body, bytes): |
| request_body = body |
| r = self.pool_manager.request( |
| method, url, |
| body=request_body, |
| preload_content=_preload_content, |
| timeout=timeout, |
| headers=headers) |
| else: |
| # Cannot generate the request from given parameters |
| msg = """Cannot prepare a request message for provided |
| arguments. Please check that your arguments match |
| declared content type.""" |
| raise ApiException(status=0, reason=msg) |
| # For `GET`, `HEAD` |
| else: |
| r = self.pool_manager.request(method, url, |
| fields=query_params, |
| preload_content=_preload_content, |
| timeout=timeout, |
| headers=headers) |
| except urllib3.exceptions.SSLError as e: |
| msg = "{0}\n{1}".format(type(e).__name__, str(e)) |
| raise ApiException(status=0, reason=msg) |
| |
| if _preload_content: |
| r = RESTResponse(r) |
| |
| # log response body |
| logger.debug("response body: %s", r.data) |
| |
| if not 200 <= r.status <= 299: |
| if r.status == 401: |
| raise UnauthorizedException(http_resp=r) |
| |
| if r.status == 403: |
| raise ForbiddenException(http_resp=r) |
| |
| if r.status == 404: |
| raise NotFoundException(http_resp=r) |
| |
| if 500 <= r.status <= 599: |
| raise ServiceException(http_resp=r) |
| |
| raise ApiException(http_resp=r) |
| |
| return r |
| |
| def GET(self, url, headers=None, query_params=None, _preload_content=True, |
| _request_timeout=None): |
| return self.request("GET", url, |
| headers=headers, |
| _preload_content=_preload_content, |
| _request_timeout=_request_timeout, |
| query_params=query_params) |
| |
| def HEAD(self, url, headers=None, query_params=None, _preload_content=True, |
| _request_timeout=None): |
| return self.request("HEAD", url, |
| headers=headers, |
| _preload_content=_preload_content, |
| _request_timeout=_request_timeout, |
| query_params=query_params) |
| |
| def OPTIONS(self, url, headers=None, query_params=None, post_params=None, |
| body=None, _preload_content=True, _request_timeout=None): |
| return self.request("OPTIONS", url, |
| headers=headers, |
| query_params=query_params, |
| post_params=post_params, |
| _preload_content=_preload_content, |
| _request_timeout=_request_timeout, |
| body=body) |
| |
| def DELETE(self, url, headers=None, query_params=None, body=None, |
| _preload_content=True, _request_timeout=None): |
| return self.request("DELETE", url, |
| headers=headers, |
| query_params=query_params, |
| _preload_content=_preload_content, |
| _request_timeout=_request_timeout, |
| body=body) |
| |
| def POST(self, url, headers=None, query_params=None, post_params=None, |
| body=None, _preload_content=True, _request_timeout=None): |
| return self.request("POST", url, |
| headers=headers, |
| query_params=query_params, |
| post_params=post_params, |
| _preload_content=_preload_content, |
| _request_timeout=_request_timeout, |
| body=body) |
| |
| def PUT(self, url, headers=None, query_params=None, post_params=None, |
| body=None, _preload_content=True, _request_timeout=None): |
| return self.request("PUT", url, |
| headers=headers, |
| query_params=query_params, |
| post_params=post_params, |
| _preload_content=_preload_content, |
| _request_timeout=_request_timeout, |
| body=body) |
| |
| def PATCH(self, url, headers=None, query_params=None, post_params=None, |
| body=None, _preload_content=True, _request_timeout=None): |
| return self.request("PATCH", url, |
| headers=headers, |
| query_params=query_params, |
| post_params=post_params, |
| _preload_content=_preload_content, |
| _request_timeout=_request_timeout, |
| body=body) |
