chore: Migrate /superset/tables/* to API v1 (#22501)

This commit is contained in:
Diego Medina
2023-02-01 09:45:57 -03:00
committed by GitHub
parent ede18be08e
commit 02cd75be8d
17 changed files with 643 additions and 85 deletions

View File

@@ -345,7 +345,7 @@
"AnnotationLayerRestApi.get_list": {
"properties": {
"changed_by": {
"$ref": "#/components/schemas/AnnotationLayerRestApi.get_list.User"
"$ref": "#/components/schemas/AnnotationLayerRestApi.get_list.User1"
},
"changed_on": {
"format": "date-time",
@@ -356,7 +356,7 @@
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/AnnotationLayerRestApi.get_list.User1"
"$ref": "#/components/schemas/AnnotationLayerRestApi.get_list.User"
},
"created_on": {
"format": "date-time",
@@ -502,13 +502,13 @@
"AnnotationRestApi.get_list": {
"properties": {
"changed_by": {
"$ref": "#/components/schemas/AnnotationRestApi.get_list.User"
"$ref": "#/components/schemas/AnnotationRestApi.get_list.User1"
},
"changed_on_delta_humanized": {
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/AnnotationRestApi.get_list.User1"
"$ref": "#/components/schemas/AnnotationRestApi.get_list.User"
},
"end_dttm": {
"format": "date-time",
@@ -1768,7 +1768,7 @@
"type": "string"
},
"changed_by": {
"$ref": "#/components/schemas/ChartDataRestApi.get_list.User1"
"$ref": "#/components/schemas/ChartDataRestApi.get_list.User"
},
"changed_by_name": {
"readOnly": true
@@ -1783,7 +1783,7 @@
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/ChartDataRestApi.get_list.User3"
"$ref": "#/components/schemas/ChartDataRestApi.get_list.User2"
},
"created_on_delta_humanized": {
"readOnly": true
@@ -1830,10 +1830,10 @@
"type": "string"
},
"last_saved_by": {
"$ref": "#/components/schemas/ChartDataRestApi.get_list.User"
"$ref": "#/components/schemas/ChartDataRestApi.get_list.User3"
},
"owners": {
"$ref": "#/components/schemas/ChartDataRestApi.get_list.User2"
"$ref": "#/components/schemas/ChartDataRestApi.get_list.User1"
},
"params": {
"nullable": true,
@@ -1897,10 +1897,6 @@
"maxLength": 64,
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"last_name": {
"maxLength": 64,
"type": "string"
@@ -1913,23 +1909,6 @@
"type": "object"
},
"ChartDataRestApi.get_list.User1": {
"properties": {
"first_name": {
"maxLength": 64,
"type": "string"
},
"last_name": {
"maxLength": 64,
"type": "string"
}
},
"required": [
"first_name",
"last_name"
],
"type": "object"
},
"ChartDataRestApi.get_list.User2": {
"properties": {
"first_name": {
"maxLength": 64,
@@ -1955,6 +1934,27 @@
],
"type": "object"
},
"ChartDataRestApi.get_list.User2": {
"properties": {
"first_name": {
"maxLength": 64,
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"last_name": {
"maxLength": 64,
"type": "string"
}
},
"required": [
"first_name",
"last_name"
],
"type": "object"
},
"ChartDataRestApi.get_list.User3": {
"properties": {
"first_name": {
@@ -2560,7 +2560,7 @@
"type": "string"
},
"changed_by": {
"$ref": "#/components/schemas/ChartRestApi.get_list.User1"
"$ref": "#/components/schemas/ChartRestApi.get_list.User"
},
"changed_by_name": {
"readOnly": true
@@ -2575,7 +2575,7 @@
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/ChartRestApi.get_list.User3"
"$ref": "#/components/schemas/ChartRestApi.get_list.User2"
},
"created_on_delta_humanized": {
"readOnly": true
@@ -2622,10 +2622,10 @@
"type": "string"
},
"last_saved_by": {
"$ref": "#/components/schemas/ChartRestApi.get_list.User"
"$ref": "#/components/schemas/ChartRestApi.get_list.User3"
},
"owners": {
"$ref": "#/components/schemas/ChartRestApi.get_list.User2"
"$ref": "#/components/schemas/ChartRestApi.get_list.User1"
},
"params": {
"nullable": true,
@@ -2689,10 +2689,6 @@
"maxLength": 64,
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"last_name": {
"maxLength": 64,
"type": "string"
@@ -2705,23 +2701,6 @@
"type": "object"
},
"ChartRestApi.get_list.User1": {
"properties": {
"first_name": {
"maxLength": 64,
"type": "string"
},
"last_name": {
"maxLength": 64,
"type": "string"
}
},
"required": [
"first_name",
"last_name"
],
"type": "object"
},
"ChartRestApi.get_list.User2": {
"properties": {
"first_name": {
"maxLength": 64,
@@ -2747,6 +2726,27 @@
],
"type": "object"
},
"ChartRestApi.get_list.User2": {
"properties": {
"first_name": {
"maxLength": 64,
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"last_name": {
"maxLength": 64,
"type": "string"
}
},
"required": [
"first_name",
"last_name"
],
"type": "object"
},
"ChartRestApi.get_list.User3": {
"properties": {
"first_name": {
@@ -3027,13 +3027,13 @@
"CssTemplateRestApi.get_list": {
"properties": {
"changed_by": {
"$ref": "#/components/schemas/CssTemplateRestApi.get_list.User"
"$ref": "#/components/schemas/CssTemplateRestApi.get_list.User1"
},
"changed_on_delta_humanized": {
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/CssTemplateRestApi.get_list.User1"
"$ref": "#/components/schemas/CssTemplateRestApi.get_list.User"
},
"created_on": {
"format": "date-time",
@@ -4056,7 +4056,7 @@
"type": "boolean"
},
"allow_run_async": {
"description": "Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.",
"description": "Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.",
"type": "boolean"
},
"cache_timeout": {
@@ -4169,7 +4169,7 @@
"type": "boolean"
},
"allow_run_async": {
"description": "Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.",
"description": "Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.",
"type": "boolean"
},
"cache_timeout": {
@@ -4288,6 +4288,23 @@
},
"type": "object"
},
"DatabaseTablesResponse": {
"properties": {
"extra": {
"description": "Extra data used to specify column metadata",
"type": "object"
},
"type": {
"description": "table or view",
"type": "string"
},
"value": {
"description": "The table or view name",
"type": "string"
}
},
"type": "object"
},
"DatabaseTestConnectionSchema": {
"properties": {
"configuration_method": {
@@ -9270,6 +9287,20 @@
},
"type": "object"
},
"database_tables_query_schema": {
"properties": {
"force": {
"type": "boolean"
},
"schema_name": {
"type": "string"
}
},
"required": [
"schema_name"
],
"type": "object"
},
"get_delete_ids_schema": {
"items": {
"type": "integer"
@@ -15549,6 +15580,80 @@
]
}
},
"/api/v1/database/{pk}/tables/": {
"get": {
"parameters": [
{
"description": "The database id",
"in": "path",
"name": "pk",
"required": true,
"schema": {
"type": "integer"
}
},
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/database_tables_query_schema"
}
}
},
"in": "query",
"name": "q"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"result": {
"description": "A List of tables for given database",
"items": {
"$ref": "#/components/schemas/DatabaseTablesResponse"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "Tables list"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"422": {
"$ref": "#/components/responses/422"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"jwt": []
}
],
"summary": "Get a list of tables for given database",
"tags": [
"Database"
]
}
},
"/api/v1/database/{pk}/validate_sql/": {
"post": {
"description": "Validates arbitrary SQL.",
@@ -16686,6 +16791,99 @@
]
}
},
"/api/v1/datasource/{datasource_type}/{datasource_id}/column/{column_name}/values/": {
"get": {
"parameters": [
{
"description": "The type of datasource",
"in": "path",
"name": "datasource_type",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The id of the datasource",
"in": "path",
"name": "datasource_id",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "The name of the column to get values for",
"in": "path",
"name": "column_name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "A List of distinct values for the column"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"jwt": []
}
],
"summary": "Get possible values for a datasource column",
"tags": [
"Datasources"
]
}
},
"/api/v1/embedded_dashboard/{uuid}": {
"get": {
"description": "Get a report schedule log",