Migrate connection UI metadata to YAML for some providers

.pre-commit-config.yaml

@@ -576,6 +576,8 @@ repos:
           ^providers/\.pre-commit-config\.yaml$|
           ^providers/amazon/src/airflow/providers/amazon/aws/hooks/emr\.py$|
           ^providers/amazon/src/airflow/providers/amazon/aws/operators/emr\.py$|
+          ^providers/.*/get_provider_info\.py$|
+          ^providers/.*/provider\.yaml$|
           ^providers/apache/cassandra/src/airflow/providers/apache/cassandra/hooks/cassandra\.py$|
           ^providers/apache/hdfs/docs/connections\.rst$|
           ^providers/apache/hive/src/airflow/providers/apache/hive/operators/hive_stats\.py$|

providers/amazon/provider.yaml

@@ -925,14 +925,105 @@ extra-links:
 connection-types:
   - hook-class-name: airflow.providers.amazon.aws.hooks.base_aws.AwsGenericHook
     connection-type: aws
+    ui-field-behaviour:
+      hidden-fields:
+        - host
+        - schema
+        - port
+      relabeling:
+        login: AWS Access Key ID
+        password: AWS Secret Access Key
+      placeholders:
+        login: AKIAIOSFODNN7EXAMPLE
+        password: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+        extra: |
+          {
+            "region_name": "us-east-1",
+            "session_kwargs": {"profile_name": "default"},
+            "config_kwargs": {"retries": {"mode": "standard", "max_attempts": 10}},
+            "role_arn": "arn:aws:iam::123456789098:role/role-name",
+            "assume_role_method": "assume_role",
+            "assume_role_kwargs": {"RoleSessionName": "airflow"},
+            "aws_session_token": "AQoDYXdzEJr...EXAMPLETOKEN",
+            "endpoint_url": "http://localhost:4566"
+          }
   - hook-class-name: airflow.providers.amazon.aws.hooks.chime.ChimeWebhookHook
     connection-type: chime
+    ui-field-behaviour:
+      hidden-fields:
+        - login
+        - port
+        - extra
+      relabeling:
+        host: Chime Webhook Endpoint
+        password: Chime Webhook token
+      placeholders:
+        schema: https
+        host: hooks.chime.aws/incomingwebhook/
+        password: T00000000?token=XXXXXXXXXXXXXXXXXXXXXXXX
   - hook-class-name: airflow.providers.amazon.aws.hooks.emr.EmrHook
     connection-type: emr
+    ui-field-behaviour:
+      hidden-fields:
+        - host
+        - schema
+        - port
+        - login
+        - password
+      relabeling:
+        extra: Run Job Flow Configuration
+      placeholders:
+        extra: |
+          {
+            "Name": "MyClusterName",
+            "ReleaseLabel": "emr-5.36.0",
+            "Applications": [{"Name": "Spark"}],
+            "Instances": {
+              "InstanceGroups": [{
+                "Name": "Primary node",
+                "Market": "SPOT",
+                "InstanceRole": "MASTER",
+                "InstanceType": "m5.large",
+                "InstanceCount": 1
+              }],
+              "KeepJobFlowAliveWhenNoSteps": false,
+              "TerminationProtected": false
+            },
+            "StepConcurrencyLevel": 2
+          }
   - hook-class-name: airflow.providers.amazon.aws.hooks.redshift_sql.RedshiftSQLHook
     connection-type: redshift
+    ui-field-behaviour:
+      relabeling:
+        login: User
+        schema: Database
   - hook-class-name: airflow.providers.amazon.aws.hooks.athena_sql.AthenaSQLHook
     connection-type: athena
+    ui-field-behaviour:
+      hidden-fields:
+        - host
+        - port
+      relabeling:
+        login: AWS Access Key ID
+        password: AWS Secret Access Key
+      placeholders:
+        login: AKIAIOSFODNN7EXAMPLE
+        password: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+        extra: |
+          {
+            "aws_domain": "amazonaws.com",
+            "driver": "rest",
+            "s3_staging_dir": "s3://bucket_name/staging/",
+            "work_group": "primary",
+            "region_name": "us-east-1",
+            "session_kwargs": {"profile_name": "default"},
+            "config_kwargs": {"retries": {"mode": "standard", "max_attempts": 10}},
+            "role_arn": "arn:aws:iam::123456789098:role/role-name",
+            "assume_role_method": "assume_role",
+            "assume_role_kwargs": {"RoleSessionName": "airflow"},
+            "aws_session_token": "AQoDYXdzEJr...EXAMPLETOKEN",
+            "endpoint_url": "http://localhost:4566"
+          }
 
 notifications:
   - airflow.providers.amazon.aws.notifications.chime.ChimeNotifier

providers/amazon/src/airflow/providers/amazon/get_provider_info.py

@@ -1080,19 +1080,57 @@ def get_provider_info():
             {
                 "hook-class-name": "airflow.providers.amazon.aws.hooks.base_aws.AwsGenericHook",
                 "connection-type": "aws",
+                "ui-field-behaviour": {
+                    "hidden-fields": ["host", "schema", "port"],
+                    "relabeling": {"login": "AWS Access Key ID", "password": "AWS Secret Access Key"},
+                    "placeholders": {
+                        "login": "AKIAIOSFODNN7EXAMPLE",
+                        "password": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+                        "extra": '{\n  "region_name": "us-east-1",\n  "session_kwargs": {"profile_name": "default"},\n  "config_kwargs": {"retries": {"mode": "standard", "max_attempts": 10}},\n  "role_arn": "arn:aws:iam::123456789098:role/role-name",\n  "assume_role_method": "assume_role",\n  "assume_role_kwargs": {"RoleSessionName": "airflow"},\n  "aws_session_token": "AQoDYXdzEJr...EXAMPLETOKEN",\n  "endpoint_url": "http://localhost:4566"\n}\n',
+                    },
+                },
             },
             {
                 "hook-class-name": "airflow.providers.amazon.aws.hooks.chime.ChimeWebhookHook",
                 "connection-type": "chime",
+                "ui-field-behaviour": {
+                    "hidden-fields": ["login", "port", "extra"],
+                    "relabeling": {"host": "Chime Webhook Endpoint", "password": "Chime Webhook token"},
+                    "placeholders": {
+                        "schema": "https",
+                        "host": "hooks.chime.aws/incomingwebhook/",
+                        "password": "T00000000?token=XXXXXXXXXXXXXXXXXXXXXXXX",
+                    },
+                },
+            },
+            {
+                "hook-class-name": "airflow.providers.amazon.aws.hooks.emr.EmrHook",
+                "connection-type": "emr",
+                "ui-field-behaviour": {
+                    "hidden-fields": ["host", "schema", "port", "login", "password"],
+                    "relabeling": {"extra": "Run Job Flow Configuration"},
+                    "placeholders": {
+                        "extra": '{\n  "Name": "MyClusterName",\n  "ReleaseLabel": "emr-5.36.0",\n  "Applications": [{"Name": "Spark"}],\n  "Instances": {\n    "InstanceGroups": [{\n      "Name": "Primary node",\n      "Market": "SPOT",\n      "InstanceRole": "MASTER",\n      "InstanceType": "m5.large",\n      "InstanceCount": 1\n    }],\n    "KeepJobFlowAliveWhenNoSteps": false,\n    "TerminationProtected": false\n  },\n  "StepConcurrencyLevel": 2\n}\n'
+                    },
+                },
             },
-            {"hook-class-name": "airflow.providers.amazon.aws.hooks.emr.EmrHook", "connection-type": "emr"},
             {
                 "hook-class-name": "airflow.providers.amazon.aws.hooks.redshift_sql.RedshiftSQLHook",
                 "connection-type": "redshift",
+                "ui-field-behaviour": {"relabeling": {"login": "User", "schema": "Database"}},
             },
             {
                 "hook-class-name": "airflow.providers.amazon.aws.hooks.athena_sql.AthenaSQLHook",
                 "connection-type": "athena",
+                "ui-field-behaviour": {
+                    "hidden-fields": ["host", "port"],
+                    "relabeling": {"login": "AWS Access Key ID", "password": "AWS Secret Access Key"},
+                    "placeholders": {
+                        "login": "AKIAIOSFODNN7EXAMPLE",
+                        "password": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+                        "extra": '{\n  "aws_domain": "amazonaws.com",\n  "driver": "rest",\n  "s3_staging_dir": "s3://bucket_name/staging/",\n  "work_group": "primary",\n  "region_name": "us-east-1",\n  "session_kwargs": {"profile_name": "default"},\n  "config_kwargs": {"retries": {"mode": "standard", "max_attempts": 10}},\n  "role_arn": "arn:aws:iam::123456789098:role/role-name",\n  "assume_role_method": "assume_role",\n  "assume_role_kwargs": {"RoleSessionName": "airflow"},\n  "aws_session_token": "AQoDYXdzEJr...EXAMPLETOKEN",\n  "endpoint_url": "http://localhost:4566"\n}\n',
+                    },
+                },
             },
         ],
         "notifications": [

providers/google/provider.yaml

@@ -1197,12 +1197,25 @@ connection-types:
     connection-type: gcpcloudsqldb
   - hook-class-name: airflow.providers.google.cloud.hooks.bigquery.BigQueryHook
     connection-type: gcpbigquery
+    ui-field-behaviour:
+      hidden-fields: ["host", "schema", "login", "password", "port", "extra"]
+      relabeling: {}
+      placeholders: {}
   - hook-class-name: airflow.providers.google.cloud.hooks.compute_ssh.ComputeEngineSSHHook
     connection-type: gcpssh
+    ui-field-behaviour:
+      hidden-fields: ["host", "schema", "login", "password", "port", "extra"]
+      relabeling: {}
+      placeholders: {}
   - hook-class-name: airflow.providers.google.leveldb.hooks.leveldb.LevelDBHook
     connection-type: leveldb
   - hook-class-name: airflow.providers.google.ads.hooks.ads.GoogleAdsHook
     connection-type: google_ads
+    ui-field-behaviour:
+      hidden-fields: ["host", "login", "schema", "port"]
+      relabeling: {}
+      placeholders:
+        password: "Leave blank (optional)"
   - hook-class-name: airflow.providers.google.cloud.hooks.looker.LookerHook
     connection-type: gcp_looker
 

providers/google/src/airflow/providers/google/get_provider_info.py

@@ -1434,10 +1434,20 @@ def get_provider_info():
             {
                 "hook-class-name": "airflow.providers.google.cloud.hooks.bigquery.BigQueryHook",
                 "connection-type": "gcpbigquery",
+                "ui-field-behaviour": {
+                    "hidden-fields": ["host", "schema", "login", "password", "port", "extra"],
+                    "relabeling": {},
+                    "placeholders": {},
+                },
             },
             {
                 "hook-class-name": "airflow.providers.google.cloud.hooks.compute_ssh.ComputeEngineSSHHook",
                 "connection-type": "gcpssh",
+                "ui-field-behaviour": {
+                    "hidden-fields": ["host", "schema", "login", "password", "port", "extra"],
+                    "relabeling": {},
+                    "placeholders": {},
+                },
             },
             {
                 "hook-class-name": "airflow.providers.google.leveldb.hooks.leveldb.LevelDBHook",
@@ -1446,6 +1456,11 @@ def get_provider_info():
             {
                 "hook-class-name": "airflow.providers.google.ads.hooks.ads.GoogleAdsHook",
                 "connection-type": "google_ads",
+                "ui-field-behaviour": {
+                    "hidden-fields": ["host", "login", "schema", "port"],
+                    "relabeling": {},
+                    "placeholders": {"password": "Leave blank (optional)"},
+                },
             },
             {
                 "hook-class-name": "airflow.providers.google.cloud.hooks.looker.LookerHook",

providers/hashicorp/provider.yaml

@@ -86,6 +86,8 @@ hooks:
 connection-types:
   - hook-class-name: airflow.providers.hashicorp.hooks.vault.VaultHook
     connection-type: vault
+    ui-field-behaviour:
+      hidden-fields: ["extra"]
 
 secrets-backends:
   - airflow.providers.hashicorp.secrets.vault.VaultBackend

providers/hashicorp/src/airflow/providers/hashicorp/get_provider_info.py

@@ -44,6 +44,7 @@ def get_provider_info():
             {
                 "hook-class-name": "airflow.providers.hashicorp.hooks.vault.VaultHook",
                 "connection-type": "vault",
+                "ui-field-behaviour": {"hidden-fields": ["extra"]},
             }
         ],
         "secrets-backends": ["airflow.providers.hashicorp.secrets.vault.VaultBackend"],