mirror of
https://github.com/apache/superset.git
synced 2026-08-04 13:02:41 +00:00
278 lines
11 KiB
JSON
278 lines
11 KiB
JSON
{
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"active_tab": {
|
|
"properties": {
|
|
"active": { "type": "boolean" },
|
|
"autorun": { "type": "boolean" },
|
|
"database_id": { "type": "integer" },
|
|
"extra_json": { "type": "object" },
|
|
"hide_left_bar": { "type": "boolean" },
|
|
"id": { "type": "string" },
|
|
"label": { "type": "string" },
|
|
"latest_query": {
|
|
"properties": {
|
|
"changed_on": { "format": "date-time", "type": "string" },
|
|
"ctas": { "type": "boolean" },
|
|
"db": { "type": "string" },
|
|
"dbId": { "type": "integer" },
|
|
"endDttm": { "type": "number" },
|
|
"errorMessage": { "nullable": true, "type": "string" },
|
|
"executedSql": { "type": "string" },
|
|
"extra": { "type": "object" },
|
|
"id": { "type": "string" },
|
|
"limit": { "type": "integer" },
|
|
"limitingFactor": { "type": "string" },
|
|
"progress": { "type": "integer" },
|
|
"queryId": { "type": "integer" },
|
|
"resultsKey": { "type": "string" },
|
|
"rows": { "type": "integer" },
|
|
"schema": { "type": "string" },
|
|
"serverId": { "type": "integer" },
|
|
"sql": { "type": "string" },
|
|
"sqlEditorId": { "type": "string" },
|
|
"startDttm": { "type": "number" },
|
|
"state": { "type": "string" },
|
|
"tab": { "type": "string" },
|
|
"tempSchema": { "nullable": true, "type": "string" },
|
|
"tempTable": { "nullable": true, "type": "string" },
|
|
"trackingUrl": { "nullable": true, "type": "string" },
|
|
"user": { "type": "string" },
|
|
"userId": { "type": "integer" }
|
|
},
|
|
"type": "object",
|
|
"title": "QueryResult"
|
|
},
|
|
"query_limit": { "type": "integer" },
|
|
"saved_query": { "nullable": true, "type": "object" },
|
|
"schema": { "type": "string" },
|
|
"sql": { "type": "string" },
|
|
"table_schemas": {
|
|
"items": {
|
|
"properties": {
|
|
"database_id": { "type": "integer" },
|
|
"description": { "type": "string" },
|
|
"expanded": { "type": "boolean" },
|
|
"id": { "type": "integer" },
|
|
"schema": { "type": "string" },
|
|
"tab_state_id": { "type": "integer" },
|
|
"table": { "type": "string" }
|
|
},
|
|
"type": "object",
|
|
"title": "Table"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"user_id": { "type": "integer" }
|
|
},
|
|
"type": "object",
|
|
"title": "TabState"
|
|
},
|
|
"databases": {
|
|
"additionalProperties": {
|
|
"properties": {
|
|
"allow_csv_upload": { "type": "boolean" },
|
|
"allow_ctas": { "type": "boolean" },
|
|
"allow_cvas": { "type": "boolean" },
|
|
"allow_dml": { "type": "boolean" },
|
|
"allow_run_async": { "type": "boolean" },
|
|
"cache_timeout": { "nullable": true, "type": "integer" },
|
|
"configuration_method": {
|
|
"default": "sqlalchemy_form",
|
|
"enum": ["sqlalchemy_form", "dynamic_form", null],
|
|
"nullable": true
|
|
},
|
|
"database_name": { "type": "string" },
|
|
"encrypted_extra": { "nullable": true, "type": "string" },
|
|
"expose_in_sqllab": { "type": "boolean" },
|
|
"external_url": { "nullable": true, "type": "string" },
|
|
"extra": {
|
|
"properties": {
|
|
"allow_multi_catalog": { "type": "boolean" },
|
|
"allows_virtual_table_explore": { "type": "boolean" },
|
|
"cancel_query_on_windows_unload": { "type": "boolean" },
|
|
"cost_estimate_enabled": { "type": "boolean" },
|
|
"disable_data_preview": { "type": "boolean" },
|
|
"disable_drill_to_detail": { "type": "boolean" },
|
|
"engine_params": {
|
|
"additionalProperties": {},
|
|
"type": "object"
|
|
},
|
|
"metadata_cache_timeout": {
|
|
"additionalProperties": { "type": "integer" },
|
|
"type": "object"
|
|
},
|
|
"metadata_params": {
|
|
"additionalProperties": {},
|
|
"type": "object"
|
|
},
|
|
"per_user_caching": { "type": "boolean" },
|
|
"schema_options": {
|
|
"additionalProperties": {},
|
|
"type": "object"
|
|
},
|
|
"schemas_allowed_for_csv_upload": {
|
|
"items": { "type": "string" },
|
|
"type": "array"
|
|
},
|
|
"version": { "nullable": true, "type": "string" }
|
|
},
|
|
"type": "object",
|
|
"title": "ImportV1DatabaseExtra"
|
|
},
|
|
"impersonate_user": { "type": "boolean" },
|
|
"is_managed_externally": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"password": { "nullable": true, "type": "string" },
|
|
"sqlalchemy_uri": { "type": "string" },
|
|
"ssh_tunnel": {
|
|
"allOf": [
|
|
{
|
|
"properties": {
|
|
"id": {
|
|
"description": "SSH Tunnel ID (for updates)",
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"password": { "type": "string" },
|
|
"private_key": { "type": "string" },
|
|
"private_key_password": { "type": "string" },
|
|
"server_address": { "type": "string" },
|
|
"server_port": { "type": "integer" },
|
|
"username": { "type": "string" }
|
|
},
|
|
"type": "object",
|
|
"title": "DatabaseSSHTunnel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"uuid": { "format": "uuid", "type": "string" },
|
|
"version": { "type": "string" }
|
|
},
|
|
"required": [
|
|
"database_name",
|
|
"sqlalchemy_uri",
|
|
"uuid",
|
|
"version"
|
|
],
|
|
"type": "object",
|
|
"title": "ImportV1Database"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"queries": {
|
|
"additionalProperties": {
|
|
"properties": {
|
|
"changed_on": { "format": "date-time", "type": "string" },
|
|
"ctas": { "type": "boolean" },
|
|
"db": { "type": "string" },
|
|
"dbId": { "type": "integer" },
|
|
"endDttm": { "type": "number" },
|
|
"errorMessage": { "nullable": true, "type": "string" },
|
|
"executedSql": { "type": "string" },
|
|
"extra": { "type": "object" },
|
|
"id": { "type": "string" },
|
|
"limit": { "type": "integer" },
|
|
"limitingFactor": { "type": "string" },
|
|
"progress": { "type": "integer" },
|
|
"queryId": { "type": "integer" },
|
|
"resultsKey": { "type": "string" },
|
|
"rows": { "type": "integer" },
|
|
"schema": { "type": "string" },
|
|
"serverId": { "type": "integer" },
|
|
"sql": { "type": "string" },
|
|
"sqlEditorId": { "type": "string" },
|
|
"startDttm": { "type": "number" },
|
|
"state": { "type": "string" },
|
|
"tab": { "type": "string" },
|
|
"tempSchema": { "nullable": true, "type": "string" },
|
|
"tempTable": { "nullable": true, "type": "string" },
|
|
"trackingUrl": { "nullable": true, "type": "string" },
|
|
"user": { "type": "string" },
|
|
"userId": { "type": "integer" }
|
|
},
|
|
"type": "object",
|
|
"title": "QueryResult"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"tab_state_ids": {
|
|
"items": { "type": "string" },
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "SQLLabBootstrapSchema"
|
|
},
|
|
"example": {
|
|
"active_tab": {},
|
|
"databases": { "key": "value" },
|
|
"queries": { "key": "value" },
|
|
"tab_state_ids": ["string"]
|
|
}
|
|
}
|
|
},
|
|
"description": "Returns the initial bootstrap data for SqlLab"
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": { "message": "Bad request: Invalid parameters provided" }
|
|
}
|
|
},
|
|
"description": "Bad request"
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": { "message": "Unauthorized: Authentication required" }
|
|
}
|
|
},
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"message": "Forbidden: You don't have permission to access this resource"
|
|
}
|
|
}
|
|
},
|
|
"description": "Forbidden"
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"message": "Internal server error: An unexpected error occurred"
|
|
}
|
|
}
|
|
},
|
|
"description": "Fatal error"
|
|
}
|
|
}
|
|
}
|