Files
superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-put.Schema.json

183 lines
5.9 KiB
JSON

{
"schema": {
"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"
},
"schemaType": "response"
}