mirror of
https://github.com/apache/superset.git
synced 2026-04-13 05:07:53 +00:00
75 lines
2.7 KiB
Python
75 lines
2.7 KiB
Python
# 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.
|
|
import logging
|
|
|
|
from flask import current_app as app, Response
|
|
from flask_appbuilder.api import expose, protect, safe
|
|
|
|
from superset.available_domains.schemas import AvailableDomainsSchema
|
|
from superset.constants import MODEL_API_RW_METHOD_PERMISSION_MAP
|
|
from superset.extensions import event_logger
|
|
from superset.views.base_api import BaseSupersetApi, statsd_metrics
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class AvailableDomainsRestApi(BaseSupersetApi):
|
|
available_domains_schema = AvailableDomainsSchema()
|
|
|
|
method_permission_name = MODEL_API_RW_METHOD_PERMISSION_MAP
|
|
allow_browser_login = True
|
|
class_permission_name = "AvailableDomains"
|
|
resource_name = "available_domains"
|
|
openapi_spec_tag = "Available Domains"
|
|
openapi_spec_component_schemas = (AvailableDomainsSchema,)
|
|
|
|
@expose("/", methods=("GET",))
|
|
@protect()
|
|
@safe
|
|
@statsd_metrics
|
|
@event_logger.log_this_with_context(
|
|
action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.get",
|
|
log_to_statsd=True,
|
|
)
|
|
def get(self) -> Response:
|
|
"""
|
|
Get 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:
|
|
summary: Get all available domains
|
|
responses:
|
|
200:
|
|
description: a list of available domains
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
result:
|
|
$ref: '#/components/schemas/AvailableDomainsSchema'
|
|
401:
|
|
$ref: '#/components/responses/401'
|
|
403:
|
|
$ref: '#/components/responses/403'
|
|
"""
|
|
result = self.available_domains_schema.dump(
|
|
{"domains": app.config.get("SUPERSET_WEBSERVER_DOMAINS")}
|
|
)
|
|
return self.response(200, result=result)
|