Skip to content

Commit

Permalink
docs: add password example to dataset import API (apache#18580)
Browse files Browse the repository at this point in the history
  • Loading branch information
villebro authored and shcoderAlex committed Feb 7, 2022
1 parent 60234cc commit c347659
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 5 deletions.
7 changes: 6 additions & 1 deletion superset/charts/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
7 changes: 6 additions & 1 deletion superset/dashboards/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
7 changes: 6 additions & 1 deletion superset/databases/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
7 changes: 6 additions & 1 deletion superset/datasets/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
7 changes: 6 additions & 1 deletion superset/queries/saved_queries/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down

0 comments on commit c347659

Please sign in to comment.