fixed openapi spec

superset/available_domains/api.py

@@ -20,20 +20,23 @@
 from flask_appbuilder.api import BaseApi, expose, protect, safe
 
 from superset import conf
+from superset.available_domains.schemas import AvailableDomainsSchema
 from superset.constants import MODEL_API_RW_METHOD_PERMISSION_MAP, RouteMethod
 from superset.extensions import event_logger
 
 logger = logging.getLogger(__name__)
 
 
 class AvailableDomainsRestApi(BaseApi):
+    available_domains_schema = AvailableDomainsSchema()
+
     method_permission_name = MODEL_API_RW_METHOD_PERMISSION_MAP
     include_route_methods = {RouteMethod.GET}
     allow_browser_login = True
     class_permission_name = "AvailableDomains"
     resource_name = "available_domains"
     openapi_spec_tag = "Available Domains"
-    openapi_spec_component_schemas = ()
+    openapi_spec_component_schemas = (AvailableDomainsSchema,)
 
     @expose("/", methods=["GET"])
     @protect()
@@ -47,5 +50,30 @@ def get(self) -> Response:
         Returns the list of available Superset Webserver domains (if any)
         defined in config. This enables charts embedded in other apps to
         leverage domain sharding if appropriately configured.
+        ---
+        get:
+          description: >-
+            Get all available domains
+          responses:
+            200:
+              description: a list of available domains
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      result:
+                        $ref: '#/components/schemas/AvailableDomainsSchema'
+            400:
+              $ref: '#/components/responses/400'
+            401:
+              $ref: '#/components/responses/401'
+            403:
+              $ref: '#/components/responses/403'
+            404:
+              $ref: '#/components/responses/404'
         """
-        return self.response(200, result=conf.get("SUPERSET_WEBSERVER_DOMAINS"))
+        result = self.available_domains_schema.dump(
+            {"domains": conf.get("SUPERSET_WEBSERVER_DOMAINS")}
+        )
+        return self.response(200, result=result)

superset/available_domains/schemas.py

@@ -0,0 +1,21 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+#  License ); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+#  AS IS  BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+from marshmallow import fields, Schema
+
+
+class AvailableDomainsSchema(Schema):
+    domains = fields.List(fields.String())

tests/integration_tests/available_domains/__init__.py

@@ -0,0 +1,16 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

tests/integration_tests/available_domains/api_tests.py

@@ -20,9 +20,11 @@
 
 
 def test_get_available_domains(test_client, login_as_admin):
+    cached = app.config["SUPERSET_WEBSERVER_DOMAINS"]
     app.config["SUPERSET_WEBSERVER_DOMAINS"] = ["a", "b"]
     resp = test_client.get("api/v1/available_domains/")
     assert resp.status_code == 200
     data = json.loads(resp.data.decode("utf-8"))
     result = data.get("result")
-    assert result == ["a", "b"]
+    assert result == {"domains": ["a", "b"]}
+    app.config["SUPERSET_WEBSERVER_DOMAINS"] = cached