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

This commit is contained in:
Ville Brofeldt
2022-02-07 09:38:55 +02:00
committed by GitHub
parent 151d30bea4
commit 299635c580
5 changed files with 30 additions and 5 deletions

View File

@@ -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?

View File

@@ -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?

View File

@@ -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?

View File

@@ -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?

View File

@@ -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?