Add description to API schema

apache · Mar 4, 2021 · 9a7c3dc · 9a7c3dc
1 parent 0b1b0c9
commit 9a7c3dc
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/superset/charts/api.py b/superset/charts/api.py
@@ -993,11 +993,14 @@ def import_(self) -> Response:
                   type: object
                   properties:
                     formData:
+                      description: upload file (ZIP)
                       type: string
                       format: binary
                     passwords:
+                      description: JSON map of passwords for each file
                       type: string
                     overwrite:
+                      description: overwrite existing databases?
                       type: bool
           responses:
             200:

diff --git a/superset/dashboards/api.py b/superset/dashboards/api.py
@@ -759,11 +759,14 @@ def import_(self) -> Response:
                   type: object
                   properties:
                     formData:
+                      description: upload file (ZIP or JSON)
                       type: string
                       format: binary
                     passwords:
+                      description: JSON map of passwords for each file
                       type: string
                     overwrite:
+                      description: overwrite existing databases?
                       type: bool
           responses:
             200:

diff --git a/superset/databases/api.py b/superset/databases/api.py
@@ -751,11 +751,14 @@ def import_(self) -> Response:
                   type: object
                   properties:
                     formData:
+                      description: upload file (ZIP)
                       type: string
                       format: binary
                     passwords:
+                      description: JSON map of passwords for each file
                       type: string
                     overwrite:
+                      description: overwrite existing databases?
                       type: bool
           responses:
             200:

diff --git a/superset/datasets/api.py b/superset/datasets/api.py
@@ -659,11 +659,14 @@ def import_(self) -> Response:
                   type: object
                   properties:
                     formData:
+                      description: upload file (ZIP or YAML)
                       type: string
                       format: binary
                     passwords:
+                      description: JSON map of passwords for each file
                       type: string
                     overwrite:
+                      description: overwrite existing databases?
                       type: bool
           responses:
             200: