mirror of
https://github.com/apache/superset.git
synced 2026-08-04 13:02:41 +00:00
224 lines
8.1 KiB
JSON
224 lines
8.1 KiB
JSON
{
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"columns": { "items": { "type": "object" }, "type": "array" },
|
|
"data": { "items": { "type": "object" }, "type": "array" },
|
|
"expanded_columns": {
|
|
"items": { "type": "object" },
|
|
"type": "array"
|
|
},
|
|
"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_id": { "type": "integer" },
|
|
"selected_columns": {
|
|
"items": { "type": "object" },
|
|
"type": "array"
|
|
},
|
|
"status": { "type": "string" }
|
|
},
|
|
"type": "object",
|
|
"title": "QueryExecutionResponseSchema"
|
|
},
|
|
"example": {
|
|
"columns": [{}],
|
|
"data": [{}],
|
|
"expanded_columns": [{}],
|
|
"query": {},
|
|
"query_id": 1,
|
|
"selected_columns": [{}],
|
|
"status": "string"
|
|
}
|
|
}
|
|
},
|
|
"description": "SQL query execution result"
|
|
},
|
|
"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"
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"message": "Not found: The requested resource does not exist"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found"
|
|
},
|
|
"410": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"errors": {
|
|
"items": {
|
|
"properties": {
|
|
"error_type": {
|
|
"enum": [
|
|
"FRONTEND_CSRF_ERROR",
|
|
"FRONTEND_NETWORK_ERROR",
|
|
"FRONTEND_TIMEOUT_ERROR",
|
|
"GENERIC_DB_ENGINE_ERROR",
|
|
"COLUMN_DOES_NOT_EXIST_ERROR",
|
|
"TABLE_DOES_NOT_EXIST_ERROR",
|
|
"SCHEMA_DOES_NOT_EXIST_ERROR",
|
|
"CONNECTION_INVALID_USERNAME_ERROR",
|
|
"CONNECTION_INVALID_PASSWORD_ERROR",
|
|
"CONNECTION_INVALID_HOSTNAME_ERROR",
|
|
"CONNECTION_PORT_CLOSED_ERROR",
|
|
"CONNECTION_INVALID_PORT_ERROR",
|
|
"CONNECTION_HOST_DOWN_ERROR",
|
|
"CONNECTION_ACCESS_DENIED_ERROR",
|
|
"CONNECTION_UNKNOWN_DATABASE_ERROR",
|
|
"CONNECTION_DATABASE_PERMISSIONS_ERROR",
|
|
"CONNECTION_MISSING_PARAMETERS_ERROR",
|
|
"OBJECT_DOES_NOT_EXIST_ERROR",
|
|
"SYNTAX_ERROR",
|
|
"CONNECTION_DATABASE_TIMEOUT",
|
|
"VIZ_GET_DF_ERROR",
|
|
"UNKNOWN_DATASOURCE_TYPE_ERROR",
|
|
"FAILED_FETCHING_DATASOURCE_INFO_ERROR",
|
|
"TABLE_SECURITY_ACCESS_ERROR",
|
|
"DATASOURCE_SECURITY_ACCESS_ERROR",
|
|
"DATABASE_SECURITY_ACCESS_ERROR",
|
|
"QUERY_SECURITY_ACCESS_ERROR",
|
|
"MISSING_OWNERSHIP_ERROR",
|
|
"USER_ACTIVITY_SECURITY_ACCESS_ERROR",
|
|
"DASHBOARD_SECURITY_ACCESS_ERROR",
|
|
"CHART_SECURITY_ACCESS_ERROR",
|
|
"OAUTH2_REDIRECT",
|
|
"OAUTH2_REDIRECT_ERROR",
|
|
"BACKEND_TIMEOUT_ERROR",
|
|
"DATABASE_NOT_FOUND_ERROR",
|
|
"TABLE_NOT_FOUND_ERROR",
|
|
"MISSING_TEMPLATE_PARAMS_ERROR",
|
|
"INVALID_TEMPLATE_PARAMS_ERROR",
|
|
"RESULTS_BACKEND_NOT_CONFIGURED_ERROR",
|
|
"DML_NOT_ALLOWED_ERROR",
|
|
"INVALID_CTAS_QUERY_ERROR",
|
|
"INVALID_CVAS_QUERY_ERROR",
|
|
"SQLLAB_TIMEOUT_ERROR",
|
|
"RESULTS_BACKEND_ERROR",
|
|
"ASYNC_WORKERS_ERROR",
|
|
"ADHOC_SUBQUERY_NOT_ALLOWED_ERROR",
|
|
"INVALID_SQL_ERROR",
|
|
"RESULT_TOO_LARGE_ERROR",
|
|
"GENERIC_COMMAND_ERROR",
|
|
"GENERIC_BACKEND_ERROR",
|
|
"INVALID_PAYLOAD_FORMAT_ERROR",
|
|
"INVALID_PAYLOAD_SCHEMA_ERROR",
|
|
"MARSHMALLOW_ERROR",
|
|
"REPORT_NOTIFICATION_ERROR"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"extra": { "type": "object" },
|
|
"level": {
|
|
"enum": ["info", "warning", "error"],
|
|
"type": "string"
|
|
},
|
|
"message": { "type": "string" }
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"message": { "type": "string" }
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Gone"
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"message": "Internal server error: An unexpected error occurred"
|
|
}
|
|
}
|
|
},
|
|
"description": "Fatal error"
|
|
}
|
|
}
|
|
}
|