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

github-automation-metabase34fc6597f3a4
diff --git a/docs/api.json b/docs/api.json
index 97fd85ad163..c5edf3500a1 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -7120,6 +7120,28 @@
},
"required" : [ "type", "name", "display-name", "card-id" ]
},
+ "metabase.legacy-mbql.schema..TemplateTag.SourceTable" : {
+ "description" : "Things required by all template tag types.",
+ "type" : "object",
+ "properties" : {
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "table-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ },
+ "type" : {
+ "const" : "table"
+ }
+ },
+ "required" : [ "type", "name", "display-name", "table-id" ]
+ },
"metabase.legacy-mbql.schema..TemplateTag.TemporalUnit" : {
"description" : "Things required by all template tag types.",
"type" : "object",
@@ -7193,6 +7215,13 @@
"metabase.legacy-mbql.schema..legacy-column-metadata.qualified-keys" : {
"type" : "object",
"properties" : {
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/external-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
@@ -7329,13 +7358,6 @@
"type" : "null"
} ]
},
- "lib/model-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
@@ -7414,6 +7436,13 @@
"type" : "null"
} ]
},
+ "metabase.lib.metadata.result-metadata/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
@@ -8495,6 +8524,8 @@
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.Snippet"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.SourceQuery"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.SourceTable"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.TemporalUnit"
}, {
@@ -8515,7 +8546,7 @@
"metabase.legacy-mbql.schema.TemplateTagType" : {
"description" : "Schema for valid values of template tag `:type`.",
"type" : "string",
- "enum" : [ "snippet", "card", "dimension", "number", "text", "date" ]
+ "enum" : [ "snippet", "card", "dimension", "number", "text", "date", "table" ]
},
"metabase.legacy-mbql.schema.TemporalExtractUnit" : {
"description" : "Valid units to extract from a temporal.",
@@ -8829,6 +8860,13 @@
"allOf" : [ {
"type" : "object",
"properties" : {
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
+ },
"field_ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
@@ -9010,13 +9048,6 @@
"display_name" : {
"type" : "string"
},
- "lib/model-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
@@ -9126,6 +9157,13 @@
"type" : "null"
} ]
},
+ "metabase.lib.metadata.result-metadata/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
@@ -10612,6 +10650,13 @@
"type" : "null"
} ]
},
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/external-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
@@ -10770,13 +10815,6 @@
"type" : "null"
} ]
},
- "lib/model-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
"has-field-values" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
@@ -10794,20 +10832,6 @@
"selected?" : {
"type" : "boolean"
},
- "source-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
- }, {
- "type" : "null"
- } ]
- },
"metabase.lib.join/join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
@@ -10843,6 +10867,13 @@
"type" : "null"
} ]
},
+ "metabase.lib.metadata.result-metadata/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
@@ -10877,13 +10908,6 @@
"type" : "null"
} ]
},
- "field-ref" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
- }, {
- "type" : "null"
- } ]
- },
"lib/desired-column-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
@@ -10897,6 +10921,8 @@
"$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
+ }, {
+ "allOf" : [ ]
} ]
},
"metabase.lib.schema.metadata.deduplicated-name" : {
@@ -11100,6 +11126,13 @@
"type" : "null"
} ]
},
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/external-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
@@ -11258,13 +11291,6 @@
"type" : "null"
} ]
},
- "lib/model-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
"has-field-values" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
@@ -11282,20 +11308,6 @@
"selected?" : {
"type" : "boolean"
},
- "source-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
- }, {
- "type" : "null"
- } ]
- },
"metabase.lib.join/join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
@@ -11331,6 +11343,13 @@
"type" : "null"
} ]
},
+ "metabase.lib.metadata.result-metadata/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
@@ -11365,13 +11384,6 @@
"type" : "null"
} ]
},
- "field-ref" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
- }, {
- "type" : "null"
- } ]
- },
"lib/desired-column-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
@@ -11385,6 +11397,8 @@
"$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
+ }, {
+ "allOf" : [ ]
} ]
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
@@ -12197,6 +12211,31 @@
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
} ]
},
+ "metabase.lib.schema.template-tag.source-table" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ },
+ "table-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ },
+ "type" : {
+ "const" : "table"
+ }
+ },
+ "required" : [ "name", "display-name", "type", "table-id" ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
+ } ]
+ },
"metabase.lib.schema.template-tag.template-tag" : {
"allOf" : [ {
"type" : "object",
@@ -12215,6 +12254,8 @@
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.snippet"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-query"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-table"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.raw-value"
} ]
@@ -12257,7 +12298,7 @@
"metabase.lib.schema.template-tag.type" : {
"description" : "Schema for valid values of template tag `:type`.",
"type" : "string",
- "enum" : [ "snippet", "card", "dimension", "number", "text", "date", "boolean", "temporal-unit" ]
+ "enum" : [ "snippet", "card", "dimension", "number", "text", "date", "boolean", "temporal-unit", "table" ]
},
"metabase.lib.schema.template-tag.widget-type" : {
"description" : "Schema for valid values of `:widget-type` for a `:metabase.lib.schema.template-tag/field-filter` template tag.",
@@ -27569,6 +27610,16 @@
"type" : "null"
} ]
},
+ "conflicts" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"last_progress_report_at" : {
"oneOf" : [ { }, {
"type" : "null"
@@ -27601,7 +27652,7 @@
},
"status" : {
"type" : "string",
- "enum" : [ "running", "successful", "errored", "cancelled", "timed-out" ]
+ "enum" : [ "running", "successful", "errored", "cancelled", "timed-out", "conflict" ]
},
"error_message" : {
"oneOf" : [ {
@@ -27662,6 +27713,16 @@
"type" : "null"
} ]
},
+ "conflicts" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"last_progress_report_at" : {
"oneOf" : [ { }, {
"type" : "null"
@@ -27694,7 +27755,7 @@
},
"status" : {
"type" : "string",
- "enum" : [ "running", "successful", "errored", "cancelled", "timed-out" ]
+ "enum" : [ "running", "successful", "errored", "cancelled", "timed-out", "conflict" ]
},
"error_message" : {
"oneOf" : [ {
@@ -30579,6 +30640,184 @@
"tags" : [ "/api/ee/workspace" ]
}
},
+ "/api/ee/workspace/{ws-id}/input/grant" : {
+ "post" : {
+ "summary" : "POST /api/ee/workspace/{ws-id}/input/grant",
+ "description" : "Grant read access to input tables by table coordinates. Superuser only.\n Idempotent - returns which tables were already granted vs newly granted.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "already_granted" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "db_id", "schema", "table" ]
+ }
+ },
+ "newly_granted" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "db_id", "schema", "table" ]
+ }
+ }
+ },
+ "required" : [ "already_granted", "newly_granted" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "tables" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "db_id", "schema", "table" ]
+ }
+ }
+ },
+ "required" : [ "tables" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/{ws-id}/input/pending" : {
+ "get" : {
+ "summary" : "GET /api/ee/workspace/{ws-id}/input/pending",
+ "description" : "List all input tables that haven't been granted access yet, excluding tables shadowed by workspace outputs.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "inputs" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "db_id", "schema", "table" ]
+ }
+ }
+ },
+ "required" : [ "inputs" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
"/api/ee/workspace/{ws-id}/log" : {
"get" : {
"summary" : "GET /api/ee/workspace/{ws-id}/log",
@@ -36158,6 +36397,25 @@
"tags" : [ "/api/persist" ]
}
},
+ "/api/premium-features/token/refresh" : {
+ "post" : {
+ "summary" : "POST /api/premium-features/token/refresh",
+ "description" : "Clear all token caches and re-check the premium features token against the MetaStore.\n Returns the fresh token status. Useful for the frontend after a purchase so that new features\n are recognized without waiting for the cache TTL.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/premium-features" ]
+ }
+ },
"/api/premium-features/token/status" : {
"get" : {
"summary" : "GET /api/premium-features/token/status",