Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Auto-update documentation for master (#69888)

github-automation-metabase71cfad67bbf3
diff --git a/docs/api.json b/docs/api.json
index 691d7f6c16d..d1c5bb011fe 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -6946,6 +6946,10 @@
},
"required" : [ "id" ]
},
+ "metabase.driver.connection.connection-type" : {
+ "type" : "string",
+ "enum" : [ "default", "write-data" ]
+ },
"metabase.legacy-mbql.schema.!=" : {
"description" : "schema for a valid MBQL 4 :!= clause",
"allOf" : [ ]
@@ -21215,6 +21219,15 @@
"type" : "null"
} ]
},
+ "write_data_details" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
"settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
@@ -21520,6 +21533,13 @@
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "connection-type",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.driver.connection.connection-type"
+ }
} ],
"responses" : {
"2XX" : {
@@ -44326,6 +44346,149 @@
"tags" : [ "/api/transform" ]
}
},
+ "/api/transform/run/{run-id}" : {
+ "get" : {
+ "summary" : "GET /api/transform/run/{run-id}",
+ "description" : "Get a transform run by ID.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "run-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "transform" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "collection" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "deleted" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "tag_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ]
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "start_time" : { }
+ },
+ "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/transform" ]
+ }
+ },
"/api/transform/{id}" : {
"get" : {
"summary" : "GET /api/transform/{id}",