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

github-automation-metabased994a365f720
diff --git a/docs/api.json b/docs/api.json
index efb0f3a96e0..b5823836097 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -3131,133 +3131,476 @@
"metabase-enterprise.support-access-grants.schema.timestamp" : {
"anyOf" : [ { }, { } ]
},
- "metabase-enterprise.transforms-inspector.schema..lens-params.request" : {
- "description" : "[[::lens-params]] as the FE echoes them back to the lens endpoints.",
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-params"
- },
- "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"
+ "metabase-enterprise.transform-testing.expectations.empty.result" : {
+ "description" : "What an `empty` expectation found.\n\n A pass carries nothing beyond the shared keys. A failure adds the rows the query returned as\n `:sample`, with `:columns` describing them; the sample is capped, and `:truncated` is how many\n rows that cap dropped.",
+ "oneOf" : [ {
+ "description" : "What every expectation result carries: which expectation this is, and how it came out.\n\n A `:status` of `error` means this one expectation could not be evaluated while the rest of the\n run still reported; `:error` then says why, and nothing else is reported for it.",
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
+ }
+ },
+ "error" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "message" ],
+ "additionalProperties" : false
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
+ },
+ "type" : {
+ "const" : "empty"
+ }
},
- "message" : {
- "type" : "string"
+ "required" : [ "name", "type", "status" ],
+ "additionalProperties" : false
+ }, {
+ "description" : "What every expectation result carries: which expectation this is, and how it came out.\n\n A `:status` of `error` means this one expectation could not be evaluated while the rest of the\n run still reported; `:error` then says why, and nothing else is reported for it.",
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
+ }
+ },
+ "error" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "message" ],
+ "additionalProperties" : false
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
+ },
+ "type" : {
+ "const" : "empty"
+ }
},
- "metadata" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
+ "required" : [ "name", "type", "status" ],
+ "additionalProperties" : false
+ }, {
+ "description" : "The rows the query returned, and the columns describing them.",
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
+ }
+ },
+ "error" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "message" ],
+ "additionalProperties" : false
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "sample" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
+ }
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
+ },
+ "truncated" : {
+ "type" : "integer"
+ },
+ "type" : {
+ "const" : "empty"
+ }
},
- "severity" : {
- "type" : "string",
- "enum" : [ "info", "warning", "error" ]
- }
- },
- "required" : [ "id", "condition", "severity", "message" ]
+ "required" : [ "name", "type", "status", "columns", "sample", "truncated" ],
+ "additionalProperties" : false
+ } ]
},
- "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"
+ "metabase-enterprise.transform-testing.expectations.equals.result" : {
+ "description" : "What an `equals` expectation found.\n\n Unless `:status` is `error`, every key is present on a pass as well as a failure:\n `:extra-rows`, `:missing-rows` and `:cell-mismatches` come back empty rather than missing.\n `:row-counts` sets the output's row count against the number of rows the expectation declared.\n `:cell-mismatches` is filled only when exactly one row is missing and exactly one is extra.\n `:extra-rows` and `:missing-rows` are capped; `:truncated` is how many rows that cap dropped.",
+ "oneOf" : [ {
+ "description" : "What every expectation result carries: which expectation this is, and how it came out.\n\n A `:status` of `error` means this one expectation could not be evaluated while the rest of the\n run still reported; `:error` then says why, and nothing else is reported for it.",
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
+ }
+ },
+ "error" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "message" ],
+ "additionalProperties" : false
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
+ },
+ "type" : {
+ "const" : "equals"
+ }
},
- "metadata" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.card-metadata"
+ "required" : [ "name", "type", "status" ],
+ "additionalProperties" : false
+ }, {
+ "description" : "The comparison's findings, reported in full on a pass as well as a failure.",
+ "type" : "object",
+ "properties" : {
+ "truncated" : {
+ "type" : "integer"
+ },
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
+ }
+ },
+ "error" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "message" ],
+ "additionalProperties" : false
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
+ },
+ "extra-rows" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
+ }
+ },
+ "type" : {
+ "const" : "equals"
+ },
+ "missing-rows" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
+ }
+ },
+ "cell-mismatches" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "actual" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "column" : {
+ "type" : "string"
+ },
+ "expected" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "column", "expected", "actual" ],
+ "additionalProperties" : false
+ }
+ },
+ "row-counts" : {
+ "type" : "object",
+ "properties" : {
+ "actual" : {
+ "type" : "integer"
+ },
+ "expected" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "actual", "expected" ],
+ "additionalProperties" : false
+ }
},
- "section_id" : {
- "oneOf" : [ {
+ "required" : [ "name", "type", "status", "columns", "row-counts", "extra-rows", "missing-rows", "cell-mismatches", "truncated" ],
+ "additionalProperties" : false
+ }, {
+ "description" : "The comparison's findings, reported in full on a pass as well as a failure.",
+ "type" : "object",
+ "properties" : {
+ "truncated" : {
+ "type" : "integer"
+ },
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
+ }
+ },
+ "error" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "message" ],
+ "additionalProperties" : false
+ },
+ "name" : {
"type" : "string"
- }, {
- "type" : "null"
- } ]
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
+ },
+ "extra-rows" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
+ }
+ },
+ "type" : {
+ "const" : "equals"
+ },
+ "missing-rows" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
+ }
+ },
+ "cell-mismatches" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "actual" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "column" : {
+ "type" : "string"
+ },
+ "expected" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "column", "expected", "actual" ],
+ "additionalProperties" : false
+ }
+ },
+ "row-counts" : {
+ "type" : "object",
+ "properties" : {
+ "actual" : {
+ "type" : "integer"
+ },
+ "expected" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "actual", "expected" ],
+ "additionalProperties" : false
+ }
},
- "title" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "title", "display", "dataset_query" ]
+ "required" : [ "name", "type", "status", "columns", "row-counts", "extra-rows", "missing-rows", "cell-mismatches", "truncated" ],
+ "additionalProperties" : false
+ } ]
},
- "metabase-enterprise.transforms-inspector.schema.card-metadata" : {
- "description" : "Common metadata for join-related cards and triggers.",
+ "metabase-enterprise.transform-testing.schema..expectation-result.base" : {
+ "description" : "What every expectation result carries: which expectation this is, and how it came out.\n\n A `:status` of `error` means this one expectation could not be evaluated while the rest of the\n run still reported; `:error` then says why, and nothing else is reported for it.",
"type" : "object",
"properties" : {
- "dedup_key" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.dedup-key"
- },
- "group_id" : {
- "type" : "string"
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
+ }
},
- "group_order" : {
- "type" : "integer"
+ "error" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "message" ],
+ "additionalProperties" : false
},
- "card_type" : {
+ "name" : {
"type" : "string"
},
- "group_role" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.group-role"
- },
- "join_step" : {
- "type" : "integer"
- },
- "join_alias" : {
- "type" : "string"
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
},
- "join_strategy" : {
+ "type" : {
"type" : "string"
- },
- "depends_on_cards" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
}
- }
+ },
+ "required" : [ "name", "type", "status" ],
+ "additionalProperties" : false
},
- "metabase-enterprise.transforms-inspector.schema.complexity" : {
- "description" : "Complexity estimate for a lens.",
+ "metabase-enterprise.transform-testing.schema..expectation.empty" : {
+ "description" : "A check that a SQL query over the transform output returns no rows.",
"type" : "object",
"properties" : {
- "level" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity-level"
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "score" : {
- "type" : "integer",
- "minimum" : 1
+ "sql" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "type" : {
+ "const" : "empty"
}
},
- "required" : [ "level" ]
- },
- "metabase-enterprise.transforms-inspector.schema.complexity-level" : {
- "description" : "Estimated complexity/cost of generating a lens.",
- "type" : "string",
- "enum" : [ "fast", "slow", "very-slow" ]
+ "required" : [ "type", "name", "sql" ],
+ "additionalProperties" : false
},
- "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.transform-testing.schema..expectation.equals" : {
+ "description" : "A check that the transform output holds exactly the declared rows, over exactly the declared columns.",
+ "oneOf" : [ {
+ "description" : "Test data returned by a SQL query run against the transform's source database.",
+ "type" : "object",
+ "properties" : {
+ "format" : {
+ "const" : "sql"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "sql" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "type" : {
+ "const" : "equals"
+ }
+ },
+ "required" : [ "type", "name", "format", "sql" ],
+ "additionalProperties" : false
+ }, {
+ "description" : "Test data written out in the request: the columns, with the type each is cast to, and the rows.\n\n A row's keys are the declared column names, exactly: the query reads each row by those names, so a key that names\n no column would be dropped and a column a row leaves out would become a null cell, neither of which the author\n asked for.",
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.column"
+ },
+ "minItems" : 1
+ },
+ "format" : {
+ "const" : "rows"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "rows" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
+ }
+ },
+ "type" : {
+ "const" : "equals"
+ }
+ },
+ "required" : [ "type", "name", "format", "columns", "rows" ],
+ "additionalProperties" : false
+ } ]
},
- "metabase-enterprise.transforms-inspector.schema.discovery-response" : {
- "description" : "Response from lens discovery.",
+ "metabase-enterprise.transform-testing.schema..transform-test.create" : {
+ "description" : "What a client sends to create a transform test.",
"type" : "object",
"properties" : {
- "available_lenses" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-metadata"
- }
- },
"description" : {
"oneOf" : [ {
"type" : "string"
@@ -3265,42 +3608,24 @@
"type" : "null"
} ]
},
- "name" : {
- "type" : "string"
- },
- "sources" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.table"
- }
+ "expectations" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectations"
},
- "status" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.inspector-status"
+ "inputs" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.inputs"
},
- "target" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.table"
- }, {
- "type" : "null"
- } ]
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "visited_fields" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.visited-fields"
- }, {
- "type" : "null"
- } ]
+ "transform_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
}
},
- "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" ]
+ "required" : [ "transform_id", "name", "inputs", "expectations" ],
+ "additionalProperties" : false
},
- "metabase-enterprise.transforms-inspector.schema.drill-lens" : {
- "description" : "A drill-down lens available from the current lens.",
+ "metabase-enterprise.transform-testing.schema..transform-test.update" : {
+ "description" : "What a client sends to update a transform test. Omitted fields are left unchanged.",
"type" : "object",
"properties" : {
"description" : {
@@ -3310,57 +3635,506 @@
"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"
+ "expectations" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectations"
},
- "metadata" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
+ "inputs" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.inputs"
},
- "params" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-params"
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "reason" : {
- "type" : "string"
+ "transform_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
}
},
- "required" : [ "lens_id", "condition" ]
+ "additionalProperties" : false
},
- "metabase-enterprise.transforms-inspector.schema.field" : {
- "description" : "Field metadata for inspector.",
+ "metabase-enterprise.transform-testing.schema.column" : {
+ "description" : "A column of inline test data, with the type its cells are cast to.\n\n A cast target, which on some engines is not a type name the warehouse ever reports: MySQL takes\n `SIGNED` and reports `BIGINT`.",
"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
+ "cast_type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"name" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "name", "cast_type" ],
+ "additionalProperties" : false
+ },
+ "metabase-enterprise.transform-testing.schema.expectation" : {
+ "description" : "A check on the output of the transform under test.",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema..expectation.equals"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema..expectation.empty"
+ } ]
+ },
+ "metabase-enterprise.transform-testing.schema.expectation-result" : {
+ "description" : "What one expectation found. Each type owns the schema of its own result, registered under the key\n named here.",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.expectations.equals.result"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.expectations.empty.result"
+ } ]
+ },
+ "metabase-enterprise.transform-testing.schema.expectations" : {
+ "description" : "The checks run against the transform's output. Names must be unique within a test,\n case-sensitively.",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectation"
+ }
+ },
+ "metabase-enterprise.transform-testing.schema.input" : {
+ "description" : "An input table of the transform under test, replaced with test data.",
+ "oneOf" : [ {
+ "description" : "Test data returned by a SQL query run against the transform's source database.",
+ "type" : "object",
+ "properties" : {
+ "format" : {
+ "const" : "sql"
+ },
+ "sql" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "table" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.table"
+ }
+ },
+ "required" : [ "table", "format", "sql" ],
+ "additionalProperties" : false
+ }, {
+ "description" : "Test data written out in the request: the columns, with the type each is cast to, and the rows.\n\n A row's keys are the declared column names, exactly: the query reads each row by those names, so a key that names\n no column would be dropped and a column a row leaves out would become a null cell, neither of which the author\n asked for.",
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.column"
+ },
+ "minItems" : 1
+ },
+ "format" : {
+ "const" : "rows"
+ },
+ "rows" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
+ }
+ },
+ "table" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.table"
+ }
+ },
+ "required" : [ "table", "format", "columns", "rows" ],
+ "additionalProperties" : false
+ } ]
+ },
+ "metabase-enterprise.transform-testing.schema.inputs" : {
+ "description" : "Test data for the tables the transform reads. Every table it reads needs one, and an input for\n a table it does not read is refused.",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.input"
+ }
+ },
+ "metabase-enterprise.transform-testing.schema.result-column" : {
+ "description" : "A column reported by a test run, with its database native type.",
+ "type" : "object",
+ "properties" : {
+ "database_type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "name", "database_type" ],
+ "additionalProperties" : false
+ },
+ "metabase-enterprise.transform-testing.schema.row" : {
+ "description" : "Value must be a map.",
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "description" : "Value must be a map."
+ } ]
+ },
+ "metabase-enterprise.transform-testing.schema.rows-data" : {
+ "description" : "Test data written out in the request: the columns, with the type each is cast to, and the rows.\n\n A row's keys are the declared column names, exactly: the query reads each row by those names, so a key that names\n no column would be dropped and a column a row leaves out would become a null cell, neither of which the author\n asked for.",
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.column"
+ },
+ "minItems" : 1
+ },
+ "format" : {
+ "const" : "rows"
+ },
+ "rows" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
+ }
+ }
+ },
+ "required" : [ "format", "columns", "rows" ],
+ "additionalProperties" : false
+ },
+ "metabase-enterprise.transform-testing.schema.run-result" : {
+ "description" : "The outcome of a transform test run.\n\n `:tables` maps each temp table the run created to the table it stood in for.",
+ "type" : "object",
+ "properties" : {
+ "expectations" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectation-result"
+ }
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
+ },
+ "tables" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }
+ },
+ "required" : [ "status", "expectations", "tables" ],
+ "additionalProperties" : false
+ },
+ "metabase-enterprise.transform-testing.schema.sql-data" : {
+ "description" : "Test data returned by a SQL query run against the transform's source database.",
+ "type" : "object",
+ "properties" : {
+ "format" : {
+ "const" : "sql"
+ },
+ "sql" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "format", "sql" ],
+ "additionalProperties" : false
+ },
+ "metabase-enterprise.transform-testing.schema.status" : {
+ "description" : "The outcome of a transform test run, or of one of its expectations.\n\n `:error` is an expectation outcome only: that expectation's own query could not be run, while\n the rest of the run completed and still reported.",
+ "type" : "string",
+ "enum" : [ "passed", "failed", "error" ]
+ },
+ "metabase-enterprise.transform-testing.schema.table" : {
+ "description" : "A table read by the transform under test, by schema and name.",
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name" ],
+ "additionalProperties" : false
+ },
+ "metabase-enterprise.transform-testing.schema.transform-test" : {
+ "description" : "A saved transform test: the transform it covers, the inputs that stand in for its source\n tables, and the expectations checked against its output.",
+ "type" : "object",
+ "properties" : {
+ "entity_id" : {
+ "type" : "string"
+ },
+ "expectations" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectations"
+ },
+ "transform_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "updated_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "created_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "inputs" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.inputs"
+ },
+ "creator_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "entity_id", "transform_id", "creator_id", "name", "description", "inputs", "expectations", "created_at", "updated_at" ],
+ "additionalProperties" : false
+ },
+ "metabase-enterprise.transforms-inspector.schema..lens-params.request" : {
+ "description" : "[[::lens-params]] as the FE echoes them back to the lens endpoints.",
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-params"
+ },
+ "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" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-params"
+ },
+ "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" : [ {
@@ -7351,465 +8125,1490 @@
} ]
}
},
- "additionalProperties" : false
- } ]
+ "additionalProperties" : false
+ } ]
+ },
+ "metabase.channel.schema.email-details" : {
+ "description" : "The connection `:details` of a `:channel/email` channel: an optional SMTP host and port, as email is otherwise configured by settings.",
+ "type" : "object",
+ "properties" : {
+ "host" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "port" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ },
+ "metabase.channel.schema.http-details" : {
+ "description" : "The connection `:details` of a `:channel/http` channel.",
+ "type" : "object",
+ "properties" : {
+ "auth-info" : {
+ "description" : "Value must be a map.",
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "Value must be a map."
+ } ]
+ },
+ "auth-method" : {
+ "type" : "string",
+ "enum" : [ "none", "header", "query-param", "request-body" ]
+ },
+ "fe-form-type" : {
+ "type" : "string",
+ "enum" : [ "api-key", "bearer", "basic", "none" ]
+ },
+ "method" : {
+ "type" : "string",
+ "enum" : [ "get", "post", "put" ]
+ },
+ "url" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "required" : [ "url", "auth-method" ],
+ "additionalProperties" : false
+ },
+ "metabase.channel.schema.slack-details" : {
+ "description" : "The connection `:details` of a `:channel/slack` channel.",
+ "type" : "object",
+ "properties" : {
+ "channel" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "channel" ],
+ "additionalProperties" : false
+ },
+ "metabase.collections-rest.api.Collection" : {
+ "description" : "A Collection as the REST API returns it. Deliberately open: which hydrated keys come back varies by endpoint and\n by what the Collection is. `POST /` returns the freshly inserted row with no permission flags; `/root` describes a\n virtual Collection with a string id and none of the database-backed columns; `/tree` nests `:children`. Only `:id`\n and `:name` are present in every case, so only those are required here.",
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.collections-rest.api.CollectionId"
+ },
+ "name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ }
+ },
+ "required" : [ "id", "name" ]
+ },
+ "metabase.collections-rest.api.CollectionId" : {
+ "description" : "A Collection's ID: an integer for a real row, or the string \"root\" for the virtual Root Collection.",
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "string"
+ } ]
+ },
+ "metabase.collections-rest.api.CollectionTreeNode" : {
+ "description" : "A Collection in the `/tree` response. `:children` are nested tree nodes, except under `?shallow=true`, where the\n endpoint returns only the requested level and `:children` degrades to a boolean saying whether any exist.",
+ "type" : "object",
+ "properties" : {
+ "children" : {
+ "anyOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.collections-rest.api.CollectionTreeNode"
+ }
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.collections-rest.api.CollectionId"
+ },
+ "name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ }
+ },
+ "required" : [ "id", "name" ]
+ },
+ "metabase.collections-rest.api.DashboardQuestionCandidate" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "sole_dashboard_info" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "description" ]
+ }
+ },
+ "required" : [ "id", "name", "description", "sole_dashboard_info" ]
+ },
+ "metabase.collections-rest.api.DashboardQuestionCandidatesResponse" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.collections-rest.api.DashboardQuestionCandidate"
+ }
+ },
+ "total" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "data", "total" ]
+ },
+ "metabase.collections-rest.api.ItemsMetadata" : {
+ "type" : "object",
+ "properties" : {
+ "available_models" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "total_items" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }
+ },
+ "required" : [ "available_models", "total_items" ]
+ },
+ "metabase.collections-rest.api.ItemsResponse" : {
+ "description" : "A page of a Collection's items. `:available_models` is present only when the request asked for it, and\n `:limit`/`:offset` are dropped entirely in the `snippets` namespace, which is not paginated.",
+ "type" : "object",
+ "properties" : {
+ "available_models" : {
+ "type" : "array",
+ "items" : { }
+ },
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "limit" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "models" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "offset" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "total" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }
+ },
+ "required" : [ "total", "data", "models" ]
+ },
+ "metabase.collections-rest.api.MoveDashboardQuestionCandidatesResponse" : {
+ "type" : "object",
+ "properties" : {
+ "moved" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "required" : [ "moved" ]
+ },
+ "metabase.collections.schema.CardType" : {
+ "type" : "string",
+ "enum" : [ "model", "question", "metric" ]
+ },
+ "metabase.collections.schema.Collection" : {
+ "type" : "object",
+ "properties" : {
+ "git_sync_enabled" : {
+ "type" : "boolean"
+ },
+ "can_delete" : {
+ "type" : "boolean"
+ },
+ "entity_id" : {
+ "type" : "string"
+ },
+ "authority_level" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_sample" : {
+ "type" : "boolean"
+ },
+ "children" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.Collection"
+ }
+ },
+ "id" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ } ]
+ },
+ "effective_ancestors" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "effective_location" : {
+ "type" : "string"
+ },
+ "is_remote_synced" : {
+ "type" : "boolean"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "slug" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "location" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_write" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionType"
+ },
+ "here" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
+ },
+ "uniqueItems" : true
+ },
+ "parent_id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_restore" : {
+ "type" : "boolean"
+ },
+ "is_personal" : {
+ "type" : "boolean"
+ },
+ "personal_owner_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "below" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
+ }
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "description", "can_write", "can_restore", "can_delete", "archived", "location" ]
+ },
+ "metabase.collections.schema.CollectionItem" : {
+ "type" : "object",
+ "properties" : {
+ "last-edit-info" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.LastEditInfo"
+ },
+ "model" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
+ },
+ "copy" : {
+ "type" : "boolean"
+ },
+ "collection_preview" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_count" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_delete" : {
+ "type" : "boolean"
+ },
+ "entity_id" : {
+ "type" : "string"
+ },
+ "authority_level" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.collections.schema.Collection"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "effective_location" : {
+ "type" : "string"
+ },
+ "fully_parameterized" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "location" : {
+ "type" : "string"
+ },
+ "database_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_write" : {
+ "type" : "boolean"
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "based_on_upload" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "moderated_status" : {
+ "type" : "string"
+ },
+ "type" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionType"
+ }, {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CardType"
+ } ]
+ },
+ "here" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
+ },
+ "uniqueItems" : true
+ },
+ "display" : {
+ "type" : "string"
+ },
+ "can_restore" : {
+ "type" : "boolean"
+ },
+ "personal_owner_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "below" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
+ }
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "description", "archived" ]
+ },
+ "metabase.collections.schema.CollectionItemModel" : {
+ "type" : "string",
+ "enum" : [ "card", "dataset", "metric", "dashboard", "snippet", "collection", "indexed-entity", "indexed-entity", "document", "exploration", "table" ]
+ },
+ "metabase.collections.schema.CollectionType" : {
+ "type" : "string",
+ "enum" : [ "instance-analytics", "trash", "remote-synced", "library", "library-models", "library-metrics" ]
+ },
+ "metabase.collections.schema.LastEditInfo" : {
+ "type" : "object",
+ "properties" : {
+ "email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timestamp" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email", "first_name", "last_name", "timestamp" ]
+ },
+ "metabase.comments.schema..comment.context" : {
+ "description" : "The `:context` column of a Comment, decoded.",
+ "type" : "object",
+ "properties" : {
+ "exploration_query_ids" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "highlight_label" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "maxLength" : 1000
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "highlighted" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.comments.schema..comment.highlight"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timeline_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ },
+ "metabase.comments.schema..comment.highlight" : {
+ "description" : "The chart point a comment is anchored to. Identity only — which column, and which dimension values\n pick out the point — so the client can re-find it in a result set it is separately authorized to\n read.",
+ "type" : "object",
+ "properties" : {
+ "columnName" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dimensions" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "columnName" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "value" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ }
+ },
+ "additionalProperties" : false
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ },
+ "metabase.comments.schema..prose-mirror-node.attrs" : {
+ "description" : "Value must be a map.",
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "description" : "Value must be a map."
+ } ],
+ "type" : "object",
+ "properties" : {
+ "entityId" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "label" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "level" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "model" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ },
+ "metabase.comments.schema.prose-mirror-node" : {
+ "description" : "One node of the ProseMirror/TipTap document a comment is written in, in the shape ProseMirror's `Node.toJSON`\n emits: a `:type`, the children it contains, the marks applied to it, and `:text` on text nodes. Those five keys are\n the whole of the ProseMirror JSON node format; `:attrs` varies by node type. Marks are nodes too as far as this\n schema is concerned -- a mark carries only `:type` and `:attrs`, which is a subset of a node.",
+ "type" : "object",
+ "properties" : {
+ "attrs" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.comments.schema..prose-mirror-node.attrs"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "content" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.comments.schema.prose-mirror-node"
+ }
+ },
+ "marks" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.comments.schema.prose-mirror-node"
+ }
+ },
+ "text" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type" ],
+ "additionalProperties" : false
+ },
+ "metabase.comments.schema.reaction-emoji" : {
+ "description" : "Emoji must be 1 to 10 Unicode code points.",
+ "minLength" : 1,
+ "maxLength" : 10,
+ "type" : "string"
+ },
+ "metabase.data-studio.api.table.bulk-table-info" : {
+ "description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.",
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_published" : {
+ "type" : "boolean"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "db_id", "name", "display_name", "schema", "is_published" ]
+ },
+ "metabase.data-studio.api.table.bulk-table-selection-info" : {
+ "description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",
+ "type" : "object",
+ "properties" : {
+ "published_downstream_tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ }
+ },
+ "selected_table" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "unpublished_upstream_tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ }
+ }
+ },
+ "required" : [ "selected_table", "published_downstream_tables", "unpublished_upstream_tables" ]
+ },
+ "metabase.data-studio.api.table.data-authorities" : {
+ "type" : "string",
+ "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
+ },
+ "metabase.data-studio.api.table.data-layers" : {
+ "type" : "string",
+ "enum" : [ "final", "internal", "hidden" ]
+ },
+ "metabase.data-studio.api.table.data-sources" : {
+ "type" : "string",
+ "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
+ },
+ "metabase.data-studio.api.table.table-selectors" : {
+ "type" : "object",
+ "properties" : {
+ "database_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "schema_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "additionalProperties" : false
},
- "metabase.channel.schema.email-details" : {
- "description" : "The connection `:details` of a `:channel/email` channel: an optional SMTP host and port, as email is otherwise configured by settings.",
+ "metabase.documents.prose-mirror..card-embed.explore-filter" : {
+ "description" : "One explore-further filter `metabase.explorations` snapshots onto a static card embed: the filter as the client\n sent it, plus the name of the dimension it is on. Its `:field_ref` is the legacy `field_ref` of the chart column\n that was clicked.",
"type" : "object",
"properties" : {
- "host" : {
+ "dimension_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "port" : {
+ "display_value" : {
+ "type" : "string"
+ },
+ "field_ref" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..dimension.target"
+ },
+ "operator" : {
+ "type" : "string"
+ },
+ "value" : {
"oneOf" : [ {
- "type" : "integer"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
}, {
"type" : "null"
} ]
+ },
+ "values" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }, {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ } ]
}
},
+ "required" : [ "operator", "field_ref", "display_value" ],
"additionalProperties" : false
},
- "metabase.channel.schema.http-details" : {
- "description" : "The connection `:details` of a `:channel/http` channel.",
+ "metabase.documents.prose-mirror..card-embed.host-data" : {
+ "description" : "What `metabase.explorations` writes under `:host_data` of a static card embed so the frontend can render the\n embed's filter pills and hover highlights without a live lookup.",
"type" : "object",
"properties" : {
- "auth-info" : {
- "description" : "Value must be a map.",
+ "explore_filters" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.documents.prose-mirror..card-embed.explore-filter"
}
}, {
- "description" : "Value must be a map."
+ "type" : "null"
} ]
},
- "auth-method" : {
- "type" : "string",
- "enum" : [ "none", "header", "query-param", "request-body" ]
- },
- "fe-form-type" : {
- "type" : "string",
- "enum" : [ "api-key", "bearer", "basic", "none" ]
- },
- "method" : {
- "type" : "string",
- "enum" : [ "get", "post", "put" ]
- },
- "url" : {
- "description" : "value must be a valid URL."
- }
- },
- "required" : [ "url", "auth-method" ],
- "additionalProperties" : false
- },
- "metabase.channel.schema.slack-details" : {
- "description" : "The connection `:details` of a `:channel/slack` channel.",
- "type" : "object",
- "properties" : {
- "channel" : {
- "type" : "string"
+ "query_ids" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "integer"
+ }
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "channel" ],
"additionalProperties" : false
},
- "metabase.collections-rest.api.Collection" : {
- "description" : "A Collection as the REST API returns it. Deliberately open: which hydrated keys come back varies by endpoint and\n by what the Collection is. `POST /` returns the freshly inserted row with no permission flags; `/root` describes a\n virtual Collection with a string id and none of the database-backed columns; `/tree` nests `:children`. Only `:id`\n and `:name` are present in every case, so only those are required here.",
+ "metabase.documents.prose-mirror..node.attrs" : {
+ "description" : "Value must be a map.",
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "description" : "Value must be a map."
+ } ],
"type" : "object",
"properties" : {
+ "model" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "stored_result_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "label" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"id" : {
- "$ref" : "#/components/schemas/metabase.collections-rest.api.CollectionId"
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "anyOf" : [ {
+ "chart_href" : {
+ "oneOf" : [ {
"type" : "string"
}, {
- "anyOf" : [ { }, { } ]
+ "type" : "null"
+ } ]
+ },
+ "_id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string",
+ "format" : "uuid"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entityId" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "child_target_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "host_data" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.documents.prose-mirror..card-embed.host-data"
+ }, {
+ "type" : "null"
} ]
}
- },
- "required" : [ "id", "name" ]
- },
- "metabase.collections-rest.api.CollectionId" : {
- "description" : "A Collection's ID: an integer for a real row, or the string \"root\" for the virtual Root Collection.",
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "string"
- } ]
+ }
},
- "metabase.collections-rest.api.CollectionTreeNode" : {
- "description" : "A Collection in the `/tree` response. `:children` are nested tree nodes, except under `?shallow=true`, where the\n endpoint returns only the requested level and `:children` degrades to a boolean saying whether any exist.",
+ "metabase.documents.prose-mirror.ast" : {
+ "description" : "Schema for a prose-mirror document AST as it arrives at the API or is read back from the application database: a\n node in the shape ProseMirror's `Node.toJSON` emits, whose children and marks are nodes too.",
"type" : "object",
"properties" : {
- "children" : {
- "anyOf" : [ {
- "type" : "boolean"
+ "attrs" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.documents.prose-mirror..node.attrs"
}, {
+ "type" : "null"
+ } ]
+ },
+ "content" : {
+ "oneOf" : [ {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.collections-rest.api.CollectionTreeNode"
+ "$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
}
+ }, {
+ "type" : "null"
} ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.collections-rest.api.CollectionId"
+ "marks" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "anyOf" : [ {
+ "text" : {
+ "oneOf" : [ {
"type" : "string"
}, {
- "anyOf" : [ { }, { } ]
+ "type" : "null"
} ]
+ },
+ "type" : {
+ "type" : "string"
}
},
- "required" : [ "id", "name" ]
+ "required" : [ "type" ],
+ "additionalProperties" : false
},
- "metabase.collections-rest.api.DashboardQuestionCandidate" : {
+ "metabase.documents.schema..document.id" : {
+ "description" : "Valid Document ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.driver.connection.connection-type" : {
+ "type" : "string",
+ "enum" : [ "default", "write-data", "admin", "transform" ]
+ },
+ "metabase.driver.index-field" : {
+ "description" : "One form field describing how to request an index: the same shape as a [[connection-properties]] descriptor, plus a\n `:columns` type for the indexed columns.",
"type" : "object",
"properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
+ "description" : { },
+ "directions" : {
+ "type" : "boolean"
},
+ "display-name" : { },
"name" : {
"type" : "string"
},
- "sole_dashboard_info" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
+ "options" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "name" : { },
+ "value" : {
"type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
+ }
},
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name", "description" ]
+ "required" : [ "name", "value" ]
+ }
+ },
+ "required" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "string", "boolean", "select", "integer", "columns" ]
}
},
- "required" : [ "id", "name", "description", "sole_dashboard_info" ]
+ "required" : [ "name", "display-name", "type" ]
},
- "metabase.collections-rest.api.DashboardQuestionCandidatesResponse" : {
+ "metabase.driver.index-method" : {
+ "description" : "Metadata for one index kind a driver supports.",
"type" : "object",
"properties" : {
- "data" : {
+ "description" : { },
+ "display-name" : { },
+ "fields" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.collections-rest.api.DashboardQuestionCandidate"
+ "$ref" : "#/components/schemas/metabase.driver.index-field"
}
},
- "total" : {
- "type" : "integer"
+ "lifecycle" : {
+ "type" : "string",
+ "enum" : [ "standalone", "inline" ]
}
},
- "required" : [ "data", "total" ]
+ "required" : [ "display-name", "lifecycle", "fields" ]
},
- "metabase.collections-rest.api.ItemsMetadata" : {
+ "metabase.driver.supported-index-methods" : {
+ "description" : "Return shape of [[supported-index-methods]]: index-kind -> metadata.",
"type" : "object",
- "properties" : {
- "available_models" : {
+ "additionalProperties" : {
+ "$ref" : "#/components/schemas/metabase.driver.index-method"
+ }
+ },
+ "metabase.eid-translation.schema.entity-ids-by-model" : {
+ "description" : "Value must be a map.",
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
+ }
+ }, {
+ "description" : "Value must be a map."
+ } ]
+ },
+ "metabase.embedding-rest.api.theme.EmbeddingTheme" : {
+ "type" : "object",
+ "properties" : {
+ "created_at" : { },
+ "entity_id" : {
+ "type" : "string",
+ "minLength" : 1
},
- "total_items" : {
- "description" : "value must be an integer greater or equal to than zero.",
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
"type" : "integer",
- "minimum" : 0
+ "minimum" : 1
+ },
+ "is_default" : {
+ "type" : "boolean"
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "settings" : {
+ "description" : "Value must be a map.",
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "description" : "Value must be a map."
+ } ]
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "entity_id", "name", "settings", "is_default", "created_at", "updated_at" ]
+ },
+ "metabase.explorations.api.CanceledThread" : {
+ "description" : "Schema for the cancel endpoint response — just the state-bearing fields the FE needs to\n reflect the cancellation. EQ status changes are picked up via the existing `/queries` poll.",
+ "type" : "object",
+ "properties" : {
+ "canceled_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "completed_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}
},
- "required" : [ "available_models", "total_items" ]
+ "required" : [ "id", "canceled_at", "completed_at" ]
},
- "metabase.collections-rest.api.ItemsResponse" : {
- "description" : "A page of a Collection's items. `:available_models` is present only when the request asked for it, and\n `:limit`/`:offset` are dropped entirely in the `snippets` namespace, which is not paginated.",
+ "metabase.explorations.api.DimensionsResponse" : {
+ "description" : "Schema for GET /dimensions: metrics referencing dimensions by id, plus the grouped dimension list.",
"type" : "object",
"properties" : {
- "available_models" : {
+ "dimension_groups" : {
"type" : "array",
- "items" : { }
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationDimensionGroup"
+ }
},
- "data" : {
+ "metrics" : {
"type" : "array",
"items" : {
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationMetric"
}
- },
- "limit" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
- }, {
- "type" : "null"
- } ]
- },
- "models" : {
+ }
+ },
+ "required" : [ "metrics", "dimension_groups" ]
+ },
+ "metabase.explorations.api.ExplorationBlockNode" : {
+ "description" : "A block (the FE's sidebar group): a heading plus its pages. `:name` is the computed heading\n (the metric name). `:position` is the block's 0-indexed authoring slot.",
+ "type" : "object",
+ "properties" : {
+ "explore_filters" : {
"oneOf" : [ {
"type" : "array",
- "items" : { }
+ "items" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "dimension_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_value" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "field_ref" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..dimension.target"
+ },
+ "operator" : {
+ "const" : "="
+ },
+ "value" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "operator", "field_ref", "value", "display_value" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "object",
+ "properties" : {
+ "dimension_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_value" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "field_ref" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..dimension.target"
+ },
+ "operator" : {
+ "const" : "between"
+ },
+ "values" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }, {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ } ]
+ }
+ },
+ "required" : [ "operator", "field_ref", "values", "display_value" ],
+ "additionalProperties" : false
+ } ]
+ }
}, {
"type" : "null"
} ]
},
- "offset" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
"oneOf" : [ {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "total" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
- }
- },
- "required" : [ "total", "data", "models" ]
- },
- "metabase.collections-rest.api.MoveDashboardQuestionCandidatesResponse" : {
- "type" : "object",
- "properties" : {
- "moved" : {
+ "pages" : {
"type" : "array",
"items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationPageNode"
}
+ },
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
}
},
- "required" : [ "moved" ]
+ "required" : [ "id", "name", "position", "pages" ]
},
- "metabase.collections.schema.CardType" : {
- "type" : "string",
- "enum" : [ "model", "question", "metric" ]
- },
- "metabase.collections.schema.Collection" : {
+ "metabase.explorations.api.ExplorationDimensionGroup" : {
+ "description" : "Schema for a dimension group in the /dimensions response. A group bundles together dimensions that\n refer to the same underlying source (same field/binning) so the FE can show a single user-facing\n entry while still tracking the actual per-metric dimensions needed by `start exploration`.",
"type" : "object",
"properties" : {
- "git_sync_enabled" : {
- "type" : "boolean"
- },
- "can_delete" : {
- "type" : "boolean"
- },
- "entity_id" : {
- "type" : "string"
- },
- "authority_level" : {
+ "dimension_interestingness" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "is_sample" : {
- "type" : "boolean"
- },
- "children" : {
+ "dimensions" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.Collection"
+ "$ref" : "#/components/schemas/metabase.metrics.core.dimension"
}
},
- "id" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- } ]
- },
- "effective_ancestors" : {
- "type" : "object",
- "properties" : { }
- },
- "effective_location" : {
+ "name" : {
"type" : "string"
- },
- "is_remote_synced" : {
+ }
+ },
+ "required" : [ "name", "dimension_interestingness", "dimensions" ]
+ },
+ "metabase.explorations.api.ExplorationDocument" : {
+ "description" : "Schema for the Summary document attached to an exploration.",
+ "type" : "object",
+ "properties" : {
+ "is_placeholder" : {
"type" : "boolean"
},
- "name" : {
- "type" : "string"
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "slug" : {
+ "name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
- "location" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "can_write" : {
- "type" : "boolean"
- },
- "type" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionType"
- },
- "here" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
- },
- "uniqueItems" : true
- },
- "parent_id" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- } ]
- }, {
- "type" : "null"
- } ]
+ "updated_at" : {
+ "type" : "string",
+ "format" : "date-time"
},
- "can_restore" : {
- "type" : "boolean"
+ "exploration_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "is_personal" : {
- "type" : "boolean"
+ "created_at" : {
+ "type" : "string",
+ "format" : "date-time"
},
- "personal_owner_id" : {
+ "creator_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
- "below" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
- }
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "content_type" : {
+ "type" : "string"
}
},
- "required" : [ "id", "name", "description", "can_write", "can_restore", "can_delete", "archived", "location" ]
+ "required" : [ "id", "name", "exploration_id", "creator_id", "content_type", "is_placeholder", "created_at", "updated_at" ]
},
- "metabase.collections.schema.CollectionItem" : {
+ "metabase.explorations.api.ExplorationMetric" : {
+ "description" : "Schema for a metric in the /dimensions response: dimensions referenced by id only.",
"type" : "object",
"properties" : {
- "last-edit-info" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.LastEditInfo"
- },
- "model" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
- },
- "copy" : {
- "type" : "boolean"
- },
- "collection_preview" : {
+ "dimension_mappings" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metrics.core.dimension-mapping"
+ }
}, {
"type" : "null"
} ]
},
- "dashboard_count" : {
+ "collection" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ]
}, {
"type" : "null"
} ]
},
- "can_delete" : {
- "type" : "boolean"
- },
- "entity_id" : {
- "type" : "string"
- },
- "authority_level" : {
+ "result_column_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "collection" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.collections.schema.Collection"
- }, {
- "type" : "null"
- } ]
- },
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
- "effective_location" : {
- "type" : "string"
- },
- "fully_parameterized" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
"name" : {
"type" : "string"
},
- "archived" : {
- "type" : "boolean"
- },
- "collection_position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "location" : {
- "type" : "string"
- },
"database_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -7819,59 +9618,11 @@
"type" : "null"
} ]
},
- "can_write" : {
- "type" : "boolean"
- },
- "collection_id" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "based_on_upload" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "moderated_status" : {
- "type" : "string"
- },
- "type" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionType"
- }, {
- "$ref" : "#/components/schemas/metabase.collections.schema.CardType"
- } ]
- },
- "here" : {
+ "dimension_ids" : {
"type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
- },
- "uniqueItems" : true
- },
- "display" : {
- "type" : "string"
- },
- "can_restore" : {
- "type" : "boolean"
+ "items" : { }
},
- "personal_owner_id" : {
+ "collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
@@ -7880,11 +9631,8 @@
"type" : "null"
} ]
},
- "below" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
- }
+ "in_library" : {
+ "type" : "boolean"
},
"description" : {
"oneOf" : [ {
@@ -7894,91 +9642,106 @@
} ]
}
},
- "required" : [ "id", "name", "description", "archived" ]
- },
- "metabase.collections.schema.CollectionItemModel" : {
- "type" : "string",
- "enum" : [ "card", "dataset", "metric", "dashboard", "snippet", "collection", "indexed-entity", "indexed-entity", "document", "exploration", "table" ]
- },
- "metabase.collections.schema.CollectionType" : {
- "type" : "string",
- "enum" : [ "instance-analytics", "trash", "remote-synced", "library", "library-models", "library-metrics" ]
+ "required" : [ "id", "name", "description", "collection_id", "dimension_ids" ]
},
- "metabase.collections.schema.LastEditInfo" : {
+ "metabase.explorations.api.ExplorationPageNode" : {
+ "description" : "A page within a block: the bundle of queries for one (card, dimension, query_type) under the\n page's stable id. `:query_ids` reference queries on the same thread, sorted by interestingness.\n `:position` is the page's 0-indexed slot among its block's pages. `:name` is the page's short,\n heading-relative label (e.g. `By Category over time`); `:long_name` is the full\n self-describing name (e.g. `Number of Orders by Category over time`) for use without the block\n heading for context.",
"type" : "object",
"properties" : {
- "email" : {
+ "hidden" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "long_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "first_name" : {
+ "name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "oneOf" : [ {
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "query_ids" : {
+ "type" : "array",
+ "items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ }
},
- "timestamp" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "starred" : {
+ "type" : "boolean"
}
},
- "required" : [ "id", "email", "first_name", "last_name", "timestamp" ]
+ "required" : [ "id", "name", "long_name", "position", "query_ids", "starred", "hidden" ]
},
- "metabase.comments.schema..comment.context" : {
- "description" : "The `:context` column of a Comment, decoded.",
+ "metabase.explorations.api.ExplorationQueryStreamResponse" : {
+ "description" : "Schema for `GET /query/:id`. On success the body is a streamed dataset (api/csv/json/xlsx),\n so we describe it as `:any`. On a not-yet-done query we return a 409 with a status payload.",
+ "anyOf" : [ { }, {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "object",
+ "properties" : {
+ "error_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "finished_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "started_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "status" ]
+ },
+ "status" : {
+ "const" : 409
+ }
+ },
+ "required" : [ "status", "body" ]
+ } ]
+ },
+ "metabase.explorations.api.ExplorationQuerySummary" : {
+ "description" : "Schema for a query row in API responses. The result blob and `dataset_query` aren't\n asserted here; `interestingness_score`, `contextual_interestingness_score`, and `row_count`\n are batched-hydrated onto each query in `/:id` — the scores from `exploration_query_result`,\n `row_count` from the linked `stored_result` — and may be nil for pending/errored queries or —\n for the contextual score — when the LLM is unconfigured or the thread had no prompt.",
"type" : "object",
"properties" : {
- "exploration_query_ids" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- }, {
- "type" : "null"
- } ]
- },
- "highlight_label" : {
- "oneOf" : [ {
- "type" : "string",
- "maxLength" : 1000
- }, {
- "type" : "null"
- } ]
- },
- "highlighted" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.comments.schema..comment.highlight"
- }, {
- "type" : "null"
- } ]
+ "exploration_thread_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "timeline_id" : {
+ "segment_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
@@ -7986,564 +9749,429 @@
}, {
"type" : "null"
} ]
- }
- },
- "additionalProperties" : false
- },
- "metabase.comments.schema..comment.highlight" : {
- "description" : "The chart point a comment is anchored to. Identity only — which column, and which dimension values\n pick out the point — so the client can re-find it in a result set it is separately authorized to\n read.",
- "type" : "object",
- "properties" : {
- "columnName" : {
+ },
+ "dimension_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "dimensions" : {
+ "row_count" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "columnName" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "value" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- }
- },
- "additionalProperties" : false
- }
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
}, {
"type" : "null"
} ]
- }
- },
- "additionalProperties" : false
- },
- "metabase.comments.schema..prose-mirror-node.attrs" : {
- "description" : "Value must be a map.",
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
- }, {
- "description" : "Value must be a map."
- } ],
- "type" : "object",
- "properties" : {
- "entityId" : {
+ },
+ "contextual_interestingness_score" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "string"
- } ]
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "label" : {
+ "entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "level" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "model" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }
- },
- "metabase.comments.schema.prose-mirror-node" : {
- "description" : "One node of the ProseMirror/TipTap document a comment is written in, in the shape ProseMirror's `Node.toJSON`\n emits: a `:type`, the children it contains, the marks applied to it, and `:text` on text nodes. Those five keys are\n the whole of the ProseMirror JSON node format; `:attrs` varies by node type. Marks are nodes too as far as this\n schema is concerned -- a mark carries only `:type` and `:attrs`, which is a subset of a node.",
- "type" : "object",
- "properties" : {
- "attrs" : {
+ "interestingness_score" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.comments.schema..prose-mirror-node.attrs"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "content" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.comments.schema.prose-mirror-node"
- }
- },
- "marks" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.comments.schema.prose-mirror-node"
- }
- },
- "text" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "type" ],
- "additionalProperties" : false
- },
- "metabase.data-studio.api.table.bulk-table-info" : {
- "description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.",
- "type" : "object",
- "properties" : {
- "db_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "display_name" : {
- "type" : "string"
+ "started_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
},
- "id" : {
+ "card_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
- "is_published" : {
- "type" : "boolean"
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
},
"name" : {
- "type" : "string"
- },
- "schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "id", "db_id", "name", "display_name", "schema", "is_published" ]
- },
- "metabase.data-studio.api.table.bulk-table-selection-info" : {
- "description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",
- "type" : "object",
- "properties" : {
- "published_downstream_tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
- }
},
- "selected_table" : {
+ "status" : {
+ "type" : "string"
+ },
+ "error_message" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "unpublished_upstream_tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
- }
- }
- },
- "required" : [ "selected_table", "published_downstream_tables", "unpublished_upstream_tables" ]
- },
- "metabase.data-studio.api.table.data-authorities" : {
- "type" : "string",
- "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
- },
- "metabase.data-studio.api.table.data-layers" : {
- "type" : "string",
- "enum" : [ "final", "internal", "hidden" ]
- },
- "metabase.data-studio.api.table.data-sources" : {
- "type" : "string",
- "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
- },
- "metabase.data-studio.api.table.table-selectors" : {
- "type" : "object",
- "properties" : {
- "database_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "schema_ids" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
+ "query_type" : {
+ "type" : "string"
},
- "table_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- }
- },
- "additionalProperties" : false
- },
- "metabase.documents.prose-mirror..card-embed.explore-filter" : {
- "description" : "One explore-further filter `metabase.explorations` snapshots onto a static card embed: the filter as the client\n sent it, plus the name of the dimension it is on. Its `:field_ref` is the legacy `field_ref` of the chart column\n that was clicked.",
- "type" : "object",
- "properties" : {
- "dimension_name" : {
+ "segment_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "display_value" : {
- "type" : "string"
- },
- "field_ref" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..dimension.target"
- },
- "operator" : {
- "type" : "string"
- },
- "value" : {
+ "display" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "number"
- }, {
- "type" : "boolean"
- } ]
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "values" : {
- "type" : "array",
- "prefixItems" : [ {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "number"
- }, {
- "type" : "boolean"
- } ]
- }, {
- "type" : "null"
- } ]
- }, {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "number"
- }, {
- "type" : "boolean"
- } ]
- }, {
- "type" : "null"
- } ]
+ "dimension_name" : {
+ "type" : "string"
+ },
+ "finished_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
} ]
}
},
- "required" : [ "operator", "field_ref", "display_value" ],
- "additionalProperties" : false
+ "required" : [ "id", "exploration_thread_id", "card_id", "dimension_id", "query_type", "position", "status" ]
},
- "metabase.documents.prose-mirror..card-embed.host-data" : {
- "description" : "What `metabase.explorations` writes under `:host_data` of a static card embed so the frontend can render the\n embed's filter pills and hover highlights without a live lookup.",
+ "metabase.explorations.api.ExplorationSummary" : {
+ "description" : "Lightweight row for the `GET /mine` list. No threads/queries — just the metadata\n needed to render a list entry, plus `current_user_last_touched_at`, the timestamp the list is\n sorted by (the caller's own most-recent touch of this exploration, composed across the\n exploration's revisions and its creation).",
"type" : "object",
"properties" : {
- "explore_filters" : {
+ "collection" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.documents.prose-mirror..card-embed.explore-filter"
- }
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "id", "name" ]
}, {
"type" : "null"
} ]
},
- "query_ids" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "creator" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "integer"
+ "type" : "object",
+ "properties" : {
+ "email" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
}
}, {
"type" : "null"
} ]
- }
- },
- "additionalProperties" : false
- },
- "metabase.documents.prose-mirror..node.attrs" : {
- "description" : "Value must be a map.",
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
- }, {
- "description" : "Value must be a map."
- } ],
- "type" : "object",
- "properties" : {
- "model" : {
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "updated_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "current_user_last_touched_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "collection_id" : {
"oneOf" : [ {
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "stored_result_id" : {
+ "created_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "creator_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : {
"oneOf" : [ {
- "type" : "integer"
+ "type" : "string"
}, {
"type" : "null"
} ]
- },
- "label" : {
+ }
+ },
+ "required" : [ "id", "name", "creator_id", "created_at", "updated_at", "current_user_last_touched_at" ]
+ },
+ "metabase.explorations.api.HydratedExploration" : {
+ "description" : "Schema for an Exploration with hydrated creator and threads.",
+ "type" : "object",
+ "properties" : {
+ "threads" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedThread"
+ }
}, {
"type" : "null"
} ]
},
"id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "document" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "string"
- } ]
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationDocument"
}, {
"type" : "null"
} ]
},
- "chart_href" : {
+ "creator" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "object",
+ "properties" : { }
}, {
"type" : "null"
} ]
},
- "_id" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string",
- "format" : "uuid"
- } ]
- }, {
+ "name" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "updated_at" : {
+ "oneOf" : [ { }, {
"type" : "null"
} ]
},
- "entityId" : {
+ "collection_id" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "string"
- } ]
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "child_target_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
+ "created_at" : {
+ "oneOf" : [ { }, {
"type" : "null"
} ]
},
- "host_data" : {
+ "creator_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.documents.prose-mirror..card-embed.host-data"
+ "type" : "string"
}, {
"type" : "null"
} ]
}
- }
+ },
+ "required" : [ "id", "name", "creator_id" ]
},
- "metabase.documents.prose-mirror.ast" : {
- "description" : "Schema for a prose-mirror document AST as it arrives at the API or is read back from the application database: a\n node in the shape ProseMirror's `Node.toJSON` emits, whose children and marks are nodes too.",
+ "metabase.explorations.api.HydratedThread" : {
+ "description" : "Schema for an Exploration thread with hydrated selections and queries.",
"type" : "object",
"properties" : {
- "attrs" : {
+ "queries" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.documents.prose-mirror..node.attrs"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationQuerySummary"
+ }
}, {
"type" : "null"
} ]
},
- "content" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "started_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "blocks" : {
"oneOf" : [ {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationBlockNode"
}
}, {
"type" : "null"
} ]
},
- "marks" : {
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "pending", "running", "canceled", "empty", "failed", "completed", "forbidden" ]
+ },
+ "source_page_id" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
- }
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "text" : {
+ "prompt" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "type" ],
- "additionalProperties" : false
- },
- "metabase.documents.schema..document.id" : {
- "description" : "Valid Document ID",
- "type" : "integer",
- "minimum" : 1
- },
- "metabase.driver.connection.connection-type" : {
- "type" : "string",
- "enum" : [ "default", "write-data", "admin", "transform" ]
- },
- "metabase.driver.index-field" : {
- "description" : "One form field describing how to request an index: the same shape as a [[connection-properties]] descriptor, plus a\n `:columns` type for the indexed columns.",
- "type" : "object",
- "properties" : {
- "description" : { },
- "directions" : {
- "type" : "boolean"
- },
- "display-name" : { },
- "name" : {
- "type" : "string"
+ "timelines" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "timeline" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timeline_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "timeline_id" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "options" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "name" : { },
- "value" : {
- "type" : "string"
- }
- },
- "required" : [ "name", "value" ]
- }
+ "exploration_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "required" : {
- "type" : "boolean"
+ "completed_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "type" : "string",
- "enum" : [ "string", "boolean", "select", "integer", "columns" ]
+ "canceled_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "name", "display-name", "type" ]
+ "required" : [ "id", "exploration_id", "position", "status" ]
},
- "metabase.driver.index-method" : {
- "description" : "Metadata for one index kind a driver supports.",
+ "metabase.explorations.api.MineResponse" : {
+ "description" : "Paginated envelope for `GET /mine`, mirroring the collection-items index shape. `:total` is the\n count after the membership, permission, and archived filters; `:limit`/`:offset` echo the\n `offset-paging` middleware (both nil when the request is unpaged).",
"type" : "object",
"properties" : {
- "description" : { },
- "display-name" : { },
- "fields" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.driver.index-field"
- }
- },
- "lifecycle" : {
- "type" : "string",
- "enum" : [ "standalone", "inline" ]
- }
- },
- "required" : [ "display-name", "lifecycle", "fields" ]
- },
- "metabase.driver.supported-index-methods" : {
- "description" : "Return shape of [[supported-index-methods]]: index-kind -> metadata.",
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/components/schemas/metabase.driver.index-method"
- }
- },
- "metabase.eid-translation.schema.entity-ids-by-model" : {
- "description" : "Value must be a map.",
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
+ "data" : {
"type" : "array",
"items" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationSummary"
}
- }
- }, {
- "description" : "Value must be a map."
- } ]
- },
- "metabase.embedding-rest.api.theme.EmbeddingTheme" : {
- "type" : "object",
- "properties" : {
- "created_at" : { },
- "entity_id" : {
- "type" : "string",
- "minLength" : 1
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "is_default" : {
- "type" : "boolean"
},
- "name" : {
- "type" : "string",
- "minLength" : 1
+ "limit" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
},
- "settings" : {
- "description" : "Value must be a map.",
+ "offset" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
}, {
- "description" : "Value must be a map."
+ "type" : "null"
} ]
},
- "updated_at" : { }
+ "total" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }
},
- "required" : [ "id", "entity_id", "name", "settings", "is_default", "created_at", "updated_at" ]
+ "required" : [ "total", "limit", "offset", "data" ]
},
"metabase.frontend-errors.api.frontend-error-type" : {
"type" : "string",
@@ -21622,6 +23250,14 @@
} ]
} ]
},
+ "metabase.metrics.core.dimension" : {
+ "description" : "A metric dimension in its internal kebab-case shape, annotated with the rules that convert it to\n and from the snake_case wire shape. See [[metabase.metrics.dimension/dimension]].",
+ "$ref" : "#/components/schemas/metabase.metrics.dimension.dimension"
+ },
+ "metabase.metrics.core.dimension-mapping" : {
+ "description" : "A dimension mapping in its internal kebab-case shape, annotated with the rules that convert it to\n and from the snake_case wire shape. See [[metabase.metrics.dimension/dimension-mapping]].",
+ "$ref" : "#/components/schemas/metabase.metrics.dimension.dimension-mapping"
+ },
"metabase.metrics.dimension.dimension" : {
"description" : "Schema for a persisted dimension definition with status tracking.",
"type" : "object",
@@ -30595,7 +32231,7 @@
"get" : {
"operationId" : "get-api-apps",
"summary" : "GET /api/apps",
- "description" : "List the data apps provided by the connected repository. Pass `available=true`\n to return only enabled apps without sync errors.",
+ "description" : "List the data apps provided by the connected repository. Pass `available=true`\n to return only enabled apps without sync errors. An outdated app is never\n available, and otherwise listed only to superusers, who see it badged.",
"parameters" : [ {
"in" : "query",
"name" : "available",
@@ -30661,6 +32297,11 @@
"type" : "null"
} ]
},
+ "version" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
"created_at" : { },
"bundle_hash" : {
"oneOf" : [ {
@@ -30689,6 +32330,9 @@
"type" : "string"
}
},
+ "outdated" : {
+ "type" : "boolean"
+ },
"resource_collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -30710,7 +32354,7 @@
"minLength" : 1
}
},
- "required" : [ "id", "name", "display_name", "description", "bundle_path", "enabled", "allowed_hosts", "resource_collection_id", "permission_group_id", "table_ids", "bundle_hash", "last_synced_sha", "last_synced_at", "sync_error", "created_at", "updated_at" ]
+ "required" : [ "id", "name", "display_name", "description", "version", "outdated", "bundle_path", "enabled", "allowed_hosts", "resource_collection_id", "permission_group_id", "table_ids", "bundle_hash", "last_synced_sha", "last_synced_at", "sync_error", "created_at", "updated_at" ]
}, {
"type" : "object",
"properties" : {
@@ -30870,6 +32514,11 @@
"type" : "null"
} ]
},
+ "version" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
"created_at" : { },
"bundle_hash" : {
"oneOf" : [ {
@@ -30898,6 +32547,9 @@
"type" : "string"
}
},
+ "outdated" : {
+ "type" : "boolean"
+ },
"resource_collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -30919,7 +32571,7 @@
"minLength" : 1
}
},
- "required" : [ "id", "name", "display_name", "description", "bundle_path", "enabled", "allowed_hosts", "resource_collection_id", "permission_group_id", "table_ids", "bundle_hash", "last_synced_sha", "last_synced_at", "sync_error", "created_at", "updated_at" ]
+ "required" : [ "id", "name", "display_name", "description", "version", "outdated", "bundle_path", "enabled", "allowed_hosts", "resource_collection_id", "permission_group_id", "table_ids", "bundle_hash", "last_synced_sha", "last_synced_at", "sync_error", "created_at", "updated_at" ]
}
}
}
@@ -31046,6 +32698,11 @@
"type" : "null"
} ]
},
+ "version" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
"created_at" : { },
"bundle_hash" : {
"oneOf" : [ {
@@ -31074,6 +32731,9 @@
"type" : "string"
}
},
+ "outdated" : {
+ "type" : "boolean"
+ },
"resource_collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -31095,7 +32755,7 @@
"minLength" : 1
}
},
- "required" : [ "id", "name", "display_name", "description", "bundle_path", "enabled", "allowed_hosts", "resource_collection_id", "permission_group_id", "table_ids", "bundle_hash", "last_synced_sha", "last_synced_at", "sync_error", "created_at", "updated_at" ]
+ "required" : [ "id", "name", "display_name", "description", "version", "outdated", "bundle_path", "enabled", "allowed_hosts", "resource_collection_id", "permission_group_id", "table_ids", "bundle_hash", "last_synced_sha", "last_synced_at", "sync_error", "created_at", "updated_at" ]
}, {
"type" : "object",
"properties" : {
@@ -31233,6 +32893,343 @@
"type" : "null"
} ]
},
+ "version" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "created_at" : { },
+ "bundle_hash" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_synced_sha" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "sync_error" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "allowed_hosts" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "outdated" : {
+ "type" : "boolean"
+ },
+ "resource_collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "bundle_path" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "id", "name", "display_name", "description", "version", "outdated", "bundle_path", "enabled", "allowed_hosts", "resource_collection_id", "permission_group_id", "table_ids", "bundle_hash", "last_synced_sha", "last_synced_at", "sync_error", "created_at", "updated_at" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/apps" ]
+ }
+ },
+ "/api/apps/{slug}/query" : {
+ "post" : {
+ "operationId" : "post-api-apps-slug-query",
+ "summary" : "POST /api/apps/{slug}/query",
+ "description" : "Resolve an authored data-app query definition into a serializable Metabase query.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "slug",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "database_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "dataset_query" : {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
+ },
+ "metrics" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "database_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "metric" ]
+ },
+ "display" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "type", "collection_id", "dataset_query", "database_id", "display", "visualization_settings", "description" ],
+ "additionalProperties" : false
+ }
+ },
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "required" : [ "database_id", "dataset_query", "table_ids", "metrics" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-apps.query-definition.query-definition"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/apps" ]
+ }
+ },
+ "/api/apps/{slug}/query-table-dependencies" : {
+ "post" : {
+ "operationId" : "post-api-apps-slug-query-table-dependencies",
+ "summary" : "POST /api/apps/{slug}/query-table-dependencies",
+ "description" : "Return the tables read by already-saved queries, including ones reached only through an implicit join.\n\n Sync copies models, actions and metrics whose queries it never resolves through `/query`, and only\n this metadata-based lookup sees an implicit join: the id of a table reached through a foreign key\n appears nowhere in the query itself.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "slug",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "required" : [ "table_ids" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "dataset_queries" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
+ }
+ }
+ },
+ "required" : [ "dataset_queries" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/apps" ]
+ }
+ },
+ "/api/apps/{slug}/table-dependencies" : {
+ "put" : {
+ "operationId" : "put-api-apps-slug-table-dependencies",
+ "summary" : "PUT /api/apps/{slug}/table-dependencies",
+ "description" : "Store the tables used by the resources from a successful data app resource synchronization.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "slug",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "has_user_permission_warnings" : {
+ "type" : "boolean"
+ },
+ "last_synced_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "enabled" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "updated_at" : { },
+ "display_name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "permission_group_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "version" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
"created_at" : { },
"bundle_hash" : {
"oneOf" : [ {
@@ -31261,330 +33258,9 @@
"type" : "string"
}
},
- "resource_collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "bundle_path" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "id", "name", "display_name", "description", "bundle_path", "enabled", "allowed_hosts", "resource_collection_id", "permission_group_id", "table_ids", "bundle_hash", "last_synced_sha", "last_synced_at", "sync_error", "created_at", "updated_at" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/apps" ]
- }
- },
- "/api/apps/{slug}/query" : {
- "post" : {
- "operationId" : "post-api-apps-slug-query",
- "summary" : "POST /api/apps/{slug}/query",
- "description" : "Resolve an authored data-app query definition into a serializable Metabase query.",
- "parameters" : [ {
- "in" : "path",
- "name" : "slug",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "dataset_query" : {
- "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
- },
- "metrics" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "visualization_settings" : {
- "oneOf" : [ {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "dataset_query" : {
- "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "database_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "type" : "string",
- "enum" : [ "metric" ]
- },
- "display" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "name", "type", "collection_id", "dataset_query", "database_id", "display", "visualization_settings", "description" ],
- "additionalProperties" : false
- }
- },
- "table_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- }
- },
- "required" : [ "database_id", "dataset_query", "table_ids", "metrics" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.query-definition.query-definition"
- }
- }
- }
- },
- "tags" : [ "/api/apps" ]
- }
- },
- "/api/apps/{slug}/query-table-dependencies" : {
- "post" : {
- "operationId" : "post-api-apps-slug-query-table-dependencies",
- "summary" : "POST /api/apps/{slug}/query-table-dependencies",
- "description" : "Return the tables read by already-saved queries, including ones reached only through an implicit join.\n\n Sync copies models, actions and metrics whose queries it never resolves through `/query`, and only\n this metadata-based lookup sees an implicit join: the id of a table reached through a foreign key\n appears nowhere in the query itself.",
- "parameters" : [ {
- "in" : "path",
- "name" : "slug",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "table_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- }
- },
- "required" : [ "table_ids" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "dataset_queries" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
- }
- }
- },
- "required" : [ "dataset_queries" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "tags" : [ "/api/apps" ]
- }
- },
- "/api/apps/{slug}/table-dependencies" : {
- "put" : {
- "operationId" : "put-api-apps-slug-table-dependencies",
- "summary" : "PUT /api/apps/{slug}/table-dependencies",
- "description" : "Store the tables used by the resources from a successful data app resource synchronization.",
- "parameters" : [ {
- "in" : "path",
- "name" : "slug",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "has_user_permission_warnings" : {
- "type" : "boolean"
- },
- "last_synced_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "table_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "enabled" : {
+ "outdated" : {
"type" : "boolean"
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "updated_at" : { },
- "display_name" : {
- "type" : "string",
- "minLength" : 1
- },
- "permission_group_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "created_at" : { },
- "bundle_hash" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "last_synced_sha" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "sync_error" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "allowed_hosts" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
"resource_collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -31606,7 +33282,7 @@
"minLength" : 1
}
},
- "required" : [ "id", "name", "display_name", "description", "bundle_path", "enabled", "allowed_hosts", "resource_collection_id", "permission_group_id", "table_ids", "bundle_hash", "last_synced_sha", "last_synced_at", "sync_error", "created_at", "updated_at" ]
+ "required" : [ "id", "name", "display_name", "description", "version", "outdated", "bundle_path", "enabled", "allowed_hosts", "resource_collection_id", "permission_group_id", "table_ids", "bundle_hash", "last_synced_sha", "last_synced_at", "sync_error", "created_at", "updated_at" ]
}
}
}
@@ -31780,7 +33456,7 @@
"get" : {
"operationId" : "get-api-automagic-dashboards-model_index-model-index-id-primary_key-pk-id",
"summary" : "GET /api/automagic-dashboards/model_index/{model-index-id}/primary_key/{pk-id}",
- "description" : "Return an automagic dashboard for an entity detail specified by `entity`\n with id `id` and a primary key of `indexed-value`.",
+ "description" : "Return an automagic dashboard for the record of the model indexed by `model-index-id` whose primary key is\n `pk-id`. The record's value, used in the title, is read through the QP as the requesting user (never from\n `model_index_value`, which is not permission-checked); a `pk-id` they cannot resolve yields a dashboard titled\n by the pk, with no matching rows, rather than a 404.",
"parameters" : [ {
"in" : "path",
"name" : "model-index-id",
@@ -32458,7 +34134,7 @@
},
"type" : {
"type" : "string",
- "enum" : [ "card", "dashboard", "collection", "document" ]
+ "enum" : [ "card", "dashboard", "collection", "document", "exploration" ]
}
},
"required" : [ "type", "item_id" ],
@@ -32486,7 +34162,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "card", "dashboard", "collection", "document" ]
+ "enum" : [ "card", "dashboard", "collection", "document", "exploration" ]
}
}, {
"in" : "path",
@@ -32521,7 +34197,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "card", "dashboard", "collection", "document" ]
+ "enum" : [ "card", "dashboard", "collection", "document", "exploration" ]
}
}, {
"in" : "path",
@@ -35191,7 +36867,7 @@
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
}
}, {
"type" : "null"
@@ -35256,7 +36932,7 @@
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
}
}, {
"type" : "null"
@@ -35874,7 +37550,7 @@
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
}
}, {
"type" : "null"
@@ -35954,7 +37630,7 @@
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
}
}, {
"type" : "null"
@@ -36102,7 +37778,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "document" ]
+ "enum" : [ "document", "exploration" ]
}
}, {
"in" : "query",
@@ -36193,7 +37869,7 @@
},
"target_type" : {
"type" : "string",
- "enum" : [ "document" ]
+ "enum" : [ "document", "exploration" ]
}
},
"required" : [ "target_type", "target_id", "content" ],
@@ -36343,9 +38019,7 @@
"type" : "object",
"properties" : {
"emoji" : {
- "type" : "string",
- "minLength" : 1,
- "maxLength" : 10
+ "$ref" : "#/components/schemas/metabase.comments.schema.reaction-emoji"
}
},
"required" : [ "emoji" ],
@@ -46619,6 +48293,11 @@
"type" : "integer",
"minimum" : 1
},
+ "last_heartbeat_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
"started_at" : { },
"ended_at" : {
"oneOf" : [ { }, {
@@ -46662,6 +48341,37 @@
"type" : "null"
} ]
},
+ "initiated_by_user" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "first_name", "last_name", "email" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
"outcome" : {
"oneOf" : [ {
"type" : "object",
@@ -46731,6 +48441,11 @@
"type" : "integer",
"minimum" : 1
},
+ "last_heartbeat_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
"started_at" : { },
"ended_at" : {
"oneOf" : [ { }, {
@@ -46774,6 +48489,37 @@
"type" : "null"
} ]
},
+ "initiated_by_user" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "first_name", "last_name", "email" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
"outcome" : {
"oneOf" : [ {
"type" : "object",
@@ -49734,6 +51480,232 @@
"tags" : [ "/api/ee/tenant" ]
}
},
+ "/api/ee/transform-test" : {
+ "get" : {
+ "operationId" : "get-api-ee-transform-test",
+ "summary" : "GET /api/ee/transform-test",
+ "description" : "List the transform tests, optionally only those of one transform.",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "transform-id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.transform-test"
+ }
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/transform-test" ]
+ },
+ "post" : {
+ "operationId" : "post-api-ee-transform-test",
+ "summary" : "POST /api/ee/transform-test",
+ "description" : "Create a transform test.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.transform-test"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema..transform-test.create"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/transform-test" ]
+ }
+ },
+ "/api/ee/transform-test/{id}" : {
+ "get" : {
+ "operationId" : "get-api-ee-transform-test-id",
+ "summary" : "GET /api/ee/transform-test/{id}",
+ "description" : "Get a transform test.",
+ "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.transform-testing.schema.transform-test"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/transform-test" ]
+ },
+ "put" : {
+ "operationId" : "put-api-ee-transform-test-id",
+ "summary" : "PUT /api/ee/transform-test/{id}",
+ "description" : "Update a transform test.",
+ "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.transform-testing.schema.transform-test"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema..transform-test.update"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/transform-test" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-ee-transform-test-id",
+ "summary" : "DELETE /api/ee/transform-test/{id}",
+ "description" : "Delete a transform test.",
+ "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" : "null"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/transform-test" ]
+ }
+ },
+ "/api/ee/transform-test/{id}/run" : {
+ "post" : {
+ "operationId" : "post-api-ee-transform-test-id-run",
+ "summary" : "POST /api/ee/transform-test/{id}/run",
+ "description" : "Run a transform test.\n\n A 200 means the run happened: `:status` is then `passed` or `failed`, and every expectation\n reports what it found — including one that could not be evaluated, which comes back as that\n expectation's own `:error` rather than discarding the answers of the others.\n\n Any other status means the run was refused and nothing meaningful ran; the body then carries the `:error-code`\n naming which refusal it was, as [[refusing]] describes.",
+ "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.transform-testing.schema.run-result"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/transform-test" ]
+ }
+ },
"/api/ee/transforms-python/library/{path}" : {
"get" : {
"operationId" : "get-api-ee-transforms-python-library-path",
@@ -50798,7 +52770,310 @@
"description" : "Copy an embedding theme.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "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.embedding-rest.api.theme.EmbeddingTheme"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed-theme" ]
+ }
+ },
+ "/api/embed/card/{token}" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token",
+ "summary" : "GET /api/embed/card/{token}",
+ "description" : "Fetch a Card via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}}",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/params/{param-key}/remapping" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-remapping",
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/remapping",
+ "description" : "Embedded version of api.card filter values endpoint.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/params/{param-key}/search/{prefix}" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-search-prefix",
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/search/{prefix}",
+ "description" : "Embedded version of chain filter search endpoint.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "path",
+ "name" : "prefix",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/params/{param-key}/values" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-values",
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/values",
+ "description" : "Embedded version of api.card filter values endpoint.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/query" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-query",
+ "summary" : "GET /api/embed/card/{token}/query",
+ "description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/query/{export-format}" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-query-export-format",
+ "summary" : "GET /api/embed/card/{token}/query/{export-format}",
+ "description" : "Like `GET /api/embed/card/query`, but returns the results as a file in the specified format.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
+ }
+ }, {
+ "in" : "query",
+ "name" : "format_rows",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "pivot_results",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/dashboard/{token}" : {
+ "get" : {
+ "operationId" : "get-api-embed-dashboard-token",
+ "summary" : "GET /api/embed/dashboard/{token}",
+ "description" : "Fetch a Dashboard via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:dashboard <dashboard-id>}}",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "get" : {
+ "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id",
+ "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "card-id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -50808,14 +53083,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.embedding-rest.api.theme.EmbeddingTheme"
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -50824,14 +53092,14 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed-theme" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}" : {
+ "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
"get" : {
- "operationId" : "get-api-embed-card-token",
- "summary" : "GET /api/embed/card/{token}",
- "description" : "Fetch a Card via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}}",
+ "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id-export-format",
+ "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key` return the data in one of the export formats",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -50839,6 +53107,47 @@
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
+ }
+ }, {
+ "in" : "query",
+ "name" : "format_rows",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "pivot_results",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
} ],
"responses" : {
"2XX" : {
@@ -50854,11 +53163,11 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}/params/{param-key}/remapping" : {
+ "/api/embed/dashboard/{token}/params/{param-key}/remapping" : {
"get" : {
- "operationId" : "get-api-embed-card-token-params-param-key-remapping",
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/remapping",
- "description" : "Embedded version of api.card filter values endpoint.",
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-remapping",
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/remapping",
+ "description" : "Embedded version of the remapped dashboard param value endpoint.",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -50896,10 +53205,10 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}/params/{param-key}/search/{prefix}" : {
+ "/api/embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
"get" : {
- "operationId" : "get-api-embed-card-token-params-param-key-search-prefix",
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/search/{prefix}",
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-search-prefix",
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/search/{prefix}",
"description" : "Embedded version of chain filter search endpoint.",
"parameters" : [ {
"in" : "path",
@@ -50939,11 +53248,11 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}/params/{param-key}/values" : {
+ "/api/embed/dashboard/{token}/params/{param-key}/values" : {
"get" : {
- "operationId" : "get-api-embed-card-token-params-param-key-values",
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/values",
- "description" : "Embedded version of api.card filter values endpoint.",
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-values",
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/values",
+ "description" : "Embedded version of chain filter values endpoint.",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -50974,10 +53283,10 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}/query" : {
+ "/api/embed/pivot/card/{token}/query" : {
"get" : {
- "operationId" : "get-api-embed-card-token-query",
- "summary" : "GET /api/embed/card/{token}/query",
+ "operationId" : "get-api-embed-pivot-card-token-query",
+ "summary" : "GET /api/embed/pivot/card/{token}/query",
"description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
"parameters" : [ {
"in" : "path",
@@ -51001,11 +53310,11 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}/query/{export-format}" : {
+ "/api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
- "operationId" : "get-api-embed-card-token-query-export-format",
- "summary" : "GET /api/embed/card/{token}/query/{export-format}",
- "description" : "Like `GET /api/embed/card/query`, but returns the results as a file in the specified format.",
+ "operationId" : "get-api-embed-pivot-dashboard-token-dashcard-dashcard-id-card-card-id",
+ "summary" : "GET /api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -51015,27 +53324,22 @@
}
}, {
"in" : "path",
- "name" : "export-format",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
- }
- }, {
- "in" : "query",
- "name" : "format_rows",
- "required" : false,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
}, {
- "in" : "query",
- "name" : "pivot_results",
- "required" : false,
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
@@ -51051,11 +53355,11 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/dashboard/{token}" : {
+ "/api/embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
"get" : {
- "operationId" : "get-api-embed-dashboard-token",
- "summary" : "GET /api/embed/dashboard/{token}",
- "description" : "Fetch a Dashboard via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:dashboard <dashboard-id>}}",
+ "operationId" : "get-api-embed-tiles-card-token-zoom-x-y",
+ "summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}",
+ "description" : "Generates a single tile image for an embedded Card using the map visualization.",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -51063,51 +53367,51 @@
"schema" : {
"type" : "string"
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
- "get" : {
- "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id",
- "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
- "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
- "parameters" : [ {
+ }, {
"in" : "path",
- "name" : "token",
+ "name" : "zoom",
"required" : true,
"schema" : {
- "type" : "string"
- }
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
}, {
"in" : "path",
- "name" : "dashcard-id",
+ "name" : "x",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
},
- "description" : "value must be an integer greater than zero."
+ "description" : "value must be an integer."
}, {
"in" : "path",
- "name" : "card-id",
+ "name" : "y",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
},
- "description" : "value must be an integer greater than zero."
+ "description" : "value must be an integer."
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema..api.parameter-values"
+ }
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ }
} ],
"responses" : {
"2XX" : {
@@ -51123,11 +53427,11 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
+ "/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
- "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id-export-format",
- "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
- "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key` return the data in one of the export formats",
+ "operationId" : "get-api-embed-tiles-dashboard-token-dashcard-dashcard-id-card-card-id-zoom-x-y",
+ "summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
+ "description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -51155,26 +53459,48 @@
"description" : "value must be an integer greater than zero."
}, {
"in" : "path",
- "name" : "export-format",
+ "name" : "zoom",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
- }
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "x",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "y",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
}, {
"in" : "query",
- "name" : "format_rows",
+ "name" : "parameters",
"required" : false,
"schema" : {
- "default" : false,
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.parameters.schema..api.parameter-values"
}
}, {
"in" : "query",
- "name" : "pivot_results",
- "required" : false,
+ "name" : "latField",
+ "required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
}
} ],
"responses" : {
@@ -51191,37 +53517,324 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/remapping" : {
+ "/api/eval-trace/{session-id}" : {
"get" : {
- "operationId" : "get-api-embed-dashboard-token-params-param-key-remapping",
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/remapping",
- "description" : "Embedded version of the remapped dashboard param value endpoint.",
+ "operationId" : "get-api-eval-trace-session-id",
+ "summary" : "GET /api/eval-trace/{session-id}",
+ "description" : "Return the captured eval trace as JSONL (one span per line) for `session-id`. Superuser-only;\n served only when `MB_AI_EVAL_CAPTURE` is enabled.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
+ "name" : "session-id",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 200
}
- }, {
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : { }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/eval-trace" ]
+ }
+ },
+ "/api/exploration" : {
+ "post" : {
+ "operationId" : "post-api-exploration",
+ "summary" : "POST /api/exploration",
+ "description" : "Create a new exploration with a single thread, persist the user's selected metrics, dimensions,\n and timelines, and stamp the thread as started. Also auto-creates a placeholder Summary\n document in the same collection. Actual planning is async; this endpoint returns immediately\n with an empty queries list. Clients should poll `GET /:id` until the queries appear and reach\n a terminal status.\n\n Accepts the per-area `:blocks` payload (one entry per Research-plan block), persisted\n verbatim, plus a thread-scoped `:timeline_ids`.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedExploration"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "blocks" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "dimensions" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "dimension-id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "dimension-id" ],
+ "additionalProperties" : false
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metrics" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "card_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "dimension_mappings" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metrics.core.dimension-mapping"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "card_id" ],
+ "additionalProperties" : false
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 254
+ },
+ "prompt" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timeline_ids" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/exploration" ]
+ }
+ },
+ "/api/exploration/dimensions" : {
+ "get" : {
+ "operationId" : "get-api-exploration-dimensions",
+ "summary" : "GET /api/exploration/dimensions",
+ "description" : "Hydrated metrics plus a deduplicated dimension list, for the Exploration data modal.\n\n Optional `q` filters case-insensitively across metric name and dimension display-name.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.DimensionsResponse"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/exploration" ]
+ }
+ },
+ "/api/exploration/mine" : {
+ "get" : {
+ "operationId" : "get-api-exploration-mine",
+ "summary" : "GET /api/exploration/mine",
+ "description" : "Explorations the current user created or edited, most-recently-touched first, paginated.\n\n \"Touched\" composes the user's own edits to the exploration, to its Summary document, and its\n creation — see [[metabase.explorations.db/my-explorations]]. Explorations that were moved into a\n collection the user can no longer read are excluded, as are archived ones. Returns the\n collection-items envelope: `{:total :limit :offset :data}`.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.MineResponse"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/exploration" ]
+ }
+ },
+ "/api/exploration/page/{id}/starred" : {
+ "put" : {
+ "operationId" : "put-api-exploration-page-id-starred",
+ "summary" : "PUT /api/exploration/page/{id}/starred",
+ "description" : "Set whether an exploration page is starred.",
+ "parameters" : [ {
"in" : "path",
- "name" : "param-key",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : {
- "type" : "string"
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "starred" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "starred" ],
+ "additionalProperties" : false
+ }
+ }
}
- } ],
+ },
+ "tags" : [ "/api/exploration" ]
+ }
+ },
+ "/api/exploration/pages/hidden" : {
+ "put" : {
+ "operationId" : "put-api-exploration-pages-hidden",
+ "summary" : "PUT /api/exploration/pages/hidden",
+ "description" : "Set whether one or more exploration pages are hidden from the sidebar. Hiding a single\n page passes a one-element `page_ids`; hiding a whole group passes all its page ids.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -51230,41 +53843,67 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "hidden" : {
+ "type" : "boolean"
+ },
+ "page_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "required" : [ "page_ids", "hidden" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
+ "/api/exploration/query/{id}" : {
"get" : {
- "operationId" : "get-api-embed-dashboard-token-params-param-key-search-prefix",
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/search/{prefix}",
- "description" : "Embedded version of chain filter search endpoint.",
+ "operationId" : "get-api-exploration-query-id",
+ "summary" : "GET /api/exploration/query/{id}",
+ "description" : "Stream the result of a single completed exploration query. The optional `format` query param\n is one of `api`, `json`, `csv`, `xlsx` (default `api`). When the underlying query is still\n pending or has errored, returns a 409 with status info instead of streaming.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
}, {
- "in" : "path",
- "name" : "prefix",
- "required" : true,
+ "in" : "query",
+ "name" : "format",
+ "required" : false,
"schema" : {
+ "default" : "api",
"type" : "string",
- "minLength" : 1
+ "enum" : [ "api", "csv", "json", "xlsx" ]
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationQueryStreamResponse"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -51273,33 +53912,34 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/values" : {
- "get" : {
- "operationId" : "get-api-embed-dashboard-token-params-param-key-values",
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/values",
- "description" : "Embedded version of chain filter values endpoint.",
+ "/api/exploration/thread/{thread-id}/cancel" : {
+ "post" : {
+ "operationId" : "post-api-exploration-thread-thread-id-cancel",
+ "summary" : "POST /api/exploration/thread/{thread-id}/cancel",
+ "description" : "Cancel an in-flight exploration thread. Stamps `canceled_at` and `completed_at` on the thread,\n and bulk-flips any still-`pending` ExplorationQuery rows to `canceled`. In-flight queries\n currently mid-QP-execution are left to run to natural completion — their result rows are\n orphaned but harmless (timeline scoring skips canceled threads).\n\n Idempotent: a thread with `completed_at IS NOT NULL` (already terminal — natural completion or\n prior cancel) returns 200 with its existing state. Authorization is the same write check as\n other thread-mutating endpoints.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
+ "name" : "thread-id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.CanceledThread"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -51308,25 +53948,34 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/pivot/card/{token}/query" : {
- "get" : {
- "operationId" : "get-api-embed-pivot-card-token-query",
- "summary" : "GET /api/embed/pivot/card/{token}/query",
- "description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
+ "/api/exploration/thread/{thread-id}/restart" : {
+ "post" : {
+ "operationId" : "post-api-exploration-thread-thread-id-restart",
+ "summary" : "POST /api/exploration/thread/{thread-id}/restart",
+ "description" : "Re-run one exploration thread in place, keeping its selections: drops the thread's materialized\n queries and clears the terminal-state gates so the background planner re-claims it. Returns the\n parent exploration. Only a terminal thread (completed, failed, or canceled) can restart; while\n planning, execution, or analysis is still in flight this returns a 409 — cancel the thread\n first, then restart.\n\n No `:event/exploration-update` is published: nothing on the Exploration row changes, so there\n is no revision to record (the revision push skips unchanged objects).",
"parameters" : [ {
"in" : "path",
- "name" : "token",
+ "name" : "thread-id",
"required" : true,
"schema" : {
- "type" : "string"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedExploration"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -51335,33 +53984,51 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "/api/exploration/{id}" : {
"get" : {
- "operationId" : "get-api-embed-pivot-dashboard-token-dashcard-dashcard-id-card-card-id",
- "summary" : "GET /api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
- "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
+ "operationId" : "get-api-exploration-id",
+ "summary" : "GET /api/exploration/{id}",
+ "description" : "Fetch an exploration with its thread, selections, and generated queries.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "dashcard-id",
+ "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.explorations.api.HydratedExploration"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/exploration" ]
+ },
+ "put" : {
+ "operationId" : "put-api-exploration-id",
+ "summary" : "PUT /api/exploration/{id}",
+ "description" : "Update an exploration's metadata, archive state, or move it to a different collection.\n\n When `collection_id` changes, the caller must have write perms on the destination collection\n (or the root collection when `collection_id` is nil). Source perms are enforced by\n `api/write-check` against the exploration itself via `:perms/use-parent-collection-perms`.\n Moving an exploration cascades the new `collection_id` onto its Summary document; flipping\n `archived` cascades to the same document (skipping any that were directly user-archived,\n mirroring the dashboard / dashboard-question cascade).",
+ "parameters" : [ {
"in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -51371,7 +54038,14 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedExploration"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -51380,70 +54054,77 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
- "get" : {
- "operationId" : "get-api-embed-tiles-card-token-zoom-x-y",
- "summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}",
- "description" : "Generates a single tile image for an embedded Card using the map visualization.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "archived" : {
+ "type" : "boolean"
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 254
+ }
+ },
+ "additionalProperties" : false
+ }
+ }
}
- }, {
- "in" : "path",
- "name" : "zoom",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "x",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
+ },
+ "tags" : [ "/api/exploration" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-exploration-id",
+ "summary" : "DELETE /api/exploration/{id}",
+ "description" : "Hard-delete an exploration. Soft delete is `PUT /api/exploration/:id {archived: true}`.\n\n Cascades to every `exploration_thread`, `exploration_query`, and attached Summary `document`\n via the on-delete-cascade FKs configured in the explorations migration.",
+ "parameters" : [ {
"in" : "path",
- "name" : "y",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "integer"
+ "type" : "integer",
+ "minimum" : 1
},
- "description" : "value must be an integer."
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema..api.parameter-values"
- }
- }, {
- "in" : "query",
- "name" : "latField",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
- }
- }, {
- "in" : "query",
- "name" : "lonField",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
- }
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -51452,88 +54133,34 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
- "get" : {
- "operationId" : "get-api-embed-tiles-dashboard-token-dashcard-dashcard-id-card-card-id-zoom-x-y",
- "summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
- "description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
+ "/api/exploration/{id}/explore-further" : {
+ "post" : {
+ "operationId" : "post-api-exploration-id-explore-further",
+ "summary" : "POST /api/exploration/{id}/explore-further",
+ "description" : "Start a follow-up investigation scoped to a clicked chart segment.\n\n The user clicked a bar/point on the chart for `page_id`; we copy that page's block (its metric\n selection + the same dimensions) into a brand-new thread and append each `explore_filters`\n entry onto every metric selection's `:explore_filters` vector. The background planner then\n materializes the same set of charts, but every query is scoped to those filters — and to any\n filters the source block already carried, so drilling from within an already-drilled thread\n keeps the earlier scope (see\n `metabase.explorations.query-plan.context/build-row-context`). Returns immediately with the new\n thread stamped `started_at`; clients poll `GET /:id` for the queries to land, exactly like create.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "zoom",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "x",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "y",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema..api.parameter-values"
- }
- }, {
- "in" : "query",
- "name" : "latField",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
- }
- }, {
- "in" : "query",
- "name" : "lonField",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
- }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedExploration"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -51542,30 +54169,144 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "explore_filters" : {
+ "type" : "array",
+ "items" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "dimension_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_value" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "field_ref" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..dimension.target"
+ },
+ "operator" : {
+ "const" : "="
+ },
+ "value" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "operator", "field_ref", "value", "display_value" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "object",
+ "properties" : {
+ "dimension_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_value" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "field_ref" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..dimension.target"
+ },
+ "operator" : {
+ "const" : "between"
+ },
+ "values" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }, {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ } ]
+ }
+ },
+ "required" : [ "operator", "field_ref", "values", "display_value" ],
+ "additionalProperties" : false
+ } ]
+ },
+ "minItems" : 1
+ },
+ "page_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "page_id", "explore_filters" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/eval-trace/{session-id}" : {
- "get" : {
- "operationId" : "get-api-eval-trace-session-id",
- "summary" : "GET /api/eval-trace/{session-id}",
- "description" : "Return the captured eval trace as JSONL (one span per line) for `session-id`. Superuser-only;\n served only when `MB_AI_EVAL_CAPTURE` is enabled.",
+ "/api/exploration/{id}/summary/append" : {
+ "post" : {
+ "operationId" : "post-api-exploration-id-summary-append",
+ "summary" : "POST /api/exploration/{id}/summary/append",
+ "description" : "Append a static `cardEmbed` representing a *composite chart* — built from one or more\n `ExplorationQuery` snapshots combined into a single qp-result — to the exploration's\n Summary document.\n\n The body `:exploration_query_ids` is the FE-rendered SeriesGroup's full set (one entry\n for single-query charts; multiple for combined cartesian / heat-map charts). The BE\n combines those source snapshots (`metabase.explorations.composite/combine`) into one\n ephemeral `stored_result` and materializes one ephemeral `report_card` referencing it.\n The cardEmbed node remains single-card.\n\n - `chart_href` / `child_target_id` / `host_data` are written onto the node so the FE\n can deep-link the embed title back to the source page, share that page's comment\n stream (`child_target_id`), and resolve highlight hover and explore-further filter\n pills via opaque `host_data`.\n - `display` / `visualization_settings` are required FE-computed render settings (from\n `buildSeries` / `getDisplay`); the BE bakes them onto the ephemeral card.\n\n All source EQs must belong to a thread of this exploration. Appending clears\n `is_placeholder` when it was set.",
"parameters" : [ {
"in" : "path",
- "name" : "session-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1,
- "maxLength" : 200
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
"description" : "Successful response",
"content" : {
"application/json" : {
- "schema" : { }
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationDocument"
+ }
}
}
},
@@ -51576,7 +54317,37 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/eval-trace" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "display" : {
+ "type" : "string"
+ },
+ "exploration_query_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "minItems" : 1
+ },
+ "visualization_settings" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "exploration_query_ids", "display", "visualization_settings" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/exploration" ]
}
},
"/api/field/table-ids" : {
@@ -62301,7 +65072,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ]
+ "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform", "transform-test" ]
}
} ],
"responses" : {
@@ -62343,7 +65114,7 @@
"properties" : {
"entity" : {
"type" : "string",
- "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ]
+ "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform", "transform-test" ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
@@ -62376,7 +65147,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ]
+ "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform", "transform-test" ]
}
}, {
"in" : "path",
@@ -62618,7 +65389,7 @@
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
}
}, {
"type" : "null"
@@ -62747,7 +65518,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
}
}, {
"in" : "query",
@@ -62969,7 +65740,7 @@
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
}
}, {
"type" : "null"
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index 7cc7b5b815c..b803af6c8f3 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -165,7 +165,6 @@ config:
help-link: metabase
help-link-custom-destination: https://www.metabase.com/help/premium
hide-stacktraces: false
- http-channel-allowed-networks: external-only
humanization-strategy: simple
index-update-thread-count: 2
jdbc-data-warehouse-connection-pool-checkout-timeout-ms: 0
@@ -253,7 +252,6 @@ config:
loading-message: doing-science
login-page-illustration: default
login-page-illustration-custom: null
- map-tile-server-allowed-networks: null
map-tile-server-url: https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
mcp-apps-cors-custom-origins: ''
mcp-apps-cors-enabled-clients: []
@@ -284,7 +282,6 @@ config:
notification-link-base-url: null
notification-system-event-thread-pool-size: 5
notification-thread-pool-size: 3
- oidc-allowed-networks: allow-all
oidc-providers: []
oidc-user-provisioning-enabled: true
persisted-model-refresh-cron-schedule: 0 0 0/6 * * ? *
@@ -384,5 +381,4 @@ config:
use-native-pivot-tables: false
use-tenants: false
user-visibility: all
- warehouse-allowed-networks: null
```
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 1f4bc2cff34..b0844dd329b 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -887,6 +887,7 @@ Prevent the exception middleware from including stacktraces in responses.
- Type: keyword
- Default: `external-only`
+- Environment variable only: you can't set this in the Admin settings or in a [configuration file](./config-file.md).
Controls which types of hosts are allowed as HTTP channel destinations.
Options:
@@ -895,6 +896,8 @@ Options:
- allow-all (no restrictions including localhost).
.
+Set this when a notification webhook must reach a host on your private network (`allow-private`) or on this machine (`allow-all`). Default is `external-only`
+
### `MB_HUMANIZATION_STRATEGY`
- Type: keyword
@@ -1770,6 +1773,7 @@ The custom illustration for the login page.
- Type: keyword
- Default: `null`
+- Environment variable only: you can't set this in the Admin settings or in a [configuration file](./config-file.md).
Controls which networks Metabase may connect to for map tile servers.
Options:
@@ -1778,6 +1782,8 @@ Controls which networks Metabase may connect to for map tile servers.
- allow-all (no restrictions).
Defaults to external-only on Metabase Cloud and allow-private when self-hosted.
+Allowed network for the map tile server.
+
### `MB_MAP_TILE_SERVER_URL`
- Type: string
@@ -1786,6 +1792,16 @@ Controls which networks Metabase may connect to for map tile servers.
The map tile server URL template used in map visualizations, for example from OpenStreetMaps or MapBox. This URL is visible to clients, so do not include private keys.
+### `MB_MAX_UNAUTHENTICATED_REQUEST_BODY_BYTES`
+
+- Type: integer
+- Default: `4194304`
+- Environment variable only: you can't set this in the Admin settings or in a [configuration file](./config-file.md).
+
+Maximum size in bytes of an HTTP request body from a caller who is not authenticated. Larger requests are rejected with HTTP 413 before the body is read.
+
+Applies to requests without a valid session, API key or token. The body is bounded before authentication is checked, so this is the most memory an anonymous request can make the server buffer. It covers login, setup, password reset, SSO callbacks, and public or embedded queries; none of those legitimately send more than a few hundred kilobytes. Authenticated requests are not limited.
+
### `MB_MCP_APPS_CORS_CUSTOM_ORIGINS`
- Type: string
@@ -2014,10 +2030,12 @@ If Metabase stops sending notifications like alerts, it may be because long-runn
- Type: keyword
- Default: `allow-all`
-- [Configuration file name](./config-file.md): `oidc-allowed-networks`
+- Environment variable only: you can't set this in the Admin settings or in a [configuration file](./config-file.md).
What networks are OIDC requests allowed to? Possible values: 'allow-all' (default), 'allow-private', or 'external-only'.
+Set this to tighten which networks OIDC discovery and token requests may reach; it defaults to allow-all. Other values: external-only and allow-private
+
### `MB_OIDC_PROVIDERS`
> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
@@ -2164,7 +2182,7 @@ Network timeout (in seconds) for remote git operations such as fetch, push, clon
- Default: `300000`
- [Configuration file name](./config-file.md): `remote-sync-task-time-limit-ms`
-The maximum amount of time a remote sync task will be given to complete.
+How long a remote sync task may go without proving its process is alive (via heartbeat, or progress on rows without one) before it is treated as dead and superseded. A slow but live task is never affected. The task itself is aborted after ten times this limit.
### `MB_REMOTE_SYNC_TOKEN`
@@ -2983,6 +3001,7 @@ Note: Users with row or column security restrictions will never see suggestions.
- Type: keyword
- Default: `null`
+- Environment variable only: you can't set this in the Admin settings or in a [configuration file](./config-file.md).
Controls which networks Metabase may connect to for warehouse connections.
Options:
@@ -2992,6 +3011,8 @@ Options:
Defaults to external-only on Metabase Cloud and allow-all when self-hosted.
Also covers the SSH tunnel host and the database auth-provider URLs.
+Set this when Metabase must reach a warehouse on a private network (allow-private) or on this machine (allow-all). There is no admin UI for it, and a value stored in the application database is ignored. Defaults to external-only on Metabase Cloud and allow-all when self-hosted. Metabase refuses to start if this is set to anything but one of the three policies, rather than run on a policy nobody chose.
+
## Other environment variables
The following environment variables can only be set via the environment. They cannot be set by the configuration file.
diff --git a/docs/usage-and-performance-tools/usage-analytics-reference.md b/docs/usage-and-performance-tools/usage-analytics-reference.md
index b6c27178d28..1e6e3e22706 100644
--- a/docs/usage-and-performance-tools/usage-analytics-reference.md
+++ b/docs/usage-and-performance-tools/usage-analytics-reference.md
@@ -648,6 +648,11 @@ The Topic column on the [Activity log](#activity-log) model takes one of:
- transform-run-canceled
- transform-run-start
- transform-run-timeout
+- transform-test-create
+- transform-test-delete
+- transform-test-run-start
+- transform-test-run-timeout
+- transform-test-update
- update-permission-failure
- update-transform
- upload-append