mirror of
https://github.com/apache/superset.git
synced 2026-08-04 13:02:41 +00:00
330 lines
12 KiB
JSON
330 lines
12 KiB
JSON
{
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"id": { "type": "number" },
|
|
"result": {
|
|
"properties": {
|
|
"always_filter_main_dttm": {
|
|
"default": false,
|
|
"type": "boolean"
|
|
},
|
|
"cache_timeout": { "nullable": true, "type": "integer" },
|
|
"catalog": {
|
|
"maxLength": 250,
|
|
"minLength": 0,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"columns": {
|
|
"items": {
|
|
"properties": {
|
|
"advanced_data_type": {
|
|
"maxLength": 255,
|
|
"minLength": 1,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"column_name": {
|
|
"maxLength": 255,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"datetime_format": {
|
|
"maxLength": 100,
|
|
"minLength": 1,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"description": { "nullable": true, "type": "string" },
|
|
"expression": { "nullable": true, "type": "string" },
|
|
"extra": { "nullable": true, "type": "string" },
|
|
"filterable": { "type": "boolean" },
|
|
"groupby": { "type": "boolean" },
|
|
"id": { "type": "integer" },
|
|
"is_active": { "nullable": true, "type": "boolean" },
|
|
"is_dttm": { "nullable": true, "type": "boolean" },
|
|
"python_date_format": {
|
|
"maxLength": 255,
|
|
"minLength": 1,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"type": { "nullable": true, "type": "string" },
|
|
"uuid": {
|
|
"format": "uuid",
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"verbose_name": { "nullable": true, "type": "string" }
|
|
},
|
|
"required": ["column_name"],
|
|
"type": "object",
|
|
"title": "DatasetColumnsPut"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"currency_code_column": {
|
|
"maxLength": 250,
|
|
"minLength": 0,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"database_id": { "type": "integer" },
|
|
"default_endpoint": { "nullable": true, "type": "string" },
|
|
"description": { "nullable": true, "type": "string" },
|
|
"external_url": { "nullable": true, "type": "string" },
|
|
"extra": { "nullable": true, "type": "string" },
|
|
"fetch_values_predicate": {
|
|
"maxLength": 1000,
|
|
"minLength": 0,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"filter_select_enabled": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"folders": {
|
|
"items": {
|
|
"properties": {
|
|
"children": {
|
|
"items": "circular(Folder)",
|
|
"nullable": true,
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"maxLength": 1000,
|
|
"minLength": 0,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 250,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"enum": ["metric", "column", "folder"],
|
|
"type": "string"
|
|
},
|
|
"uuid": { "format": "uuid", "type": "string" }
|
|
},
|
|
"required": ["uuid"],
|
|
"type": "object",
|
|
"title": "Folder"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"is_managed_externally": {
|
|
"nullable": true,
|
|
"type": "boolean"
|
|
},
|
|
"is_sqllab_view": { "nullable": true, "type": "boolean" },
|
|
"main_dttm_col": { "nullable": true, "type": "string" },
|
|
"metrics": {
|
|
"items": {
|
|
"properties": {
|
|
"currency": {
|
|
"allOf": [
|
|
{
|
|
"properties": {
|
|
"symbol": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"symbolPosition": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "DatasetMetricCurrencyPut"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"d3format": {
|
|
"maxLength": 128,
|
|
"minLength": 1,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"description": { "nullable": true, "type": "string" },
|
|
"expression": { "type": "string" },
|
|
"extra": { "nullable": true, "type": "string" },
|
|
"id": { "type": "integer" },
|
|
"metric_name": {
|
|
"maxLength": 255,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"metric_type": {
|
|
"maxLength": 32,
|
|
"minLength": 1,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"uuid": {
|
|
"format": "uuid",
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"verbose_name": { "nullable": true, "type": "string" },
|
|
"warning_text": { "nullable": true, "type": "string" }
|
|
},
|
|
"required": ["expression", "metric_name"],
|
|
"type": "object",
|
|
"title": "DatasetMetricsPut"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"normalize_columns": { "nullable": true, "type": "boolean" },
|
|
"offset": { "nullable": true, "type": "integer" },
|
|
"owners": { "items": { "type": "integer" }, "type": "array" },
|
|
"schema": {
|
|
"maxLength": 255,
|
|
"minLength": 0,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"sql": { "nullable": true, "type": "string" },
|
|
"table_name": {
|
|
"maxLength": 250,
|
|
"minLength": 1,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"template_params": { "nullable": true, "type": "string" },
|
|
"uuid": {
|
|
"format": "uuid",
|
|
"nullable": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "DatasetRestApi.put"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"id": 1,
|
|
"result": {
|
|
"always_filter_main_dttm": true,
|
|
"cache_timeout": 1,
|
|
"catalog": "string",
|
|
"columns": [],
|
|
"currency_code_column": "string",
|
|
"database_id": 1,
|
|
"default_endpoint": "string",
|
|
"description": "string",
|
|
"external_url": "string",
|
|
"extra": "string",
|
|
"fetch_values_predicate": "string",
|
|
"filter_select_enabled": true,
|
|
"folders": [],
|
|
"is_managed_externally": true,
|
|
"is_sqllab_view": true,
|
|
"main_dttm_col": "string",
|
|
"metrics": [],
|
|
"normalize_columns": true,
|
|
"offset": 1,
|
|
"owners": [],
|
|
"schema": "string",
|
|
"sql": "string",
|
|
"table_name": "string",
|
|
"template_params": "string",
|
|
"uuid": "550e8400-e29b-41d4-a716-446655440000"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Dataset changed"
|
|
},
|
|
"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"
|
|
},
|
|
"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"
|
|
}
|
|
}
|
|
}
|