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

github-automation-metabasef24251fb4e68
diff --git a/docs/api.json b/docs/api.json
index a1fb89f16f9..efb0f3a96e0 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -21270,6 +21270,20 @@
"$ref" : "#/components/schemas/metabase.metabot.schema.chart"
}
},
+ "client-ids" : {
+ "anyOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.schema.state-map-key"
+ },
+ "uniqueItems" : true
+ }, {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.schema.state-map-key"
+ }
+ } ]
+ },
"link-registry" : {
"type" : "object",
"additionalProperties" : {
@@ -38729,7 +38743,7 @@
"get" : {
"operationId" : "get-api-database",
"summary" : "GET /api/database",
- "description" : "Fetch all `Databases`.\n\n * `include=tables` means we should hydrate the Tables belonging to each DB. Default: `false`.\n\n * `include=schemas` hydrates a `:schemas` list on each DB (only schemas with visible\n tables the current user can read), matching the per-DB `/api/database/:id/schemas`\n response. Lets clients avoid N round-trips when populating a database/schema picker.\n\n * `saved` means we should include the saved questions virtual database. Default: `false`.\n\n * `include_editable_data_model` will only include DBs for which the current user has data model editing\n permissions. (If `include=tables`, this also applies to the list of tables in each DB). Should only be used if\n Enterprise Edition code is available the advanced-permissions feature is enabled.\n\n * `exclude_uneditable_details` will only include DBs for which the current user can edit the DB details. Has no\n effect unless Enterprise Edition code is available and the advanced-permissions feature is enabled.\n\n * `include_only_uploadable` will only include DBs into which Metabase can insert new data.\n\n * `can-query` will only include DBs for which the current user has query permissions. Default: `false`.\n\n * `can-write-metadata` will only include DBs for which the current user has data model editing permissions\n for at least one table in the database. Default: `false`.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for\n `:model/Database` in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user\n lacks permission to change the database details.",
+ "description" : "Fetch all `Databases`.\n\n * `include=tables` means we should hydrate the Tables belonging to each DB. Default: `false`.\n\n * `include=schemas` hydrates a `:schemas` list on each DB (only schemas with visible\n tables the current user can read), matching the per-DB `/api/database/:id/schemas`\n response. Lets clients avoid N round-trips when populating a database/schema picker.\n\n * `saved` means we should include the saved questions virtual database. Default: `false`.\n\n * `include_editable_data_model` will only include DBs for which the current user has data model editing\n permissions. (If `include=tables`, this also applies to the list of tables in each DB). Granting those\n permissions to non-admins requires Enterprise Edition code and the advanced-permissions feature; without both,\n this is admin-only.\n\n * `exclude_uneditable_details` will only include DBs for which the current user can edit the DB details. Has no\n effect unless Enterprise Edition code is available and the advanced-permissions feature is enabled.\n\n * `include_only_uploadable` will only include DBs into which Metabase can insert new data.\n\n * `can-query` will only include DBs for which the current user has query permissions. Default: `false`.\n\n * `can-write-metadata` will only include DBs for which the current user has data model editing permissions\n for at least one table in the database. Default: `false`.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for\n `:model/Database` in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user\n lacks permission to change the database details.",
"parameters" : [ {
"in" : "query",
"name" : "saved",
@@ -39034,7 +39048,7 @@
"get" : {
"operationId" : "get-api-database-id",
"summary" : "GET /api/database/{id}",
- "description" : "Get a single Database with `id`. Optionally pass `?include=tables` or `?include=tables.fields` to include the Tables\n belonging to this database, or the Tables and Fields, respectively. If the requestor has write permissions for the\n DB\n (i.e. is an admin or has data model permissions), then certain inferred secret values will also be included in the\n returned details (see [[metabase.secrets.models.secret/expand-db-details-inferred-secret-values]] for full details).\n\n Passing include_editable_data_model will only return tables for which the current user has data model editing\n permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present.\n In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID\n and tables, with no additional metadata.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for `:model/Database`\n in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user lacks permission to change the\n database details.",
+ "description" : "Get a single Database with `id`. Optionally pass `?include=tables` or `?include=tables.fields` to include the Tables\n belonging to this database, or the Tables and Fields, respectively. If the requestor has write permissions for the\n DB\n (i.e. is an admin or has data model permissions), then certain inferred secret values will also be included in the\n returned details (see [[metabase.secrets.models.secret/expand-db-details-inferred-secret-values]] for full details).\n\n Passing include_editable_data_model will only return tables for which the current user has data model editing\n permissions. Granting data model permissions to non-admins requires Enterprise Edition code and a token with the\n advanced-permissions feature; without both, this is admin-only. In addition, if the user has no data access for the\n DB (aka block permissions), it will return only the DB name, ID and tables, with no additional metadata.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for `:model/Database`\n in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user lacks permission to change the\n database details.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -39539,7 +39553,7 @@
"get" : {
"operationId" : "get-api-database-id-metadata",
"summary" : "GET /api/database/{id}/metadata",
- "description" : "Get metadata about a `Database`, including all of its `Tables` and `Fields`. Returns DB, fields, and field values.\n By default only non-hidden tables and fields are returned. Passing include_hidden=true includes them.\n\n Passing include_editable_data_model will only return tables for which the current user has data model editing\n permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present.\n In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID\n and tables, with no additional metadata.",
+ "description" : "Get metadata about a `Database`, including all of its `Tables` and `Fields`. Returns DB, fields, and field values.\n By default only non-hidden tables and fields are returned. Passing include_hidden=true includes them.\n\n Passing include_editable_data_model will only return tables for which the current user has data model editing\n permissions. Granting data model permissions to non-admins requires Enterprise Edition code and a token with the\n advanced-permissions feature; without both, this is admin-only. In addition, if the user has no data access for the\n DB (aka block permissions), it will return only the DB name, ID and tables, with no additional metadata.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -44787,6 +44801,91 @@
"tags" : [ "/api/ee/email" ]
}
},
+ "/api/ee/embedding-hub/checklist" : {
+ "get" : {
+ "operationId" : "get-api-ee-embedding-hub-checklist",
+ "summary" : "GET /api/ee/embedding-hub/checklist",
+ "description" : "Get the setup guide checklist status, indicating which setup steps have been completed.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "checklist" : {
+ "type" : "object",
+ "properties" : {
+ "enable-tenants" : {
+ "type" : "boolean"
+ },
+ "create-models" : {
+ "type" : "boolean"
+ },
+ "sso-configured" : {
+ "type" : "boolean"
+ },
+ "configure-row-column-security" : {
+ "type" : "boolean"
+ },
+ "create-test-embed" : {
+ "type" : "boolean"
+ },
+ "data-permissions-and-enable-tenants" : {
+ "type" : "boolean"
+ },
+ "embed-production" : {
+ "type" : "boolean"
+ },
+ "create-dashboard" : {
+ "type" : "boolean"
+ },
+ "move-dashboard-to-shared" : {
+ "type" : "boolean"
+ },
+ "setup-data-segregation-strategy" : {
+ "type" : "boolean"
+ },
+ "create-tenants" : {
+ "type" : "boolean"
+ },
+ "add-data" : {
+ "type" : "boolean"
+ },
+ "sso-auth-manual-tested" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "add-data", "create-dashboard", "create-models", "configure-row-column-security", "create-test-embed", "embed-production", "sso-configured", "data-permissions-and-enable-tenants", "enable-tenants", "move-dashboard-to-shared", "create-tenants", "setup-data-segregation-strategy", "sso-auth-manual-tested" ],
+ "additionalProperties" : false
+ },
+ "data-isolation-strategy" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "row-column-level-security", "connection-impersonation", "database-routing" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "checklist", "data-isolation-strategy" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/embedding-hub" ]
+ }
+ },
"/api/ee/erd" : {
"get" : {
"operationId" : "get-api-ee-erd",
@@ -51446,97 +51545,6 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embedding-hub/checklist" : {
- "get" : {
- "operationId" : "get-api-embedding-hub-checklist",
- "summary" : "GET /api/embedding-hub/checklist",
- "description" : "Get the setup guide checklist status, indicating which setup steps have been completed.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "checklist" : {
- "type" : "object",
- "properties" : {
- "enable-tenants" : {
- "type" : "boolean"
- },
- "create-models" : {
- "type" : "boolean"
- },
- "sso-configured" : {
- "type" : "boolean"
- },
- "configure-row-column-security" : {
- "type" : "boolean"
- },
- "create-custom-theme" : {
- "type" : "boolean"
- },
- "create-test-embed" : {
- "type" : "boolean"
- },
- "data-permissions-and-enable-tenants" : {
- "type" : "boolean"
- },
- "embed-production" : {
- "type" : "boolean"
- },
- "create-dashboard" : {
- "type" : "boolean"
- },
- "move-dashboard-to-shared" : {
- "type" : "boolean"
- },
- "configure-ai" : {
- "type" : "boolean"
- },
- "setup-data-segregation-strategy" : {
- "type" : "boolean"
- },
- "create-tenants" : {
- "type" : "boolean"
- },
- "add-data" : {
- "type" : "boolean"
- },
- "sso-auth-manual-tested" : {
- "type" : "boolean"
- }
- },
- "required" : [ "add-data", "create-dashboard", "create-models", "configure-row-column-security", "create-test-embed", "embed-production", "create-custom-theme", "configure-ai", "sso-configured", "data-permissions-and-enable-tenants", "enable-tenants", "move-dashboard-to-shared", "create-tenants", "setup-data-segregation-strategy", "sso-auth-manual-tested" ],
- "additionalProperties" : false
- },
- "data-isolation-strategy" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "row-column-level-security", "connection-impersonation", "database-routing" ]
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "checklist", "data-isolation-strategy" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/embedding-hub" ]
- }
- },
"/api/eval-trace/{session-id}" : {
"get" : {
"operationId" : "get-api-eval-trace-session-id",
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index d440c8a7991..7cc7b5b815c 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -147,7 +147,9 @@ config:
embedding-homepage: hidden
embedding-secret-key: null
enable-embedding-interactive: false
- enable-embedding-modular: false
+ enable-embedding-sdk: false
+ enable-embedding-simple: false
+ enable-embedding-static: false
enable-password-login: true
enable-pivoted-exports: true
enable-public-sharing: true
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 8c50f4b8b41..05d7ca83701 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -731,17 +731,7 @@ Allow admins to securely embed questions and dashboards within other application
Allow admins to embed Metabase via interactive embedding?
-### `MB_ENABLE_EMBEDDING_MODULAR`
-
-- Type: boolean
-- Default: `false`
-- [Configuration file name](./config-file.md): `enable-embedding-modular`
-
-Allow admins to embed Metabase via modular embedding, the SDK for React, and guest embeds?
-
-### `MB_ENABLE_EMBEDDING_SDK [DEPRECATED]`
-
-> DEPRECATED: 0.65.0
+### `MB_ENABLE_EMBEDDING_SDK`
- Type: boolean
- Default: `false`
@@ -749,9 +739,7 @@ Allow admins to embed Metabase via modular embedding, the SDK for React, and gue
Allow admins to embed Metabase via the SDK?
-### `MB_ENABLE_EMBEDDING_SIMPLE [DEPRECATED]`
-
-> DEPRECATED: 0.65.0
+### `MB_ENABLE_EMBEDDING_SIMPLE`
- Type: boolean
- Default: `false`
@@ -759,9 +747,7 @@ Allow admins to embed Metabase via the SDK?
Allow admins to embed Metabase via modular embedding?
-### `MB_ENABLE_EMBEDDING_STATIC [DEPRECATED]`
-
-> DEPRECATED: 0.65.0
+### `MB_ENABLE_EMBEDDING_STATIC`
- Type: boolean
- Default: `false`