diff --git a/superset/charts/api.py b/superset/charts/api.py index 6b45900ed..a4a301b71 100644 --- a/superset/charts/api.py +++ b/superset/charts/api.py @@ -837,7 +837,12 @@ class ChartRestApi(BaseSupersetModelRestApi): type: string format: binary passwords: - description: JSON map of passwords for each file + description: >- + JSON map of passwords for each featured database in the + ZIP file. If the ZIP includes a database config in the path + `databases/MyDatabase.yaml`, the password should be provided + in the following format: + `{"databases/MyDatabase.yaml": "my_password"}`. type: string overwrite: description: overwrite existing databases? diff --git a/superset/dashboards/api.py b/superset/dashboards/api.py index ea05ce9ca..d5c04809b 100644 --- a/superset/dashboards/api.py +++ b/superset/dashboards/api.py @@ -944,7 +944,12 @@ class DashboardRestApi(BaseSupersetModelRestApi): type: string format: binary passwords: - description: JSON map of passwords for each file + description: >- + JSON map of passwords for each featured database in the + ZIP file. If the ZIP includes a database config in the path + `databases/MyDatabase.yaml`, the password should be provided + in the following format: + `{"databases/MyDatabase.yaml": "my_password"}`. type: string overwrite: description: overwrite existing databases? diff --git a/superset/databases/api.py b/superset/databases/api.py index 79c4ff746..1b8b408c1 100644 --- a/superset/databases/api.py +++ b/superset/databases/api.py @@ -791,7 +791,12 @@ class DatabaseRestApi(BaseSupersetModelRestApi): type: string format: binary passwords: - description: JSON map of passwords for each file + description: >- + JSON map of passwords for each featured database in the + ZIP file. If the ZIP includes a database config in the path + `databases/MyDatabase.yaml`, the password should be provided + in the following format: + `{"databases/MyDatabase.yaml": "my_password"}`. type: string overwrite: description: overwrite existing databases? diff --git a/superset/datasets/api.py b/superset/datasets/api.py index ce8ce55cc..b94b9ca12 100644 --- a/superset/datasets/api.py +++ b/superset/datasets/api.py @@ -697,7 +697,12 @@ class DatasetRestApi(BaseSupersetModelRestApi): type: string format: binary passwords: - description: JSON map of passwords for each file + description: >- + JSON map of passwords for each featured database in the + ZIP file. If the ZIP includes a database config in the path + `databases/MyDatabase.yaml`, the password should be provided + in the following format: + `{"databases/MyDatabase.yaml": "my_password"}`. type: string overwrite: description: overwrite existing datasets? diff --git a/superset/queries/saved_queries/api.py b/superset/queries/saved_queries/api.py index a4d74cc5c..04df2345c 100644 --- a/superset/queries/saved_queries/api.py +++ b/superset/queries/saved_queries/api.py @@ -293,7 +293,12 @@ class SavedQueryRestApi(BaseSupersetModelRestApi): type: string format: binary passwords: - description: JSON map of passwords for each file + description: >- + JSON map of passwords for each featured database in the + ZIP file. If the ZIP includes a database config in the path + `databases/MyDatabase.yaml`, the password should be provided + in the following format: + `{"databases/MyDatabase.yaml": "my_password"}`. type: string overwrite: description: overwrite existing saved queries?