The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Auto-update documentation for master (#85782)
github-automation-metabaseee3c4a8be82f
diff --git a/docs/api.json b/docs/api.jsonindex eccc1e871bf..00393fdbd11 100644--- a/docs/api.json+++ b/docs/api.json@@ -1286,57 +1286,6 @@"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-expression"} ]},- "metabase-enterprise.data-apps.schema.allowed-host" : {- "description" : "An origin a data app's sandboxed bundle may fetch: scheme, host with an optional `*.` subdomain wildcard, and an\n optional port.",- "type" : "string",- "pattern" : "\\Ahttps?://(\\*\\.)?[a-z0-9-]+(\\.[a-z0-9-]+)*(:\\d+)?\\z"- },- "metabase-enterprise.data-apps.schema.allowed-hosts" : {- "description" : "The origins a data app's sandboxed bundle may fetch, `[]` when nil.",- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.allowed-host"- }- },- "metabase-enterprise.data-apps.schema.bundle-path" : {- "description" : "The path of a data app's bundle, relative to the app's directory and inside it.",- "type" : "string",- "minLength" : 1- },- "metabase-enterprise.data-apps.schema.bundle-text" : {- "description" : "The text of a data app's bundle file.",- "type" : "string",- "maxLength" : 10485760- },- "metabase-enterprise.data-apps.schema.description" : {- "description" : "A data app's optional one-line summary, nil when blank.",- "oneOf" : [ {- "type" : "string",- "maxLength" : 255- }, {- "type" : "null"- } ]- },- "metabase-enterprise.data-apps.schema.display-name" : {- "description" : "A data app's display name.",- "type" : "string",- "minLength" : 1- },- "metabase-enterprise.data-apps.schema.slug" : {- "description" : "A data app's slug: lowercase letters and numbers separated by single dashes, at most 100 characters.",- "allOf" : [ {- "type" : "string",- "maxLength" : 100- }, {- "type" : "string",- "pattern" : "\\A[a-z0-9]+(?:-[a-z0-9]+)*\\z"- } ]- },- "metabase-enterprise.data-apps.schema.version" : {- "description" : "The data app contract version an app was built for, 1 when it declares none.",- "type" : "integer",- "minimum" : 1- },"metabase-enterprise.data-complexity-score.api.node" : {"anyOf" : [ {"type" : "object",@@ -8911,6 +8860,57 @@"maxLength" : 10,"type" : "string"},+ "metabase.data-apps.schema.allowed-host" : {+ "description" : "An origin a data app's sandboxed bundle may fetch: scheme, host with an optional `*.` subdomain wildcard, and an\n optional port.",+ "type" : "string",+ "pattern" : "\\Ahttps?://(\\*\\.)?[a-z0-9-]+(\\.[a-z0-9-]+)*(:\\d+)?\\z"+ },+ "metabase.data-apps.schema.allowed-hosts" : {+ "description" : "The origins a data app's sandboxed bundle may fetch, `[]` when nil.",+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.data-apps.schema.allowed-host"+ }+ },+ "metabase.data-apps.schema.bundle-path" : {+ "description" : "The path of a data app's bundle, relative to the app's directory and inside it.",+ "type" : "string",+ "minLength" : 1+ },+ "metabase.data-apps.schema.bundle-text" : {+ "description" : "The text of a data app's bundle file.",+ "type" : "string",+ "maxLength" : 10485760+ },+ "metabase.data-apps.schema.description" : {+ "description" : "A data app's optional one-line summary, nil when blank.",+ "oneOf" : [ {+ "type" : "string",+ "maxLength" : 255+ }, {+ "type" : "null"+ } ]+ },+ "metabase.data-apps.schema.display-name" : {+ "description" : "A data app's display name.",+ "type" : "string",+ "minLength" : 1+ },+ "metabase.data-apps.schema.slug" : {+ "description" : "A data app's slug: lowercase letters and numbers separated by single dashes, at most 100 characters.",+ "allOf" : [ {+ "type" : "string",+ "maxLength" : 100+ }, {+ "type" : "string",+ "pattern" : "\\A[a-z0-9]+(?:-[a-z0-9]+)*\\z"+ } ]+ },+ "metabase.data-apps.schema.version" : {+ "description" : "The data app contract version an app was built for, 1 when it declares none.",+ "type" : "integer",+ "minimum" : 1+ },"metabase.data-studio.api.table.bulk-table-info" : {"description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.","type" : "object",@@ -29920,6 +29920,13 @@"type" : "null"} ]},+ "target-incremental-strategy" : {+ "oneOf" : [ {+ "$ref" : "#/components/schemas/metabase.transforms.schema.target-incremental-strategy"+ }, {+ "type" : "null"+ } ]+ },"type" : {"const" : "table"}@@ -30898,6 +30905,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/action" ]},"post" : {@@ -30998,6 +31016,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/action" ]},"delete" : {@@ -34011,6 +34040,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/card" ]}},@@ -34047,6 +34087,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/card" ]}},@@ -34313,6 +34364,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/card" ]},"put" : {@@ -34649,6 +34711,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/card" ]}},@@ -34684,6 +34757,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/card" ]}},@@ -35502,6 +35586,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/collection" ]},"post" : {@@ -35984,6 +36079,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/collection" ]}},@@ -36302,6 +36408,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/collection" ]}},@@ -36344,6 +36461,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/collection" ]},"put" : {@@ -36667,6 +36795,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/collection" ]}},@@ -37270,6 +37409,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/dashboard" ]}},@@ -38427,6 +38577,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/dashboard" ]},"delete" : {@@ -39009,6 +39170,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/dashboard" ]}},@@ -39054,6 +39226,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/dashboard" ]}},@@ -39091,6 +39274,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/dashboard" ]}},@@ -39201,6 +39395,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/dashboard" ]}},@@ -39608,6 +39813,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/database" ]},"post" : {@@ -39849,6 +40065,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/database" ]},"put" : {@@ -40091,6 +40318,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/database" ]}},@@ -40135,6 +40373,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/database" ]}},@@ -40503,6 +40752,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/database" ]}},@@ -40586,6 +40846,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/database" ]}},@@ -40660,6 +40931,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/database" ]}},@@ -43433,25 +43715,25 @@"type" : "object","properties" : {"allowed_hosts" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.allowed-hosts"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.allowed-hosts"},"bundle_path" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.bundle-path"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.bundle-path"},"description" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.description"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.description"},"display_name" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.display-name"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.display-name"},"enabled" : {"type" : "boolean"},"name" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.slug"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.slug"},"version" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.version"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.version"}},"required" : [ "name" ],@@ -43625,22 +43907,22 @@"type" : "object","properties" : {"allowed_hosts" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.allowed-hosts"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.allowed-hosts"},"bundle_path" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.bundle-path"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.bundle-path"},"description" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.description"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.description"},"display_name" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.display-name"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.display-name"},"enabled" : {"type" : "boolean"},"version" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.version"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.version"}},"additionalProperties" : false@@ -43899,7 +44181,7 @@"type" : "object","properties" : {"bundle" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-apps.schema.bundle-text"+ "$ref" : "#/components/schemas/metabase.data-apps.schema.bundle-text"}},"required" : [ "bundle" ],@@ -47777,7 +48059,7 @@"get" : {"operationId" : "get-api-ee-dependencies-backfill-status","summary" : "GET /api/ee/dependencies/backfill-status",- "description" : "Whether no entity awaits the computation of its dependencies, as `complete`, for superusers.",+ "description" : "Whether no entity awaits the computation of its dependencies, as `complete`, and the entities whose dependencies\n the job gave up computing until they change, as `failed`, for superusers. Those don't count as awaiting, so the\n graph is only whole when `complete` is true and `failed` is empty.","parameters" : [ ],"responses" : {"2XX" : {@@ -47789,9 +48071,26 @@"properties" : {"complete" : {"type" : "boolean"+ },+ "failed" : {+ "type" : "array",+ "items" : {+ "type" : "object",+ "properties" : {+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "type" : {+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"+ }+ },+ "required" : [ "type", "id" ]+ }}},- "required" : [ "complete" ]+ "required" : [ "complete", "failed" ]}}}@@ -50068,8 +50367,10 @@"name" : "model_id","required" : true,"schema" : {- "type" : "string"- }+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."}, {"in" : "query","name" : "action_type",@@ -52640,12 +52941,14 @@"required" : false,"schema" : {"oneOf" : [ {- "type" : "string"+ "description" : "name of directory and archive file (default: `<instance-name>-<YYYY-MM-dd_HH-mm>`): 1-255 characters from A-Z a-z 0-9 _ - . %, not starting with . or -",+ "type" : "string",+ "pattern" : "^[A-Za-z0-9_%][A-Za-z0-9._%-]{0,254}$"}, {"type" : "null"} ]},- "description" : "name of directory and archive file (default: `<instance-name>-<YYYY-MM-dd_HH-mm>`)"+ "description" : "name of directory and archive file (default: `<instance-name>-<YYYY-MM-dd_HH-mm>`): 1-255 characters from A-Z a-z 0-9 _ - . %, not starting with . or -"}, {"in" : "query","name" : "collection",@@ -55887,14 +56190,14 @@},"effective-type" : {"oneOf" : [ {- "type" : "string"+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"}, {"type" : "null"} ]},"semantic-type" : {"oneOf" : [ {- "type" : "string"+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"}, {"type" : "null"} ]@@ -56723,6 +57026,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/field" ]},"put" : {@@ -57011,6 +57325,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/field" ]}},@@ -57057,6 +57382,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/field" ]}},@@ -57132,6 +57468,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/field" ]}},@@ -57161,6 +57508,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/field" ]}},@@ -57190,6 +57548,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/field" ]},"post" : {@@ -67686,6 +68055,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/search" ]}},@@ -69826,7 +70206,7 @@"put" : {"operationId" : "put-api-table","summary" : "PUT /api/table",- "description" : "Update all `Table` in `ids`.\n\n Deprecated, should use PUT /table/edit from now on.",+ "description" : "Update all `Table` in `ids`.\n\n Deprecated: use `POST /api/data-studio/table/edit`.","parameters" : [ ],"responses" : {"2XX" : {@@ -69911,6 +70291,15 @@"type" : "null"} ]},+ "collection_id" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ },"data_source" : {"oneOf" : [ {"type" : "string"@@ -69932,6 +70321,14 @@"type" : "null"} ]},+ "field_order" : {+ "oneOf" : [ {+ "type" : "string",+ "enum" : [ "alphabetical", "custom", "database", "smart" ]+ }, {+ "type" : "null"+ } ]+ },"description" : {"oneOf" : [ {"type" : "string"@@ -70004,6 +70401,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/table" ]}},@@ -70044,6 +70452,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/table" ]},"put" : {@@ -70382,6 +70801,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/table" ]}},@@ -70447,6 +70877,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/table" ]}},@@ -71602,7 +72043,7 @@"name" : "archived","required" : false,"schema" : {- "default" : "false",+ "default" : false,"type" : "boolean"}}, {@@ -77337,6 +77778,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/user-key-value" ]},"delete" : {@@ -77371,6 +77823,17 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }+ },"tags" : [ "/api/user-key-value" ]}},