docs: add password example to dataset import API (#18580)

apache · Feb 7, 2022 · 299635c · 299635c
1 parent 151d30b
commit 299635c
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 5 deletions.
diff --git a/superset/charts/api.py b/superset/charts/api.py
@@ -837,7 +837,12 @@ def import_(self) -> Response:
                       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
@@ -944,7 +944,12 @@ def import_(self) -> Response:
                       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
@@ -791,7 +791,12 @@ def import_(self) -> Response:
                       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
@@ -697,7 +697,12 @@ def import_(self) -> Response:
                       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
@@ -293,7 +293,12 @@ def import_(self) -> Response:
                       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?