mirror of
https://github.com/apache/superset.git
synced 2026-08-04 21:12:44 +00:00
104 lines
3.2 KiB
JSON
104 lines
3.2 KiB
JSON
{
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"available_drivers": {
|
|
"description": "Installed drivers for the engine",
|
|
"items": { "type": "string" },
|
|
"type": "array"
|
|
},
|
|
"default_driver": {
|
|
"description": "Default driver for the engine",
|
|
"type": "string"
|
|
},
|
|
"engine": {
|
|
"description": "Name of the SQLAlchemy engine",
|
|
"type": "string"
|
|
},
|
|
"engine_information": {
|
|
"description": "Dict with public properties form the DB Engine",
|
|
"properties": {
|
|
"disable_ssh_tunneling": {
|
|
"description": "Whether the engine supports SSH Tunnels",
|
|
"type": "boolean"
|
|
},
|
|
"supports_file_upload": {
|
|
"description": "Whether the engine supports file uploads",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "Name of the database",
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"description": "JSON schema defining the needed parameters",
|
|
"type": "object"
|
|
},
|
|
"preferred": {
|
|
"description": "Is the database preferred?",
|
|
"type": "boolean"
|
|
},
|
|
"sqlalchemy_uri_placeholder": {
|
|
"description": "Example placeholder for the SQLAlchemy URI",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"example": [
|
|
{
|
|
"available_drivers": ["string"],
|
|
"default_driver": "string",
|
|
"engine": "string",
|
|
"engine_information": {
|
|
"disable_ssh_tunneling": true,
|
|
"supports_file_upload": true
|
|
},
|
|
"name": "string",
|
|
"parameters": {},
|
|
"preferred": true,
|
|
"sqlalchemy_uri_placeholder": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"description": "Database names"
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": { "message": "Bad request: Invalid parameters provided" }
|
|
}
|
|
},
|
|
"description": "Bad request"
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"message": "Internal server error: An unexpected error occurred"
|
|
}
|
|
}
|
|
},
|
|
"description": "Fatal error"
|
|
}
|
|
}
|
|
}
|