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

github-automation-metabase17bca77f063d
diff --git a/docs/api.json b/docs/api.json
index 8f2170a63c5..c30c11f55f4 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -5489,6 +5489,510 @@
"metabase-enterprise.support-access-grants.schema.timestamp" : {
"anyOf" : [ { }, { } ]
},
+ "metabase-enterprise.transforms-inspector.schema.alert-trigger" : {
+ "description" : "Definition for conditional alerts.\n FE evaluates condition against card results and shows alert if triggered.",
+ "type" : "object",
+ "properties" : {
+ "condition" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-condition"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "message" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
+ },
+ "severity" : {
+ "type" : "string",
+ "enum" : [ "info", "warning", "error" ]
+ }
+ },
+ "required" : [ "id", "condition", "severity", "message" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.card" : {
+ "description" : "A visualization card in the inspector output.\n\n Cards are generic - lens-specific data goes in :metadata.\n The :metadata map is opaque to the core but interpreted by\n lens-specific lib utilities on the frontend. ",
+ "type" : "object",
+ "properties" : {
+ "dataset_query" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.query"
+ },
+ "display" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.display-type"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.card-metadata"
+ },
+ "section_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "title" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "title", "display", "dataset_query" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.card-metadata" : {
+ "description" : "Common metadata for join-related cards and triggers.",
+ "type" : "object",
+ "properties" : {
+ "dedup_key" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.dedup-key"
+ },
+ "group_id" : {
+ "type" : "string"
+ },
+ "group_order" : {
+ "type" : "integer"
+ },
+ "card_type" : {
+ "type" : "string"
+ },
+ "group_role" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.group-role"
+ },
+ "join_step" : {
+ "type" : "integer"
+ },
+ "join_alias" : {
+ "type" : "string"
+ },
+ "join_strategy" : {
+ "type" : "string"
+ },
+ "depends_on_cards" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ }
+ }
+ },
+ "metabase-enterprise.transforms-inspector.schema.complexity" : {
+ "description" : "Complexity estimate for a lens.",
+ "type" : "object",
+ "properties" : {
+ "level" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity-level"
+ },
+ "score" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "level" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.complexity-level" : {
+ "description" : "Estimated complexity/cost of generating a lens.",
+ "type" : "string",
+ "enum" : [ "fast", "slow", "very-slow" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.dedup-key" : {
+ "description" : "Key for deduplicating identical queries across lenses.\n Typically a vector like [:table_count table-id].",
+ "type" : "array",
+ "items" : { }
+ },
+ "metabase-enterprise.transforms-inspector.schema.discovery-response" : {
+ "description" : "Response from lens discovery.",
+ "type" : "object",
+ "properties" : {
+ "available_lenses" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-metadata"
+ }
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "sources" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.table"
+ }
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.inspector-status"
+ },
+ "target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visited_fields" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.visited-fields"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name", "status", "sources", "available_lenses" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.display-type" : {
+ "description" : "Valid display types for cards.",
+ "type" : "string",
+ "enum" : [ "bar", "row", "line", "area", "pie", "scalar", "gauge", "progress", "table", "hidden" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.drill-lens" : {
+ "description" : "A drill-down lens available from the current lens.",
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "display_name" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.drill-lens-trigger" : {
+ "description" : "Definition for conditional drill lens availability.\n FE evaluates condition and shows drill lens option if triggered.\n :params is passed to the drill lens when triggered.",
+ "type" : "object",
+ "properties" : {
+ "condition" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-condition"
+ },
+ "lens_id" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
+ },
+ "params" : {
+ "type" : "object",
+ "additionalProperties" : { }
+ },
+ "reason" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "lens_id", "condition" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.field" : {
+ "description" : "Field metadata for inspector.",
+ "type" : "object",
+ "properties" : {
+ "base_type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "stats" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.field-stats"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "base_type" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.field-stats" : {
+ "description" : "Statistics for a field from fingerprints.",
+ "type" : "object",
+ "properties" : {
+ "min" : {
+ "type" : "number"
+ },
+ "earliest" : {
+ "type" : "string"
+ },
+ "q1" : {
+ "type" : "number"
+ },
+ "max" : {
+ "type" : "number"
+ },
+ "distinct_count" : {
+ "type" : "integer"
+ },
+ "nil_percent" : {
+ "type" : "number"
+ },
+ "avg" : {
+ "type" : "number"
+ },
+ "latest" : {
+ "type" : "string"
+ },
+ "q3" : {
+ "type" : "number"
+ }
+ }
+ },
+ "metabase-enterprise.transforms-inspector.schema.group-role" : {
+ "description" : "Role of a card within a comparison group.",
+ "type" : "string",
+ "enum" : [ "input", "output" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.inspector-status" : {
+ "description" : "Status of the inspector result.",
+ "type" : "string",
+ "enum" : [ "not-run", "ready" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.layout-type" : {
+ "description" : "Layout hints for sections.\n - :flat - cards displayed in a grid\n - :comparison - cards grouped for side-by-side comparison",
+ "type" : "string",
+ "enum" : [ "flat", "comparison" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.lens" : {
+ "description" : "Full lens contents and drill lens/alert triggers.",
+ "type" : "object",
+ "properties" : {
+ "complexity" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity"
+ },
+ "sections" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.section"
+ }
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "summary" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-summary"
+ },
+ "alert_triggers" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.alert-trigger"
+ }
+ },
+ "drill_lenses" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.drill-lens"
+ }
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "drill_lens_triggers" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.drill-lens-trigger"
+ }
+ },
+ "cards" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.card"
+ }
+ }
+ },
+ "required" : [ "id", "display_name", "sections", "cards" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.lens-metadata" : {
+ "type" : "object",
+ "properties" : {
+ "complexity" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "display_name" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.lens-summary" : {
+ "description" : "Summary section of a lens.",
+ "type" : "object",
+ "properties" : {
+ "alerts" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "highlights" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.summary-highlight"
+ }
+ },
+ "text" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ },
+ "metabase-enterprise.transforms-inspector.schema.section" : {
+ "description" : "A section grouping cards in a lens.",
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "layout" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.layout-type"
+ },
+ "title" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "title" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.summary-highlight" : {
+ "description" : "A highlight in the lens summary.",
+ "type" : "object",
+ "properties" : {
+ "card_id" : {
+ "type" : "string"
+ },
+ "label" : {
+ "type" : "string"
+ },
+ "value" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "label" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.table" : {
+ "description" : "Table metadata.",
+ "type" : "object",
+ "properties" : {
+ "column_count" : {
+ "type" : "integer"
+ },
+ "db_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "fields" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.field"
+ }
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "table_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_id", "table_name", "db_id", "column_count", "fields" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.trigger-condition" : {
+ "description" : "A named condition that triggers an alert or drill lens.\n Evaluated by multimethod in lib against card results.\n Only :name is required; other keys are condition-specific.",
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.trigger-metadata" : {
+ "description" : "Common metadata for join-related cards and triggers.",
+ "type" : "object",
+ "properties" : {
+ "join_alias" : {
+ "type" : "string"
+ },
+ "join_step" : {
+ "type" : "integer"
+ },
+ "join_strategy" : {
+ "type" : "string"
+ }
+ }
+ },
+ "metabase-enterprise.transforms-inspector.schema.visited-fields" : {
+ "description" : "Field IDs used in semantically important query clauses.\n Used for interestingness scoring and preselection.",
+ "type" : "object",
+ "properties" : {
+ "all" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "uniqueItems" : true
+ }
+ }
+ },
"metabase-enterprise.workspaces.types.ancestors-result" : {
"description" : "Result of running stale ancestor transforms.",
"type" : "object",
@@ -7411,6 +7915,9 @@
"type" : "null"
} ]
},
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "type" : "boolean"
+ },
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
@@ -7481,6 +7988,9 @@
"type" : "null"
} ]
},
+ "qp/native-sandbox-column.force-coercion-strategy" : {
+ "type" : "string"
+ },
"lib/binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
@@ -9147,6 +9657,9 @@
"display_name" : {
"type" : "string"
},
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "type" : "boolean"
+ },
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
@@ -9248,6 +9761,9 @@
"type" : "null"
} ]
},
+ "qp/native-sandbox-column.force-coercion-strategy" : {
+ "type" : "string"
+ },
"lib/binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
@@ -11207,6 +11723,9 @@
"type" : "null"
} ]
},
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "type" : "boolean"
+ },
"has-field-values" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
@@ -11252,6 +11771,9 @@
"type" : "null"
} ]
},
+ "qp/native-sandbox-column.force-coercion-strategy" : {
+ "type" : "string"
+ },
"lib/binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
@@ -11711,6 +12233,9 @@
"type" : "null"
} ]
},
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "type" : "boolean"
+ },
"has-field-values" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
@@ -11756,6 +12281,9 @@
"type" : "null"
} ]
},
+ "qp/native-sandbox-column.force-coercion-strategy" : {
+ "type" : "string"
+ },
"lib/binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
@@ -15172,510 +15700,6 @@
},
"required" : [ "alias", "database_id", "schema" ]
},
- "metabase.transforms-inspector.schema.alert-trigger" : {
- "description" : "Definition for conditional alerts.\n FE evaluates condition against card results and shows alert if triggered.",
- "type" : "object",
- "properties" : {
- "condition" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-condition"
- },
- "id" : {
- "type" : "string"
- },
- "message" : {
- "type" : "string"
- },
- "metadata" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-metadata"
- },
- "severity" : {
- "type" : "string",
- "enum" : [ "info", "warning", "error" ]
- }
- },
- "required" : [ "id", "condition", "severity", "message" ]
- },
- "metabase.transforms-inspector.schema.card" : {
- "description" : "A visualization card in the inspector output.\n\n Cards are generic - lens-specific data goes in :metadata.\n The :metadata map is opaque to the core but interpreted by\n lens-specific lib utilities on the frontend. ",
- "type" : "object",
- "properties" : {
- "dataset_query" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.query"
- },
- "display" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.display-type"
- },
- "id" : {
- "type" : "string"
- },
- "metadata" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.card-metadata"
- },
- "section_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "title" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "title", "display", "dataset_query" ]
- },
- "metabase.transforms-inspector.schema.card-metadata" : {
- "description" : "Common metadata for join-related cards and triggers.",
- "type" : "object",
- "properties" : {
- "dedup_key" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.dedup-key"
- },
- "group_id" : {
- "type" : "string"
- },
- "group_order" : {
- "type" : "integer"
- },
- "card_type" : {
- "type" : "string"
- },
- "group_role" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.group-role"
- },
- "join_step" : {
- "type" : "integer"
- },
- "join_alias" : {
- "type" : "string"
- },
- "join_strategy" : {
- "type" : "string"
- },
- "depends_on_cards" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- }
- }
- },
- "metabase.transforms-inspector.schema.complexity" : {
- "description" : "Complexity estimate for a lens.",
- "type" : "object",
- "properties" : {
- "level" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.complexity-level"
- },
- "score" : {
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "level" ]
- },
- "metabase.transforms-inspector.schema.complexity-level" : {
- "description" : "Estimated complexity/cost of generating a lens.",
- "type" : "string",
- "enum" : [ "fast", "slow", "very-slow" ]
- },
- "metabase.transforms-inspector.schema.dedup-key" : {
- "description" : "Key for deduplicating identical queries across lenses.\n Typically a vector like [:table_count table-id].",
- "type" : "array",
- "items" : { }
- },
- "metabase.transforms-inspector.schema.discovery-response" : {
- "description" : "Response from lens discovery.",
- "type" : "object",
- "properties" : {
- "available_lenses" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.lens-metadata"
- }
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "sources" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.table"
- }
- },
- "status" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.inspector-status"
- },
- "target" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.table"
- }, {
- "type" : "null"
- } ]
- },
- "visited_fields" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.visited-fields"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "name", "status", "sources", "available_lenses" ]
- },
- "metabase.transforms-inspector.schema.display-type" : {
- "description" : "Valid display types for cards.",
- "type" : "string",
- "enum" : [ "bar", "row", "line", "area", "pie", "scalar", "gauge", "progress", "table", "hidden" ]
- },
- "metabase.transforms-inspector.schema.drill-lens" : {
- "description" : "A drill-down lens available from the current lens.",
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
- "type" : "string"
- },
- "id" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "display_name" ]
- },
- "metabase.transforms-inspector.schema.drill-lens-trigger" : {
- "description" : "Definition for conditional drill lens availability.\n FE evaluates condition and shows drill lens option if triggered.\n :params is passed to the drill lens when triggered.",
- "type" : "object",
- "properties" : {
- "condition" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-condition"
- },
- "lens_id" : {
- "type" : "string"
- },
- "metadata" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-metadata"
- },
- "params" : {
- "type" : "object",
- "additionalProperties" : { }
- },
- "reason" : {
- "type" : "string"
- }
- },
- "required" : [ "lens_id", "condition" ]
- },
- "metabase.transforms-inspector.schema.field" : {
- "description" : "Field metadata for inspector.",
- "type" : "object",
- "properties" : {
- "base_type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "display_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string"
- },
- "semantic_type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
- },
- "stats" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.field-stats"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "name", "base_type" ]
- },
- "metabase.transforms-inspector.schema.field-stats" : {
- "description" : "Statistics for a field from fingerprints.",
- "type" : "object",
- "properties" : {
- "min" : {
- "type" : "number"
- },
- "earliest" : {
- "type" : "string"
- },
- "q1" : {
- "type" : "number"
- },
- "max" : {
- "type" : "number"
- },
- "distinct_count" : {
- "type" : "integer"
- },
- "nil_percent" : {
- "type" : "number"
- },
- "avg" : {
- "type" : "number"
- },
- "latest" : {
- "type" : "string"
- },
- "q3" : {
- "type" : "number"
- }
- }
- },
- "metabase.transforms-inspector.schema.group-role" : {
- "description" : "Role of a card within a comparison group.",
- "type" : "string",
- "enum" : [ "input", "output" ]
- },
- "metabase.transforms-inspector.schema.inspector-status" : {
- "description" : "Status of the inspector result.",
- "type" : "string",
- "enum" : [ "not-run", "ready" ]
- },
- "metabase.transforms-inspector.schema.layout-type" : {
- "description" : "Layout hints for sections.\n - :flat - cards displayed in a grid\n - :comparison - cards grouped for side-by-side comparison",
- "type" : "string",
- "enum" : [ "flat", "comparison" ]
- },
- "metabase.transforms-inspector.schema.lens" : {
- "description" : "Full lens contents and drill lens/alert triggers.",
- "type" : "object",
- "properties" : {
- "complexity" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.complexity"
- },
- "sections" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.section"
- }
- },
- "id" : {
- "type" : "string"
- },
- "summary" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.lens-summary"
- },
- "alert_triggers" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.alert-trigger"
- }
- },
- "drill_lenses" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.drill-lens"
- }
- },
- "display_name" : {
- "type" : "string"
- },
- "drill_lens_triggers" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.drill-lens-trigger"
- }
- },
- "cards" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.card"
- }
- }
- },
- "required" : [ "id", "display_name", "sections", "cards" ]
- },
- "metabase.transforms-inspector.schema.lens-metadata" : {
- "type" : "object",
- "properties" : {
- "complexity" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.complexity"
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
- "type" : "string"
- },
- "id" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "display_name" ]
- },
- "metabase.transforms-inspector.schema.lens-summary" : {
- "description" : "Summary section of a lens.",
- "type" : "object",
- "properties" : {
- "alerts" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
- },
- "highlights" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.summary-highlight"
- }
- },
- "text" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }
- },
- "metabase.transforms-inspector.schema.section" : {
- "description" : "A section grouping cards in a lens.",
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "string"
- },
- "layout" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.layout-type"
- },
- "title" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "title" ]
- },
- "metabase.transforms-inspector.schema.summary-highlight" : {
- "description" : "A highlight in the lens summary.",
- "type" : "object",
- "properties" : {
- "card_id" : {
- "type" : "string"
- },
- "label" : {
- "type" : "string"
- },
- "value" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "label" ]
- },
- "metabase.transforms-inspector.schema.table" : {
- "description" : "Table metadata.",
- "type" : "object",
- "properties" : {
- "column_count" : {
- "type" : "integer"
- },
- "db_id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "fields" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.field"
- }
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "table_id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "table_name" : {
- "type" : "string"
- }
- },
- "required" : [ "table_id", "table_name", "db_id", "column_count", "fields" ]
- },
- "metabase.transforms-inspector.schema.trigger-condition" : {
- "description" : "A named condition that triggers an alert or drill lens.\n Evaluated by multimethod in lib against card results.\n Only :name is required; other keys are condition-specific.",
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "name" ]
- },
- "metabase.transforms-inspector.schema.trigger-metadata" : {
- "description" : "Common metadata for join-related cards and triggers.",
- "type" : "object",
- "properties" : {
- "join_alias" : {
- "type" : "string"
- },
- "join_step" : {
- "type" : "integer"
- },
- "join_strategy" : {
- "type" : "string"
- }
- }
- },
- "metabase.transforms-inspector.schema.visited-fields" : {
- "description" : "Field IDs used in semantically important query clauses.\n Used for interestingness scoring and preselection.",
- "type" : "object",
- "properties" : {
- "all" : {
- "type" : "array",
- "items" : {
- "type" : "integer",
- "minimum" : 1
- },
- "uniqueItems" : true
- }
- }
- },
"metabase.transforms-rest.api.transform.run-trigger" : {
"type" : "string",
"enum" : [ "none", "global-schedule" ]
@@ -15979,8 +16003,8 @@
"ApiKeyAuth" : {
"type" : "apiKey",
"in" : "header",
- "name" : "X-Metabase-Session",
- "description" : "Session token obtained from /api/session endpoint"
+ "name" : "X-API-Key",
+ "description" : "API key for authentication"
}
}
},
@@ -22507,9 +22531,6 @@
"content" : {
"type" : "object"
},
- "html" : {
- "type" : "string"
- },
"parent_comment_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -22529,7 +22550,7 @@
"enum" : [ "document" ]
}
},
- "required" : [ "target_type", "target_id", "content", "html" ]
+ "required" : [ "target_type", "target_id", "content" ]
}
}
}
@@ -22592,9 +22613,6 @@
"content" : {
"type" : "object"
},
- "html" : {
- "type" : "string"
- },
"is_resolved" : {
"type" : "boolean"
}
@@ -34130,6 +34148,162 @@
"tags" : [ "/api/ee/transforms-python" ]
}
},
+ "/api/ee/transforms/{id}/inspect" : {
+ "get" : {
+ "operationId" : "get-api-ee-transforms-id-inspect",
+ "summary" : "GET /api/ee/transforms/{id}/inspect",
+ "description" : "Phase 1: Discover available lenses for a transform.\n Returns structural metadata and available lens types.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "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" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.discovery-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/transforms" ]
+ }
+ },
+ "/api/ee/transforms/{id}/inspect/{lens-id}" : {
+ "get" : {
+ "operationId" : "get-api-ee-transforms-id-inspect-lens-id",
+ "summary" : "GET /api/ee/transforms/{id}/inspect/{lens-id}",
+ "description" : "Phase 2: Get full lens contents for a transform.\n Returns sections, cards with dataset_query, and trigger definitions.\n Accepts optional params for drill lenses as query params.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "lens-id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/transforms" ]
+ }
+ },
+ "/api/ee/transforms/{id}/inspect/{lens-id}/query" : {
+ "post" : {
+ "operationId" : "post-api-ee-transforms-id-inspect-lens-id-query",
+ "summary" : "POST /api/ee/transforms/{id}/inspect/{lens-id}/query",
+ "description" : "Execute a query in the context of a transform inspector lens.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "lens-id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "lens_params" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "query" : {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ },
+ "required" : [ "query" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/transforms" ]
+ }
+ },
"/api/ee/upload-management/tables" : {
"get" : {
"operationId" : "get-api-ee-upload-management-tables",
@@ -35823,6 +35997,13 @@
"type" : "null"
} ]
},
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
"type" : {
"type" : "string",
"enum" : [ "table" ]
@@ -36281,6 +36462,13 @@
"type" : "null"
} ]
},
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
"type" : {
"type" : "string",
"enum" : [ "table" ]
@@ -45595,6 +45783,17 @@
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "include-transform-targets",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -50985,162 +51184,6 @@
"tags" : [ "/api/transform" ]
}
},
- "/api/transform/{id}/inspect" : {
- "get" : {
- "operationId" : "get-api-transform-id-inspect",
- "summary" : "GET /api/transform/{id}/inspect",
- "description" : "Phase 1: Discover available lenses for a transform.\n Returns structural metadata and available lens types.",
- "parameters" : [ {
- "in" : "path",
- "name" : "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" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.discovery-response"
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/transform" ]
- }
- },
- "/api/transform/{id}/inspect/{lens-id}" : {
- "get" : {
- "operationId" : "get-api-transform-id-inspect-lens-id",
- "summary" : "GET /api/transform/{id}/inspect/{lens-id}",
- "description" : "Phase 2: Get full lens contents for a transform.\n Returns sections, cards with dataset_query, and trigger definitions.\n Accepts optional params for drill lenses as query params.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "lens-id",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.lens"
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/transform" ]
- }
- },
- "/api/transform/{id}/inspect/{lens-id}/query" : {
- "post" : {
- "operationId" : "post-api-transform-id-inspect-lens-id-query",
- "summary" : "POST /api/transform/{id}/inspect/{lens-id}/query",
- "description" : "Execute a query in the context of a transform inspector lens.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "lens-id",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "lens_params" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "query" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }
- }
- },
- "required" : [ "query" ]
- }
- }
- }
- },
- "tags" : [ "/api/transform" ]
- }
- },
"/api/transform/{id}/merge-history" : {
"get" : {
"operationId" : "get-api-transform-id-merge-history",
@@ -52041,6 +52084,48 @@
"tags" : [ "/api/user" ]
}
},
+ "/api/user/{id}/password-reset-url" : {
+ "post" : {
+ "operationId" : "post-api-user-id-password-reset-url",
+ "summary" : "POST /api/user/{id}/password-reset-url",
+ "description" : "Generate a password reset URL for a user. Admins can share this URL directly with the user.\n The link expires in 48 hours.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "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" : {
+ "password_reset_url" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "password_reset_url" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/user" ]
+ }
+ },
"/api/user/{id}/reactivate" : {
"put" : {
"operationId" : "put-api-user-id-reactivate",