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 (#68447)

github-automation-metabasecdf5111a0d24
diff --git a/docs/api.json b/docs/api.json
index 1d53986c845..303f258df4a 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -12403,6 +12403,61 @@
} ]
} ]
},
+ "metabase.query-processor.schema..query-result.data" : {
+ "description" : "Schema for the :data key of query results.",
+ "type" : "object",
+ "properties" : {
+ "insights" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "results_metadata" : {
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema..result-metadata.column"
+ }
+ }
+ },
+ "required" : [ "columns" ]
+ },
+ "download_perms" : {
+ "type" : "string"
+ },
+ "format-rows?" : {
+ "type" : "boolean"
+ },
+ "is_sandboxed" : {
+ "type" : "boolean"
+ },
+ "cols" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema..result-metadata.column"
+ }
+ },
+ "results_timezone" : {
+ "type" : "string"
+ },
+ "rows" : {
+ "type" : "array",
+ "items" : {
+ "type" : "array",
+ "items" : { }
+ }
+ },
+ "native_form" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "cols", "rows" ]
+ },
"metabase.query-processor.schema..result-metadata.column" : {
"description" : "A single result metadata column as returned by the Query Processor.",
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
@@ -12425,6 +12480,57 @@
"type" : "string",
"enum" : [ "csv", "api", "xlsx", "json" ]
},
+ "metabase.query-processor.schema.query-result" : {
+ "description" : "Schema for query execution results returned by the Query Processor.",
+ "type" : "object",
+ "properties" : {
+ "row_count" : {
+ "type" : "integer"
+ },
+ "error" : {
+ "type" : "string"
+ },
+ "started_at" : {
+ "type" : "string"
+ },
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ },
+ "context" : { },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "completed", "failed" ]
+ },
+ "error_type" : {
+ "type" : "string"
+ },
+ "running_time" : {
+ "type" : "integer"
+ },
+ "json_query" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "average_execution_time" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "cached" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "data" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema..query-result.data"
+ }
+ },
+ "required" : [ "status", "row_count" ]
+ },
"metabase.sync.schedules.ExpandedSchedulesMap" : {
"description" : "value must be a valid map of schedule maps for a DB.",
"type" : "object",
@@ -12864,7 +12970,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "sequence of An Action as it should appear when we `SELECT` it from the app DB.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -12891,7 +12997,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "An Action as it should appear when we `SELECT` it from the app DB.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -12926,7 +13032,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "sequence of An Action as it should appear when we `SELECT` it from the app DB.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -12964,7 +13070,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "An Action as it should appear when we `SELECT` it from the app DB.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -13607,7 +13713,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:id -> <value must be an integer greater than zero.>, :unmasked_key -> <Unhashed string of the form 'mb_<base-64-bytes>'.>, :masked_key -> <Masked string like 'mb_1234**********'.>, :prefix -> <Prefix string of an API Key, suitable for passing around unmasked. This must be unique.>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -16394,7 +16500,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:data -> <sequence of map where {:id -> <integer greater than 0>, :name -> <string>, :description -> <nullable string>, :sole_dashboard_info -> <map where {:id -> <integer greater than 0>, :name -> <string>, :description -> <nullable string>}>}>, :total -> <integer>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -16570,7 +16676,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:moved -> <sequence of value must be an integer greater than zero.>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -16901,7 +17007,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:data -> <sequence of map where {:id -> <integer greater than 0>, :name -> <string>, :description -> <nullable string>, :sole_dashboard_info -> <map where {:id -> <integer greater than 0>, :name -> <string>, :description -> <nullable string>}>}>, :total -> <integer>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -17069,7 +17175,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:moved -> <sequence of value must be an integer greater than zero.>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -19779,7 +19885,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "sequence of string",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -19817,7 +19923,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:settings -> <map from <keyword> to <map where {:enabled -> <boolean>, :reasons (optional) -> <sequence of map where {:key -> <keyword>, :type -> <enum of :error, :warning>, :message -> <string, or function>}>}>>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -20028,7 +20134,14 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -20250,7 +20363,14 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -20341,7 +20461,14 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -20553,7 +20680,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "sequence of map where {:name -> <string>, :id -> <value must be an integer greater than zero.>, :public_uuid -> <value must be a valid UUID.>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -20902,7 +21029,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:uuid -> <value must be a valid UUID.>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -21377,7 +21504,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:body -> <anything>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -21731,7 +21858,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:data -> <sequence of map where {:locale -> <value must be a non-blank string.>, :msgid -> <value must be a non-blank string.>, :msgstr -> <string>}>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -21848,7 +21975,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "null",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -21883,7 +22010,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map with no other keys",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -21987,7 +22114,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Schema for /publish-tables endpoint response. Matches frontend PublishTablesResponse type.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22022,7 +22149,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "null",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22057,7 +22184,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22092,7 +22219,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "null",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22127,7 +22254,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "null",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22400,7 +22527,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:success -> <boolean>, :bad_cards (optional) -> <sequence of Schema for an instance of a `:model/Card` (everything is optional to support updates).>, :bad_transforms (optional) -> <sequence of map where {:description (optional) -> <nullable string>, :name -> <string>, :source -> <one of <:query = map where {:type -> <must equal :query>, :query -> <Schema for Card.dataset_query. Cards are for some wacko reason allowed to be saved with empty queries (`{}`), but not\n `NULL` ones, because the column is non-null. This sorta seems like an oversight but fixing all the tests that save\n Cards with empty queries is too much to attempt at this point. So a Card either has an empty query or a valid MBQL 5\n query.>, :source-incremental-strategy (optional) -> <one of <checkpoint = map where {:type -> <must equal checkpoint>, :checkpoint-filter (optional) -> <string>, :checkpoint-filter-unique-key (optional) -> <regex pattern matching #\"^column-unique-key-v\\d+\\$.+$\">}> dispatched by :type>} | :python = map where {:source-database (optional) -> <integer>, :source-tables -> <map from <string> to <Either a table ID (int) or a reference map.>>, :type -> <must equal :python>, :body -> <string>, :source-incremental-strategy (optional) -> <one of <checkpoint = map where {:type -> <must equal checkpoint>, :checkpoint-filter (optional) -> <string>, :checkpoint-filter-unique-key (optional) -> <regex pattern matching #\"^column-unique-key-v\\d+\\$.+$\">}> dispatched by :type>}> dispatched by clojure.core$comp$fn__5897@2541517c>, :target -> <one of <table = map where {:database (optional) -> <integer>, :type -> <must equal table>, :schema (optional) -> <value must be a non-blank string., or null>, :name -> <string>} | table-incremental = map where {:database (optional) -> <integer>, :type -> <must equal table-incremental>, :schema (optional) -> <value must be a non-blank string., or null>, :name -> <string>, :target-incremental-strategy -> <one of <append = map where {:type -> <must equal append>}> dispatched by :type>}> dispatched by :type>}>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22435,7 +22562,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:success -> <boolean>, :bad_cards (optional) -> <sequence of Schema for an instance of a `:model/Card` (everything is optional to support updates).>, :bad_transforms (optional) -> <sequence of map where {:description (optional) -> <nullable string>, :name -> <string>, :source -> <one of <:query = map where {:type -> <must equal :query>, :query -> <Schema for Card.dataset_query. Cards are for some wacko reason allowed to be saved with empty queries (`{}`), but not\n `NULL` ones, because the column is non-null. This sorta seems like an oversight but fixing all the tests that save\n Cards with empty queries is too much to attempt at this point. So a Card either has an empty query or a valid MBQL 5\n query.>, :source-incremental-strategy (optional) -> <one of <checkpoint = map where {:type -> <must equal checkpoint>, :checkpoint-filter (optional) -> <string>, :checkpoint-filter-unique-key (optional) -> <regex pattern matching #\"^column-unique-key-v\\d+\\$.+$\">}> dispatched by :type>} | :python = map where {:source-database (optional) -> <integer>, :source-tables -> <map from <string> to <Either a table ID (int) or a reference map.>>, :type -> <must equal :python>, :body -> <string>, :source-incremental-strategy (optional) -> <one of <checkpoint = map where {:type -> <must equal checkpoint>, :checkpoint-filter (optional) -> <string>, :checkpoint-filter-unique-key (optional) -> <regex pattern matching #\"^column-unique-key-v\\d+\\$.+$\">}> dispatched by :type>}> dispatched by clojure.core$comp$fn__5897@2541517c>, :target -> <one of <table = map where {:database (optional) -> <integer>, :type -> <must equal table>, :schema (optional) -> <value must be a non-blank string., or null>, :name -> <string>} | table-incremental = map where {:database (optional) -> <integer>, :type -> <must equal table-incremental>, :schema (optional) -> <value must be a non-blank string., or null>, :name -> <string>, :target-incremental-strategy -> <one of <append = map where {:type -> <must equal append>}> dispatched by :type>}> dispatched by :type>}>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22482,7 +22609,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:success -> <boolean>, :bad_cards (optional) -> <sequence of Schema for an instance of a `:model/Card` (everything is optional to support updates).>, :bad_transforms (optional) -> <sequence of map where {:description (optional) -> <nullable string>, :name -> <string>, :source -> <one of <:query = map where {:type -> <must equal :query>, :query -> <Schema for Card.dataset_query. Cards are for some wacko reason allowed to be saved with empty queries (`{}`), but not\n `NULL` ones, because the column is non-null. This sorta seems like an oversight but fixing all the tests that save\n Cards with empty queries is too much to attempt at this point. So a Card either has an empty query or a valid MBQL 5\n query.>, :source-incremental-strategy (optional) -> <one of <checkpoint = map where {:type -> <must equal checkpoint>, :checkpoint-filter (optional) -> <string>, :checkpoint-filter-unique-key (optional) -> <regex pattern matching #\"^column-unique-key-v\\d+\\$.+$\">}> dispatched by :type>} | :python = map where {:source-database (optional) -> <integer>, :source-tables -> <map from <string> to <Either a table ID (int) or a reference map.>>, :type -> <must equal :python>, :body -> <string>, :source-incremental-strategy (optional) -> <one of <checkpoint = map where {:type -> <must equal checkpoint>, :checkpoint-filter (optional) -> <string>, :checkpoint-filter-unique-key (optional) -> <regex pattern matching #\"^column-unique-key-v\\d+\\$.+$\">}> dispatched by :type>}> dispatched by clojure.core$comp$fn__5897@2541517c>, :target -> <one of <table = map where {:database (optional) -> <integer>, :type -> <must equal table>, :schema (optional) -> <value must be a non-blank string., or null>, :name -> <string>} | table-incremental = map where {:database (optional) -> <integer>, :type -> <must equal table-incremental>, :schema (optional) -> <value must be a non-blank string., or null>, :name -> <string>, :target-incremental-strategy -> <one of <append = map where {:type -> <must equal append>}> dispatched by :type>}> dispatched by :type>}>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22540,7 +22667,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:nodes -> <sequence of one of <:table = map where {:id -> <integer greater than 0>, :type -> <must equal :table>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :display_name (optional) -> <anything>, :db_id (optional) -> <anything>, :db (optional) -> <anything>, :schema (optional) -> <anything>, :fields (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :card = map where {:id -> <integer greater than 0>, :type -> <must equal :card>, :data -> <map where {:name (optional) -> <anything>, :type (optional) -> <anything>, :display (optional) -> <anything>, :database_id (optional) -> <anything>, :view_count (optional) -> <anything>, :query_type (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :description (optional) -> <anything>, :result_metadata (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :dashboard (optional) -> <anything>, :dashboard_id (optional) -> <anything>, :document (optional) -> <anything>, :document_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :snippet = map where {:id -> <integer greater than 0>, :type -> <must equal :snippet>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :transform = map where {:id -> <integer greater than 0>, :type -> <must equal :transform>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :creator (optional) -> <anything>, :table (optional) -> <anything>, :last_run (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :dashboard = map where {:id -> <integer greater than 0>, :type -> <must equal :dashboard>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :view_count (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :moderation_reviews (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :document = map where {:id -> <integer greater than 0>, :type -> <must equal :document>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :view_count (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :sandbox = map where {:id -> <integer greater than 0>, :type -> <must equal :sandbox>, :data -> <map where {:table (optional) -> <anything>, :table_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :segment = map where {:id -> <integer greater than 0>, :type -> <must equal :segment>, :data -> <map where {:name (optional) -> <anything>, :type (optional) -> <anything>, :display (optional) -> <anything>, :database_id (optional) -> <anything>, :view_count (optional) -> <anything>, :query_type (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :description (optional) -> <anything>, :result_metadata (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :dashboard (optional) -> <anything>, :dashboard_id (optional) -> <anything>, :document (optional) -> <anything>, :document_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :measure = map where {:id -> <integer greater than 0>, :type -> <must equal :measure>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :table (optional) -> <anything>, :table_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>}> dispatched by :type>, :edges -> <sequence of map where {:from_entity_type -> <enum of :transform, :table, :snippet, :dashboard, :sandbox, :measure, :card, :document, :segment>, :from_entity_id -> <integer greater than 0>, :to_entity_type -> <enum of :transform, :table, :snippet, :dashboard, :sandbox, :measure, :card, :document, :segment>, :to_entity_id -> <integer greater than 0>}>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22633,7 +22760,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:data -> <sequence of one of <:table = map where {:id -> <integer greater than 0>, :type -> <must equal :table>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :display_name (optional) -> <anything>, :db_id (optional) -> <anything>, :db (optional) -> <anything>, :schema (optional) -> <anything>, :fields (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :card = map where {:id -> <integer greater than 0>, :type -> <must equal :card>, :data -> <map where {:name (optional) -> <anything>, :type (optional) -> <anything>, :display (optional) -> <anything>, :database_id (optional) -> <anything>, :view_count (optional) -> <anything>, :query_type (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :description (optional) -> <anything>, :result_metadata (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :dashboard (optional) -> <anything>, :dashboard_id (optional) -> <anything>, :document (optional) -> <anything>, :document_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :snippet = map where {:id -> <integer greater than 0>, :type -> <must equal :snippet>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :transform = map where {:id -> <integer greater than 0>, :type -> <must equal :transform>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :creator (optional) -> <anything>, :table (optional) -> <anything>, :last_run (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :dashboard = map where {:id -> <integer greater than 0>, :type -> <must equal :dashboard>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :view_count (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :moderation_reviews (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :document = map where {:id -> <integer greater than 0>, :type -> <must equal :document>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :view_count (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :sandbox = map where {:id -> <integer greater than 0>, :type -> <must equal :sandbox>, :data -> <map where {:table (optional) -> <anything>, :table_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :segment = map where {:id -> <integer greater than 0>, :type -> <must equal :segment>, :data -> <map where {:name (optional) -> <anything>, :type (optional) -> <anything>, :display (optional) -> <anything>, :database_id (optional) -> <anything>, :view_count (optional) -> <anything>, :query_type (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :description (optional) -> <anything>, :result_metadata (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :dashboard (optional) -> <anything>, :dashboard_id (optional) -> <anything>, :document (optional) -> <anything>, :document_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :measure = map where {:id -> <integer greater than 0>, :type -> <must equal :measure>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :table (optional) -> <anything>, :table_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>}> dispatched by :type>, :total -> <natural integer>, :offset -> <natural integer>, :limit -> <value must be an integer greater than zero.>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22719,7 +22846,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "sequence of one of <:table = map where {:id -> <integer greater than 0>, :type -> <must equal :table>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :display_name (optional) -> <anything>, :db_id (optional) -> <anything>, :db (optional) -> <anything>, :schema (optional) -> <anything>, :fields (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :card = map where {:id -> <integer greater than 0>, :type -> <must equal :card>, :data -> <map where {:name (optional) -> <anything>, :type (optional) -> <anything>, :display (optional) -> <anything>, :database_id (optional) -> <anything>, :view_count (optional) -> <anything>, :query_type (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :description (optional) -> <anything>, :result_metadata (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :dashboard (optional) -> <anything>, :dashboard_id (optional) -> <anything>, :document (optional) -> <anything>, :document_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :snippet = map where {:id -> <integer greater than 0>, :type -> <must equal :snippet>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :transform = map where {:id -> <integer greater than 0>, :type -> <must equal :transform>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :creator (optional) -> <anything>, :table (optional) -> <anything>, :last_run (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :dashboard = map where {:id -> <integer greater than 0>, :type -> <must equal :dashboard>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :view_count (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :moderation_reviews (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :document = map where {:id -> <integer greater than 0>, :type -> <must equal :document>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :view_count (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :sandbox = map where {:id -> <integer greater than 0>, :type -> <must equal :sandbox>, :data -> <map where {:table (optional) -> <anything>, :table_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :segment = map where {:id -> <integer greater than 0>, :type -> <must equal :segment>, :data -> <map where {:name (optional) -> <anything>, :type (optional) -> <anything>, :display (optional) -> <anything>, :database_id (optional) -> <anything>, :view_count (optional) -> <anything>, :query_type (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :description (optional) -> <anything>, :result_metadata (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :dashboard (optional) -> <anything>, :dashboard_id (optional) -> <anything>, :document (optional) -> <anything>, :document_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :measure = map where {:id -> <integer greater than 0>, :type -> <must equal :measure>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :table (optional) -> <anything>, :table_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>}> dispatched by :type",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22815,7 +22942,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:data -> <sequence of one of <:table = map where {:id -> <integer greater than 0>, :type -> <must equal :table>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :display_name (optional) -> <anything>, :db_id (optional) -> <anything>, :db (optional) -> <anything>, :schema (optional) -> <anything>, :fields (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :card = map where {:id -> <integer greater than 0>, :type -> <must equal :card>, :data -> <map where {:name (optional) -> <anything>, :type (optional) -> <anything>, :display (optional) -> <anything>, :database_id (optional) -> <anything>, :view_count (optional) -> <anything>, :query_type (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :description (optional) -> <anything>, :result_metadata (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :dashboard (optional) -> <anything>, :dashboard_id (optional) -> <anything>, :document (optional) -> <anything>, :document_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :snippet = map where {:id -> <integer greater than 0>, :type -> <must equal :snippet>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :transform = map where {:id -> <integer greater than 0>, :type -> <must equal :transform>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :creator (optional) -> <anything>, :table (optional) -> <anything>, :last_run (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :dashboard = map where {:id -> <integer greater than 0>, :type -> <must equal :dashboard>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :view_count (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :moderation_reviews (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :document = map where {:id -> <integer greater than 0>, :type -> <must equal :document>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :view_count (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :sandbox = map where {:id -> <integer greater than 0>, :type -> <must equal :sandbox>, :data -> <map where {:table (optional) -> <anything>, :table_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :segment = map where {:id -> <integer greater than 0>, :type -> <must equal :segment>, :data -> <map where {:name (optional) -> <anything>, :type (optional) -> <anything>, :display (optional) -> <anything>, :database_id (optional) -> <anything>, :view_count (optional) -> <anything>, :query_type (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :description (optional) -> <anything>, :result_metadata (optional) -> <anything>, :last-edit-info (optional) -> <anything>, :collection (optional) -> <anything>, :collection_id (optional) -> <anything>, :dashboard (optional) -> <anything>, :dashboard_id (optional) -> <anything>, :document (optional) -> <anything>, :document_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>} | :measure = map where {:id -> <integer greater than 0>, :type -> <must equal :measure>, :data -> <map where {:name (optional) -> <anything>, :description (optional) -> <anything>, :created_at (optional) -> <anything>, :creator (optional) -> <anything>, :creator_id (optional) -> <anything>, :table (optional) -> <anything>, :table_id (optional) -> <anything>}>, :dependents_count -> <nullable map from <enum of :table, :snippet, :transform, :dashboard, :document, :sandbox, :segment, :question, :model, :metric, :measure> to <integer greater than 0>>, :errors (optional) -> <set of map where {:type -> <keyword, and function>}, and one of <:validate/missing-column = map where {:type -> <must equal :validate/missing-column>, :name -> <string>} | :validate/missing-table-alias = map where {:type -> <must equal :validate/missing-table-alias>, :name -> <string>} | :validate/duplicate-column = map where {:type -> <must equal :validate/duplicate-column>, :name -> <string>} | :validate/syntax-error = map where {:type -> <must equal :validate/syntax-error>} | :validate/validation-exception-error = map where {:type -> <must equal :validate/validation-exception-error>, :message -> <string>}> dispatched by metabase.lib.schema.validate$eval52839$fn__52840@63d8c712>}> dispatched by :type>, :total -> <natural integer>, :offset -> <natural integer>, :limit -> <value must be an integer greater than zero.>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -22964,7 +23091,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:error -> <true>, :message -> <value must be a non-blank string.>}, or one of <not-connected = map | syncing = map where {:url -> <value must be a non-blank string.>, :created_at -> <integer greater than 0>, :sync_started_at -> <integer greater than 0>, :created_by_id -> <integer greater than 0>, :db_id -> <integer greater than 0>} | active = map where {:url -> <value must be a non-blank string.>, :created_at -> <integer greater than 0>, :last_sync_at -> <integer greater than 0>, :next_sync_at -> <integer greater than 0>, :created_by_id -> <integer greater than 0>, :db_id -> <integer greater than 0>} | error = map where {:url -> <value must be a non-blank string.>, :created_at -> <integer greater than 0>, :error_message -> <value must be a non-blank string.>, :created_by_id -> <integer greater than 0>, :db_id -> <integer greater than 0>}> dispatched by :status",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -23004,7 +23131,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:error -> <true>, :message -> <value must be a non-blank string.>}, or one of <not-connected = map | syncing = map where {:url -> <value must be a non-blank string.>, :created_at -> <integer greater than 0>, :sync_started_at -> <integer greater than 0>, :created_by_id -> <integer greater than 0>, :db_id -> <integer greater than 0>} | active = map where {:url -> <value must be a non-blank string.>, :created_at -> <integer greater than 0>, :last_sync_at -> <integer greater than 0>, :next_sync_at -> <integer greater than 0>, :created_by_id -> <integer greater than 0>, :db_id -> <integer greater than 0>} | error = map where {:url -> <value must be a non-blank string.>, :created_at -> <integer greater than 0>, :error_message -> <value must be a non-blank string.>, :created_by_id -> <integer greater than 0>, :db_id -> <integer greater than 0>}> dispatched by :status",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -23066,7 +23193,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:email -> <nullable string>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -23119,7 +23246,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:id -> <value must be an integer greater than zero.>, :entity_id (optional) -> <string>, :model (optional) -> <enum of card, dataset, metric, dashboard, snippet, collection, indexed-entity, indexed-entity, document, table>, :name -> <string>, :description -> <nullable string>, :archived -> <boolean>, :copy (optional) -> <boolean>, :collection_position (optional) -> <nullable value must be an integer greater than zero.>, :collection_preview (optional) -> <nullable boolean>, :fully_parameterized (optional) -> <nullable boolean>, :based_on_upload (optional) -> <nullable value must be an integer greater than zero., or string>, :collection (optional) -> <nullable map where {:id -> <string, or value must be an integer greater than zero.>, :name -> <string>, :slug (optional) -> <string>, :entity_id (optional) -> <string>, :description -> <nullable string>, :can_write -> <boolean>, :can_restore -> <boolean>, :can_delete -> <boolean>, :archived -> <boolean>, :children (optional) -> <sequence of map where {:id -> <string, or value must be an integer greater than zero.>, :name -> <string>, :slug (optional) -> <string>, :entity_id (optional) -> <string>, :description -> <nullable string>, :can_write -> <boolean>, :can_restore -> <boolean>, :can_delete -> <boolean>, :archived -> <boolean>, :children (optional) -> <sequence of recursive :metabase.collections.schema/Collection>, :authority_level (optional) -> <nullable string>, :type (optional) -> <enum of instance-analytics, trash, remote-synced, library, library-models, library-metrics>, :is_remote_synced (optional) -> <boolean>, :parent_id (optional) -> <nullable string, or value must be an integer greater than zero.>, :personal_owner_id (optional) -> <value must be an integer greater than zero.>, :is_personal (optional) -> <boolean>, :is_sample (optional) -> <boolean>, :location -> <nullable string>, :effective_location (optional) -> <string>, :effective_ancestors (optional) -> <map>, :here (optional) -> <set of enum of card, dataset, metric, dashboard, snippet, collection, indexed-entity, indexed-entity, document, table>, :below (optional) -> <sequence of enum of card, dataset, metric, dashboard, snippet, collection, indexed-entity, indexed-entity, document, table>, :git_sync_enabled (optional) -> <boolean>}>, :authority_level (optional) -> <nullable string>, :type (optional) -> <enum of instance-analytics, trash, remote-synced, library, library-models, library-metrics>, :is_remote_synced (optional) -> <boolean>, :parent_id (optional) -> <nullable string, or value must be an integer greater than zero.>, :personal_owner_id (optional) -> <value must be an integer greater than zero.>, :is_personal (optional) -> <boolean>, :is_sample (optional) -> <boolean>, :location -> <nullable string>, :effective_location (optional) -> <string>, :effective_ancestors (optional) -> <map>, :here (optional) -> <set of enum of card, dataset, metric, dashboard, snippet, collection, indexed-entity, indexed-entity, document, table>, :below (optional) -> <sequence of enum of card, dataset, metric, dashboard, snippet, collection, indexed-entity, indexed-entity, document, table>, :git_sync_enabled (optional) -> <boolean>}>, :collection_id (optional) -> <nullable value must be an integer greater than zero., or string>, :display (optional) -> <string>, :personal_owner_id (optional) -> <nullable value must be an integer greater than zero.>, :database_id (optional) -> <nullable value must be an integer greater than zero.>, :moderated_status (optional) -> <string>, :type (optional) -> <enum of instance-analytics, trash, remote-synced, library, library-models, library-metrics, or enum of model, question, metric>, :here (optional) -> <set of enum of card, dataset, metric, dashboard, snippet, collection, indexed-entity, indexed-entity, document, table>, :below (optional) -> <sequence of enum of card, dataset, metric, dashboard, snippet, collection, indexed-entity, indexed-entity, document, table>, :can_write (optional) -> <boolean>, :can_restore (optional) -> <boolean>, :can_delete (optional) -> <boolean>, :last-edit-info (optional) -> <map where {:id -> <nullable value must be an integer greater than zero.>, :email -> <nullable string>, :first_name -> <nullable string>, :last_name -> <nullable string>, :timestamp -> <nullable string>}>, :location (optional) -> <string>, :effective_location (optional) -> <string>, :authority_level (optional) -> <nullable string>, :dashboard_count (optional) -> <nullable value must be an integer greater than zero.>}, or map where {:data -> <null>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25299,7 +25426,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:model-type -> <enum of card, invalid>, :model-id -> <string>, :decision -> <enum of allow, denied, limited>, :segment -> <set of enum of sandboxed, impersonated, routed>, :message -> <sequence of string>, :data -> <map>, :suggestions -> <map from <integer> to <string>>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25325,7 +25452,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:items -> <sequence of string>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25360,7 +25487,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:status -> <string>, :message -> <string>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25411,7 +25538,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "nullable map where {:id -> <integer greater than 0>, :sync_task_type -> <enum of import, export>, :initiated_by (optional) -> <nullable integer greater than 0>, :progress -> <nullable float between 0.0 and 1.0 inclusive>, :started_at -> <anything>, :ended_at (optional) -> <nullable anything>, :last_progress_report_at (optional) -> <nullable anything>, :version (optional) -> <nullable string>, :cancelled (optional) -> <nullable boolean>, :error_message (optional) -> <nullable string>, :status -> <enum of :running, :successful, :errored, :cancelled, :timed-out>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25505,7 +25632,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:id -> <integer greater than 0>, :sync_task_type -> <enum of import, export>, :initiated_by (optional) -> <nullable integer greater than 0>, :progress -> <nullable float between 0.0 and 1.0 inclusive>, :started_at -> <anything>, :ended_at (optional) -> <nullable anything>, :last_progress_report_at (optional) -> <nullable anything>, :version (optional) -> <nullable string>, :cancelled (optional) -> <nullable boolean>, :error_message (optional) -> <nullable string>, :status -> <enum of :running, :successful, :errored, :cancelled, :timed-out>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25595,7 +25722,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:dirty -> <sequence of map where {:id -> <integer greater than 0>, :name -> <nullable string>, :model -> <string>, :sync_status -> <string>, :created_at (optional) -> <anything>, :updated_at (optional) -> <nullable anything>, :collection_id (optional) -> <nullable integer greater than 0>, :authority_level (optional) -> <nullable string>, :display (optional) -> <nullable string>, :query_type (optional) -> <nullable string>, :description (optional) -> <nullable string>, :table_id (optional) -> <nullable integer greater than 0>, :table_name (optional) -> <nullable string>}>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25707,7 +25834,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:message -> <string>, :task_id -> <integer greater than 0>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25750,7 +25877,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:has_changes -> <boolean>, :remote_version -> <nullable string>, :local_version -> <nullable string>, :cached -> <boolean>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25799,7 +25926,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:status -> <must equal :success>, :task_id -> <nullable integer greater than 0>, :message (optional) -> <nullable string>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25864,7 +25991,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:is_dirty -> <boolean>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25896,7 +26023,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:success -> <boolean>, :task_id (optional) -> <integer greater than 0>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -25982,7 +26109,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:status -> <string>, :message -> <string>, :task_id -> <integer greater than 0>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -26956,7 +27083,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Schema for a support access grant object in API responses.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -27024,7 +27151,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Schema for GET /api/ee/support-access-grants response (paginated list).",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -27050,7 +27177,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Schema for GET /api/ee/support-access-grants/current response.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -27085,7 +27212,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Schema for a support access grant object in API responses.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -27111,7 +27238,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:id -> <value must be an integer greater than zero.>, :name -> <value must be a non-blank string.>, :slug -> <invalid slug>, :is_active -> <value must be a valid boolean string ('true' or 'false').>, :member_count -> <value must be an integer.>, :attributes -> <nullable map from <string> to <string>>, :tenant_collection_id -> <value must be an integer greater than zero.>} with no other keys",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -27214,7 +27341,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:data -> <sequence of map where {:id -> <value must be an integer greater than zero.>, :name -> <value must be a non-blank string.>, :slug -> <invalid slug>, :is_active -> <value must be a valid boolean string ('true' or 'false').>, :member_count -> <value must be an integer.>, :attributes -> <nullable map from <string> to <string>>, :tenant_collection_id -> <value must be an integer greater than zero.>} with no other keys>} with no other keys",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -27299,7 +27426,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:id -> <value must be an integer greater than zero.>, :name -> <value must be a non-blank string.>, :slug -> <invalid slug>, :is_active -> <value must be a valid boolean string ('true' or 'false').>, :member_count -> <value must be an integer.>, :attributes -> <nullable map from <string> to <string>>, :tenant_collection_id -> <value must be an integer greater than zero.>} with no other keys",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -27407,7 +27534,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:id -> <value must be an integer greater than zero.>, :name -> <value must be a non-blank string.>, :slug -> <invalid slug>, :is_active -> <value must be a valid boolean string ('true' or 'false').>, :member_count -> <value must be an integer.>, :attributes -> <nullable map from <string> to <string>>, :tenant_collection_id -> <value must be an integer greater than zero.>} with no other keys",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -27977,18 +28104,18 @@
"schema" : {
"type" : "object",
"properties" : {
- "collection_id" : {
+ "owner_email" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "owner_user_id" : {
"oneOf" : [ {
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
@@ -27996,12 +28123,6 @@
"name" : {
"type" : "string"
},
- "run_trigger" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.api.run-trigger"
- },
- "source" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-source"
- },
"tag_ids" : {
"type" : "array",
"items" : {
@@ -28010,8 +28131,30 @@
"minimum" : 1
}
},
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-source"
+ },
"target" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-target"
+ },
+ "run_trigger" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms.api.run-trigger"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
"required" : [ "name", "source", "target" ]
@@ -28025,11 +28168,31 @@
"/api/ee/transform/extract-columns" : {
"post" : {
"summary" : "POST /api/ee/transform/extract-columns",
- "description" : "Extract column names from an MBQL query without executing it.\n\n Compiles the query to native SQL using [[qp.compile/compile-with-inline-parameters]],\n which handles parameterized queries with template tags. Then extracts column names\n using PreparedStatement metadata.\n\n Returns a map with a :columns key containing a vector of column names (strings).\n If extraction fails, returns nil for :columns.",
+ "description" : "Extract column names suitable for incremental transform checkpoint filtering.\n\n This endpoint is specifically for populating the checkpoint column dropdown in\n incremental transforms. It only returns columns with types supported for checkpoint\n filtering: temporal (timestamp/tz) and numeric (int/float) types.\n\n Text, boolean, and other unsupported column types are filtered out.\n\n The query is compiled to native SQL using [[qp.compile/compile-with-inline-parameters]],\n which handles parameterized queries with template tags. Then extracts column names\n and types using PreparedStatement metadata.\n\n Returns a map with a :columns key containing a vector of column names (strings).\n If extraction fails, returns nil for :columns.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "columns" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -28268,18 +28431,18 @@
"schema" : {
"type" : "object",
"properties" : {
- "collection_id" : {
+ "owner_email" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "owner_user_id" : {
"oneOf" : [ {
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
@@ -28287,12 +28450,6 @@
"name" : {
"type" : "string"
},
- "run_trigger" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.api.run-trigger"
- },
- "source" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-source"
- },
"tag_ids" : {
"type" : "array",
"items" : {
@@ -28301,8 +28458,30 @@
"minimum" : 1
}
},
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-source"
+ },
"target" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-target"
+ },
+ "run_trigger" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms.api.run-trigger"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}
}
@@ -28525,7 +28704,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:logs -> <string>, :error (optional) -> <map where {:message -> <function, or function>}>, :output (optional) -> <map where {:cols -> <sequence of map where {:name -> <string>}>, :rows -> <sequence of anything>}>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -30427,7 +30606,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "sequence of map where {:id -> <keyword>, :display_name -> <string>, :loggers -> <sequence of map where {:name -> <string>, :level -> <enum of :off, :fatal, :error, :warn, :info, :debug, :trace>}>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -30499,7 +30678,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Schema for a Measure entity as returned from the API.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -30556,7 +30735,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "sequence of Schema for a Measure entity as returned from the API.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -30594,7 +30773,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Schema for a Measure entity as returned from the API.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -30627,7 +30806,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Schema for a Measure entity as returned from the API.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -32729,7 +32908,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:has_more_values -> <boolean>, :values -> <sequence of vector with exactly 2 items of type: anything, string, or vector with exactly 1 items of type: anything>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -36898,7 +37077,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:success -> <must equal true>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -37236,7 +37415,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:total -> <value must be an integer greater or equal to than zero.>, :limit -> <nullable value must be an integer greater than zero.>, :offset -> <nullable value must be an integer greater or equal to than zero.>, :data -> <sequence of map where {:id -> <value must be an integer greater than zero.>, :run_type -> <enum of :alert, :sync, :fingerprint, :subscription>, :entity_type -> <enum of :dashboard, :card, :database>, :entity_id -> <value must be an integer greater than zero.>, :started_at -> <anything>, :ended_at -> <nullable anything>, :status -> <enum of :started, :success, :failed, :abandoned>, :entity_name (optional) -> <nullable string>, :task_count (optional) -> <integer>, :success_count (optional) -> <integer>, :failed_count (optional) -> <integer>}>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -37270,7 +37449,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "sequence of map where {:entity_type -> <enum of :dashboard, :card, :database>, :entity_id -> <value must be an integer greater than zero.>, :entity_name (optional) -> <nullable string>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -37308,7 +37487,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:id -> <value must be an integer greater than zero.>, :run_type -> <enum of :alert, :sync, :fingerprint, :subscription>, :entity_type -> <enum of :dashboard, :card, :database>, :entity_id -> <value must be an integer greater than zero.>, :started_at -> <anything>, :ended_at -> <nullable anything>, :status -> <enum of :started, :success, :failed, :abandoned>, :entity_name (optional) -> <nullable string>, :task_count (optional) -> <integer>, :success_count (optional) -> <integer>, :failed_count (optional) -> <integer>, :tasks -> <sequence of map where {:id -> <value must be an integer greater than zero.>, :task -> <string>, :started_at -> <anything>, :ended_at -> <nullable anything>, :duration -> <nullable integer>, :status -> <enum of :started, :success, :failed, :unknown>, :task_details (optional) -> <nullable map>, :run_id (optional) -> <nullable value must be an integer greater than zero.>, :logs (optional) -> <nullable anything>}>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -37846,7 +38025,7 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "map where {:id -> <integer greater than 0>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -37939,7 +38118,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "sequence of map where {:id -> <integer greater than 0>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
@@ -38101,7 +38280,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "map where {:id -> <integer greater than 0>}",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {