mirror of
https://github.com/apache/superset.git
synced 2026-08-04 04:52:32 +00:00
218 lines
7.3 KiB
JSON
218 lines
7.3 KiB
JSON
{
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"description_columns": {
|
|
"properties": {
|
|
"column_name": {
|
|
"description": "The description for the column name. Will be translated by babel",
|
|
"example": "A Nice description for the column",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"id": { "description": "The item id", "type": "string" },
|
|
"label_columns": {
|
|
"properties": {
|
|
"column_name": {
|
|
"description": "The label for the column name. Will be translated by babel",
|
|
"example": "A Nice label for the column",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"result": {
|
|
"properties": {
|
|
"changed_on": {
|
|
"format": "date-time",
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"client_id": { "maxLength": 11, "type": "string" },
|
|
"database": {
|
|
"properties": { "id": { "type": "integer" } },
|
|
"type": "object",
|
|
"title": "QueryRestApi.get.Database"
|
|
},
|
|
"end_result_backend_time": {
|
|
"nullable": true,
|
|
"type": "number"
|
|
},
|
|
"end_time": { "nullable": true, "type": "number" },
|
|
"error_message": { "nullable": true, "type": "string" },
|
|
"executed_sql": { "nullable": true, "type": "string" },
|
|
"id": { "type": "integer" },
|
|
"limit": { "nullable": true, "type": "integer" },
|
|
"progress": { "nullable": true, "type": "integer" },
|
|
"results_key": {
|
|
"maxLength": 64,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"rows": { "nullable": true, "type": "integer" },
|
|
"schema": {
|
|
"maxLength": 256,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"select_as_cta": { "nullable": true, "type": "boolean" },
|
|
"select_as_cta_used": { "nullable": true, "type": "boolean" },
|
|
"select_sql": { "nullable": true, "type": "string" },
|
|
"sql": { "nullable": true, "type": "string" },
|
|
"sql_editor_id": {
|
|
"maxLength": 256,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"start_running_time": { "nullable": true, "type": "number" },
|
|
"start_time": { "nullable": true, "type": "number" },
|
|
"status": {
|
|
"maxLength": 16,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"tab_name": {
|
|
"maxLength": 256,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"tmp_schema_name": {
|
|
"maxLength": 256,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"tmp_table_name": {
|
|
"maxLength": 256,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"tracking_url": { "readOnly": true }
|
|
},
|
|
"required": ["client_id", "database"],
|
|
"type": "object",
|
|
"title": "QueryRestApi.get"
|
|
},
|
|
"show_columns": {
|
|
"description": "A list of columns",
|
|
"items": { "type": "string" },
|
|
"type": "array"
|
|
},
|
|
"show_title": {
|
|
"description": "A title to render. Will be translated by babel",
|
|
"example": "Show Item Details",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"description_columns": {
|
|
"column_name": "A Nice description for the column"
|
|
},
|
|
"id": "string",
|
|
"label_columns": { "column_name": "A Nice label for the column" },
|
|
"result": {
|
|
"changed_on": "2024-01-15T10:30:00Z",
|
|
"client_id": "string",
|
|
"end_result_backend_time": 1,
|
|
"end_time": 1,
|
|
"error_message": "string",
|
|
"executed_sql": "string",
|
|
"id": 1,
|
|
"limit": 1,
|
|
"progress": 1,
|
|
"results_key": "string",
|
|
"rows": 1,
|
|
"schema": "string",
|
|
"select_as_cta": true,
|
|
"select_as_cta_used": true,
|
|
"select_sql": "string",
|
|
"sql": "string",
|
|
"sql_editor_id": "string",
|
|
"start_running_time": 1,
|
|
"start_time": 1,
|
|
"status": "string",
|
|
"tab_name": "string",
|
|
"tmp_schema_name": "string",
|
|
"tmp_table_name": "string",
|
|
"tracking_url": {}
|
|
},
|
|
"show_columns": ["string"],
|
|
"show_title": "Show Item Details"
|
|
}
|
|
}
|
|
},
|
|
"description": "Item from Model"
|
|
},
|
|
"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"
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"message": "Not found: The requested resource does not exist"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found"
|
|
},
|
|
"422": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": { "message": "Unprocessable entity: Validation error" }
|
|
}
|
|
},
|
|
"description": "Could not process entity"
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"message": "Internal server error: An unexpected error occurred"
|
|
}
|
|
}
|
|
},
|
|
"description": "Fatal error"
|
|
}
|
|
}
|
|
}
|