This is an automated email from the ASF dual-hosted git repository.
uranusjr pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 4610df1ecf Reformat Apprise and Amazon Chime connections docs (#33971)
4610df1ecf is described below
commit 4610df1ecf9f2a91621b0df80767b2ce2164113e
Author: Andrey Anshin <[email protected]>
AuthorDate: Fri Sep 1 08:03:36 2023 +0400
Reformat Apprise and Amazon Chime connections docs (#33971)
Co-authored-by: Niko Oliveira <[email protected]>
---
.../connections/chime.rst | 33 ++++++++++--------
.../connections.rst | 40 +++++++++++++++++-----
2 files changed, 49 insertions(+), 24 deletions(-)
diff --git a/docs/apache-airflow-providers-amazon/connections/chime.rst
b/docs/apache-airflow-providers-amazon/connections/chime.rst
index 94a356f81d..01c715e6d0 100644
--- a/docs/apache-airflow-providers-amazon/connections/chime.rst
+++ b/docs/apache-airflow-providers-amazon/connections/chime.rst
@@ -20,7 +20,9 @@
Amazon Chime Connection
==========================
-The Chime connection works with calling Chime webhooks to send messages to a
chime room.
+`Amazon Chime <https://aws.amazon.com/chime/>`__ connection works with
+`Chime Incoming Webhooks
<https://docs.aws.amazon.com/chime/latest/ag/webhooks.html>`__ to send messages
to a
+`Chime Chat Room
<https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html>`__.
Authenticating to Amazon Chime
---------------------------------
@@ -34,27 +36,28 @@ The default connection ID is ``chime_default``.
Configuring the Connection
--------------------------
-Chime Webhook Endpoint:
+Chime Webhook Endpoint
Specify the entire url or the base of the url for the service.
-
-Chime Webhook token:
+Chime Webhook token
The token for authentication including the webhook ID.
-Schema:
+Schema
Whether or not the endpoint should be http or https
Examples
--------
-**Connection**
-
-* **Chime Webhook Endpoint**: hooks.chime.aws
-* **Chime Webhook Token**:
-
-.. code-block:: text
-
- abceasd-3423-a1237-ffff-000cccccccc?token=somechimetoken
-
-* **Schema**: https
+.. list-table:: Amazon Chime Connection Sample
+ :widths: 25 25
+ :header-rows: 1
+
+ * - Parameter
+ - Input
+ * - **Chime Webhook Endpoint**
+ - ``hooks.chime.aws``
+ * - **Chime Webhook Token**
+ - ``abceasd-3423-a1237-ffff-000cccccccc?token=somechimetoken``
+ * - **Schema**
+ - ``https``
diff --git a/docs/apache-airflow-providers-apprise/connections.rst
b/docs/apache-airflow-providers-apprise/connections.rst
index 8a1f8f4c07..2799c09ec5 100644
--- a/docs/apache-airflow-providers-apprise/connections.rst
+++ b/docs/apache-airflow-providers-apprise/connections.rst
@@ -20,7 +20,8 @@
Apprise Connection
=======================
-The Apprise connection type enables connection to multiple services to send
notifications. The complete list of services supported can be found on the
`Apprise Wiki <https://github.com/caronc/apprise/wiki#notification-services>`_.
+The `Apprise <https://github.com/caronc/apprise>`__ connection type enables
connection to multiple services to send notifications.
+The complete list of services supported can be found on the `Apprise Wiki
<https://github.com/caronc/apprise/wiki#notification-services>`_.
Default Connection IDs
----------------------
@@ -29,15 +30,36 @@ Apprise hooks point to ``apprise_default`` by default.
Configuring the Connection
--------------------------
-config (required)
- The service(s) to send notifications can be specified here. The format to
specify single or multiple services is as follows::
- .. code-block:: python
+Config (required)
+ The service(s) to send notifications can be specified here.
+ The format to specify a single service or multiple services is as follows:
- # Single service
- {"path": "URI for the service", "tag": "tag name"}
+ *Single service*
- # Multiple services
- [{"path": "URI for the service 1", "tag": "tag name"}, {"path": "URI
for the service 2", "tag": "tag name"}]
+ .. code-block:: json
- Read more about `path
<https://github.com/caronc/apprise/wiki/URLBasics#apprise-url-basics>`_ and
`tag <https://github.com/caronc/apprise/wiki/Development_API#tagging>`_
+ {
+ "path": "URI for the service",
+ "tag": "tag name"
+ }
+
+
+ *Multiple services*
+
+ .. code-block:: json
+
+ [
+ {
+ "path": "URI for the service 1",
+ "tag": "tag name"
+ },
+ {
+ "path": "URI for the service 2",
+ "tag": "tag name"
+ },
+ ]
+
+ .. seealso::
+ - `Apprise URL Basics
<https://github.com/caronc/apprise/wiki/URLBasics#apprise-url-basics>`_
+ - `Tagging
<https://github.com/caronc/apprise/wiki/Development_API#tagging>`_
