You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by po...@apache.org on 2025/07/15 08:14:18 UTC

(airflow) branch main updated: Docs: sort exposable fields in create-custom-providers (#53362)

This is an automated email from the ASF dual-hosted git repository.

potiuk 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 11b53f40bac Docs: sort exposable fields in create-custom-providers (#53362)
11b53f40bac is described below

commit 11b53f40bac4a1063c2e4445079576665e203164
Author: Dev-iL <Gi...@gmail.com>
AuthorDate: Tue Jul 15 11:14:11 2025 +0300

    Docs: sort exposable fields in create-custom-providers (#53362)
    
    * Docs: sort exposable fields in create-custom-providers
    
    * Update providers-summary-docs/howto/create-custom-providers.rst
    
    Co-authored-by: Copilot <17...@users.noreply.github.com>
    
    ---------
    
    Co-authored-by: Copilot <17...@users.noreply.github.com>
---
 .../howto/create-custom-providers.rst              | 90 ++++++++++------------
 1 file changed, 39 insertions(+), 51 deletions(-)

diff --git a/providers-summary-docs/howto/create-custom-providers.rst b/providers-summary-docs/howto/create-custom-providers.rst
index e33d8d462f0..3a95adcbdf4 100644
--- a/providers-summary-docs/howto/create-custom-providers.rst
+++ b/providers-summary-docs/howto/create-custom-providers.rst
@@ -61,83 +61,74 @@ Displaying package information in CLI/API:
 
 Exposing customized functionality to the Airflow's core:
 
-* ``extra-links`` - this field should contain the list of all the operator class names that are adding extra links
-  capability. See :doc:`apache-airflow:howto/define-extra-link` for description of how to add extra link
-  capability to the operators of yours.
+* ``auth-backends`` - this field should contain the list of all the auth backend class names that the
+  provider provides. See :doc:`apache-airflow:core-concepts/auth-manager/index` for description of authentication.
+
+* ``auth-managers`` - this field should contain the list of all the auth manager class names that the
+  provider provides. See :doc:`apache-airflow:core-concepts/auth-manager/index` for description of the auth managers.
+
+* ``bundles`` - this field should contain the list of all the bundle class names that the
+  provider provides.
+
+* ``config`` - this field should contain dictionary that should conform to the
+  ``airflow/config_templates/config.yml.schema.json`` with configuration contributed by the providers
+  See :doc:`apache-airflow:howto/set-config` for details about setting configuration.
 
 * ``connection-types`` - this field should contain the list of all the connection types together with hook
   class names implementing those custom connection types (providing custom extra fields and
   custom field behaviour). This field is available as of Airflow 2.2.0 and it replaces deprecated
   ``hook-class-names``. See :doc:`apache-airflow:howto/connection` for more details.
 
-* ``secret-backends`` - this field should contain the list of all the secret backends class names that the
-  provider provides. See :doc:`apache-airflow:security/secrets/secrets-backend/index` for description of how
-  to add.
-
-* ``task-decorators`` - this field should contain the list of dictionaries of name/path where the decorators
-  are available. See :doc:`apache-airflow:howto/create-custom-decorator` for description of how to add
-  custom decorators.
-
-* ``logging`` - this field should contain the list of all the logging handler class names that the
-  provider provides. See :doc:`apache-airflow:administration-and-deployment/logging-monitoring/logging-tasks`
-  for description of the logging handlers.
-
-* ``notifications`` - this field should contain the notification classes.
-  See :doc:`apache-airflow:howto/notifications` for description of the notifications.
-
 * ``executors`` - this field should contain the executor class names.
   See :doc:`apache-airflow:core-concepts/executor/index` for description of the executors.
 
-* ``config`` - this field should contain dictionary that should conform to the
-  ``airflow/config_templates/config.yml.schema.json`` with configuration contributed by the providers
-  See :doc:`apache-airflow:howto/set-config` for details about setting configuration.
-
-.. TODO (potiuk): derive those descriptions directly from the schema definition
+* ``extra-links`` - this field should contain the list of all the operator class names that are adding extra links
+  capability. See :doc:`apache-airflow:howto/define-extra-link` for description of how to add extra link
+  capability to the operators of yours.
 
 * ``filesystems`` - this field should contain the list of all the filesystem module names.
   See :doc:`apache-airflow:core-concepts/objectstorage` for description of the filesystems.
 
+* ``hooks`` - this field should contain the list of all the hook class names that the provider provides.
+  See :doc:`apache-airflow:howto/connection` for description of the hooks and connections they provide.
+
 * ``integrations`` - provides list of integrations that are available in the provider.
 
-* ``transfers`` - this field should contain the list of all the transfer operator class names that the
-  provider provides. See :doc:`apache-airflow:core-concepts/operators` for description of the operators (transfers being one of the operator types).
+* ``logging`` - this field should contain the list of all the logging handler class names that the
+  provider provides. See :doc:`apache-airflow:administration-and-deployment/logging-monitoring/logging-tasks`
+  for description of the logging handlers.
+
+* ``notifications`` - this field should contain the list of all the notification classes that the
+  provider provides. See :doc:`apache-airflow:howto/notifications` for description of the notifications.
 
 * ``operators`` - this field should contain the list of all the operator class names that the
   provider provides. See :doc:`apache-airflow:core-concepts/operators` for description of the operators.
 
-* ``hooks`` - this field should contain the list of all the hook class names that the provider provides.
-  See :doc:`apache-airflow:howto/connection` for description of the hooks and connections they provide.
+* ``secret-backends`` - this field should contain the list of all the secret backends class names that the
+  provider provides. See :doc:`apache-airflow:security/secrets/secrets-backend/index` for description of how
+  to add.
 
 * ``sensors`` - this field should contain the list of all the sensor class names that the
   provider provides. See :doc:`apache-airflow:core-concepts/sensors` for description of the sensors.
 
-* ``bundles`` - this field should contain the list of all the bundle class names that the
-  provider provides.
+* ``task-decorators`` - this field should contain the list of dictionaries of name/path where the decorators
+  are available. See :doc:`apache-airflow:howto/create-custom-decorator` for description of how to add
+  custom decorators.
+
+* ``transfers`` - this field should contain the list of all the transfer operator class names that the
+  provider provides. See :doc:`apache-airflow:core-concepts/operators` for description of the operators (transfers being one of the operator types).
 
 * ``triggers`` - this field should contain the list of all the trigger class names that the
   provider provides. See :doc:`apache-airflow:authoring-and-scheduling/deferring` for description of the triggers.
 
-* ``auth-backends`` - this field should contain the list of all the auth backend class names that the
-  provider provides. See :doc:`apache-airflow:core-concepts/auth-manager/index` for description of authentication.
-
-* ``auth-managers`` - this field should contain the list of all the auth manager class names that the
-  provider provides. See :doc:`apache-airflow:core-concepts/auth-manager/index` for description of the auth managers.
-
-* ``notifications`` - this field should contain the list of all the notification class names that the
-  provider provides. See :doc:`apache-airflow:howto/notifications` for description of the notifications.
-
-* ``task-decorators`` - this field should contain the list of all the task decorator class names that the
-  provider provides. See :doc:`apache-airflow:howto/create-custom-decorator` for description of the task
-  decorators.
-
-* ``config`` - this field should contain the list of all the custom configuration options that the provider
-  provides.
+.. note:: Deprecated values
 
-* ``asset-uris`` (deprecated) - this field should contain the list of the URI schemes together with
-  class names implementing normalization functions.
-  See :doc:`apache-airflow:authoring-and-scheduling/assets` for description of the dataset URIs.
+  * ``asset-uris`` (deprecated) - this field should contain the list of the URI schemes together with
+    class names implementing normalization functions.
+    See :doc:`apache-airflow:authoring-and-scheduling/assets` for description of the dataset URIs.
 
-.. note:: Deprecated values
+  * ``dataset-uris`` (deprecated) - this field should contain the list of the URI schemes together with
+    class names implementing normalization functions. Deprecated in Airflow 3.0 in favor of ``asset-uris``.
 
   * ``hook-class-names`` (deprecated) - this field should contain the list of all hook class names that provide
     custom connection types with custom extra fields and field behaviour. The ``hook-class-names`` array
@@ -146,9 +137,6 @@ Exposing customized functionality to the Airflow's core:
     you want to also target earlier versions of Airflow 2, you should include both ``hook-class-names`` and
     ``connection-types`` arrays. See :doc:`apache-airflow:howto/connection` for more details.
 
-  * ``dataset-uris`` (deprecated) - this field should contain the list of the URI schemes together with
-    class names implementing normalization functions. Deprecated in Airflow 3.0 in favor of ``asset-uris``.
-
 When your providers are installed you can query the installed providers and their capabilities with the
 ``airflow providers`` command. This way you can verify if your providers are properly recognized and whether
 they define the extensions properly. See :doc:`apache-airflow:cli-and-env-variables-ref` for details of available CLI