-
Notifications
You must be signed in to change notification settings - Fork 14.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for the HTTP connection (#15379)
Add documentation for the http connection so it is more clear to a new user how to set them up. This PR also links the new documentation to operators, hooks, and sensors that use a http connection.
- Loading branch information
Showing
5 changed files
with
76 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
.. 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. | ||
.. _howto/connection:http: | ||
|
||
HTTP Connection | ||
=============== | ||
|
||
The HTTP connection enables connections to HTTP services. | ||
|
||
Authenticating with HTTP | ||
------------------------ | ||
|
||
Login and Password authentication can be used along with any authentication method using headers. | ||
Headers can be given in json format in the Extras field. | ||
|
||
Default Connection IDs | ||
---------------------- | ||
|
||
The HTTP operators and hooks use ``http_default`` by default. | ||
|
||
Configuring the Connection | ||
-------------------------- | ||
|
||
Login (optional) | ||
Specify the login for the http service you would like to connect too. | ||
|
||
Password (optional) | ||
Specify the password for the http service you would like to connect too. | ||
|
||
Host (optional) | ||
Specify the entire url or the base of the url for the service. | ||
|
||
Port (optional) | ||
Specify a port number if applicable. | ||
|
||
Schema (optional) | ||
Specify the service type etc: http/https. | ||
|
||
Extras (optional) | ||
Specify headers in json format. | ||
|
||
When specifying the connection in environment variable you should specify | ||
it using URI syntax. | ||
|
||
Note that all components of the URI should be URL-encoded. | ||
|
||
For example: | ||
|
||
.. code-block:: bash | ||
export AIRFLOW_CONN_HTTP_DEFAULT='http://username:password@servvice.com:80/https?headers=header' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters