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
Update generated docs (master) (#66865)
github-automation-metabase900bc0c1aa65
diff --git a/docs/api.json b/docs/api.jsonindex 343da13842f..61ec3505886 100644--- a/docs/api.json+++ b/docs/api.json@@ -1137,6 +1137,57 @@"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-expression"} ]},+ "metabase-enterprise.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" : {+ "type" : "string"+ }+ },+ "required" : [ "id", "db_id", "name", "display_name", "is_published" ]+ },+ "metabase-enterprise.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-enterprise.data-studio.api.table.bulk-table-info"+ }+ },+ "selected_table" : {+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"+ },+ "unpublished_upstream_tables" : {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"+ }+ }+ },+ "required" : [ "published_downstream_tables", "unpublished_upstream_tables" ]+ },"metabase-enterprise.data-studio.api.table.data-authorities" : {"type" : "string","enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]@@ -1149,6 +1200,16 @@"type" : "string","enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]},+ "metabase-enterprise.data-studio.api.table.publish-tables-response" : {+ "description" : "Schema for /publish-tables endpoint response. Matches frontend PublishTablesResponse type.",+ "type" : "object",+ "properties" : {+ "target_collection" : {+ "description" : "value must be an instance of :model/Collection"+ }+ },+ "required" : [ ]+ },"metabase-enterprise.data-studio.api.table.table-selectors" : {"type" : "object","properties" : {@@ -2168,6 +2229,20 @@"required" : [ "output" ]} ]},+ "metabase-enterprise.metabot-v3.tools.api.get-dashboard-details-arguments" : {+ "allOf" : [ {+ "type" : "object",+ "properties" : {+ "dashboard_id" : {+ "type" : "integer"+ }+ },+ "required" : [ "dashboard_id" ]+ }, {+ "type" : "object",+ "properties" : { }+ } ]+ },"metabase-enterprise.metabot-v3.tools.api.get-dashboard-details-result" : {"anyOf" : [ {"type" : "object",@@ -2295,6 +2370,16 @@"required" : [ "output" ]} ]},+ "metabase-enterprise.metabot-v3.tools.api.get-query-details-arguments" : {+ "type" : "object",+ "properties" : {+ "query" : {+ "type" : "object",+ "properties" : { }+ }+ },+ "required" : [ "query" ]+ },"metabase-enterprise.metabot-v3.tools.api.get-query-details-result" : {"anyOf" : [ {"type" : "object",@@ -3243,7 +3328,8 @@"properties" : { }} ]},- "metabase-enterprise.metabot-v3.tools.api.tool-request" : {+ "metabase-enterprise.metabot-v3.tools.deftool.tool-request" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -4605,14 +4691,6 @@"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.UnnamedAggregation"} ]},- "metabase.legacy-mbql.schema.AggregationArg" : {- "description" : "Schema for the argument to an aggregation clause like `:sum`.\n\n Strings are allowed as literals here, unlike at the top level as `::Expressions`, so `::FieldOrExpressionDef` is\n not enough. However, nested aggregations are not allowed here, so we can't use `::ExpressionArg` either. (#66199)",- "anyOf" : [ {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionDef"- }, {- "type" : "string"- } ]- },"metabase.legacy-mbql.schema.AggregationOptionsOptions" : {"description" : "Additional options for any aggregation clause when wrapping it in `:aggregation-options`.","type" : "object",@@ -4632,6 +4710,9 @@},"minItems" : 1},+ "metabase.legacy-mbql.schema.AnyMBQLClause" : {+ "description" : "Schema for ANY valid MBQL clause"+ },"metabase.legacy-mbql.schema.ArithmeticDateTimeUnit" : {"type" : "string","enum" : [ "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year" ]@@ -5299,6 +5380,8 @@"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemporalLiteral"}, {"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"+ }, {+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation"}, {"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRefOrRelativeDatetime"} ]@@ -5524,53 +5607,7 @@"enum" : [ "hour", "second", "default", "hour-of-day", "millisecond", "minute-of-hour", "minute" ]},"metabase.legacy-mbql.schema.UnnamedAggregation" : {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpression"- }, {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.avg"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.cum-sum"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.distinct"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.distinct-where"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.stddev"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.sum"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.min"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.max"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.metric"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.share"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.count-where"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.sum-where"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.case"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.if"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.median"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.percentile"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.var"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.cum-count"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.count"- }, {- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.offset"- } ]- } ]+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.AnyMBQLClause"},"metabase.legacy-mbql.schema.ValueTypeInfo" : {"description" : "Type info about a value in a `:value` clause. Added automatically by `wrap-value-literals` middleware to values in filter clauses based on the Field in the clause.",@@ -5632,10 +5669,6 @@"description" : "schema for a valid MBQL 4 :asc clause","allOf" : [ ]},- "metabase.legacy-mbql.schema.avg" : {- "description" : "schema for a valid MBQL 4 :avg clause",- "allOf" : [ ]- },"metabase.legacy-mbql.schema.between" : {"description" : "schema for a valid MBQL 4 :between clause","allOf" : [ ]@@ -5674,22 +5707,6 @@"description" : "schema for a valid MBQL 4 :convert-timezone clause","allOf" : [ ]},- "metabase.legacy-mbql.schema.count" : {- "description" : "schema for a valid MBQL 4 :count clause",- "allOf" : [ ]- },- "metabase.legacy-mbql.schema.count-where" : {- "description" : "schema for a valid MBQL 4 :count-where clause",- "allOf" : [ ]- },- "metabase.legacy-mbql.schema.cum-count" : {- "description" : "schema for a valid MBQL 4 :cum-count clause",- "allOf" : [ ]- },- "metabase.legacy-mbql.schema.cum-sum" : {- "description" : "schema for a valid MBQL 4 :cum-sum clause",- "allOf" : [ ]- },"metabase.legacy-mbql.schema.date" : {"description" : "schema for a valid MBQL 4 :date clause","allOf" : [ ]@@ -5718,14 +5735,6 @@"description" : "schema for a valid MBQL 4 :desc clause","allOf" : [ ]},- "metabase.legacy-mbql.schema.distinct" : {- "description" : "schema for a valid MBQL 4 :distinct clause",- "allOf" : [ ]- },- "metabase.legacy-mbql.schema.distinct-where" : {- "description" : "schema for a valid MBQL 4 :distinct-where clause",- "allOf" : [ ]- },"metabase.legacy-mbql.schema.does-not-contain" : {"description" : "Schema for a valid MBQL 4 :metabase.legacy-mbql.schema/does-not-contain clause.","anyOf" : [ {@@ -6083,22 +6092,6 @@"description" : "schema for a valid MBQL 4 :ltrim clause","allOf" : [ ]},- "metabase.legacy-mbql.schema.max" : {- "description" : "schema for a valid MBQL 4 :max clause",- "allOf" : [ ]- },- "metabase.legacy-mbql.schema.median" : {- "description" : "schema for a valid MBQL 4 :median clause",- "allOf" : [ ]- },- "metabase.legacy-mbql.schema.metric" : {- "description" : "schema for a valid MBQL 4 :metric clause",- "allOf" : [ ]- },- "metabase.legacy-mbql.schema.min" : {- "description" : "schema for a valid MBQL 4 :min clause",- "allOf" : [ ]- },"metabase.legacy-mbql.schema.month-name" : {"description" : "schema for a valid MBQL 4 :month-name clause","allOf" : [ ]@@ -6140,10 +6133,6 @@"description" : "schema for a valid MBQL 4 :path clause","allOf" : [ ]},- "metabase.legacy-mbql.schema.percentile" : {- "description" : "schema for a valid MBQL 4 :percentile clause",- "allOf" : [ ]- },"metabase.legacy-mbql.schema.power" : {"description" : "schema for a valid MBQL 4 :power clause","allOf" : [ ]@@ -6183,10 +6172,6 @@"description" : "schema for a valid MBQL 4 :segment clause","allOf" : [ ]},- "metabase.legacy-mbql.schema.share" : {- "description" : "schema for a valid MBQL 4 :share clause",- "allOf" : [ ]- },"metabase.legacy-mbql.schema.split-part" : {"description" : "schema for a valid MBQL 4 :split-part clause","allOf" : [ ]@@ -6205,10 +6190,6 @@"allOf" : [ ]} ]},- "metabase.legacy-mbql.schema.stddev" : {- "description" : "schema for a valid MBQL 4 :stddev clause",- "allOf" : [ ]- },"metabase.legacy-mbql.schema.subdomain" : {"description" : "schema for a valid MBQL 4 :subdomain clause","allOf" : [ ]@@ -6217,14 +6198,6 @@"description" : "schema for a valid MBQL 4 :substring clause","allOf" : [ ]},- "metabase.legacy-mbql.schema.sum" : {- "description" : "schema for a valid MBQL 4 :sum clause",- "allOf" : [ ]- },- "metabase.legacy-mbql.schema.sum-where" : {- "description" : "schema for a valid MBQL 4 :sum-where clause",- "allOf" : [ ]- },"metabase.legacy-mbql.schema.temporal-extract" : {"description" : "schema for a valid MBQL 4 :temporal-extract clause","allOf" : [ ]@@ -6257,10 +6230,6 @@"description" : "schema for a valid MBQL 4 :value clause","allOf" : [ ]},- "metabase.legacy-mbql.schema.var" : {- "description" : "schema for a valid MBQL 4 :var clause",- "allOf" : [ ]- },"metabase.lib.metadata.column.column-unique-key" : {"type" : "string","pattern" : "^column-unique-key-v\\d+\\$.+$"@@ -11627,7 +11596,7 @@"/api/card/{card-id}/params/{param-key}/search/{query}" : {"get" : {"summary" : "GET /api/card/{card-id}/params/{param-key}/search/{query}",- "description" : "Fetch possible values of the parameter whose ID is `:param-key` that contain `:query`.\n\n ;; fetch values for Card 1 parameter 'abc' that contain 'Orange';\n GET /api/card/1/params/abc/search/Orange\n\n Currently limited to first 1000 results.",+ "description" : "Fetch possible values of the parameter whose ID is `:param-key` that contain `:query`.\n\n ;; fetch values for Card 1 parameter 'abc' that contain 'Orange';\n GET /api/queries/1/params/abc/search/Orange\n\n Currently limited to first 1000 results.","parameters" : [ {"in" : "path","name" : "card-id",@@ -11670,7 +11639,7 @@"/api/card/{card-id}/params/{param-key}/values" : {"get" : {"summary" : "GET /api/card/{card-id}/params/{param-key}/values",- "description" : "Fetch possible values of the parameter whose ID is `:param-key`.\n\n ;; fetch values for Card 1 parameter 'abc' that are possible\n GET /api/card/1/params/abc/values",+ "description" : "Fetch possible values of the parameter whose ID is `:param-key`.\n\n ;; fetch values for Card 1 parameter 'abc' that are possible\n GET /api/queries/1/params/abc/values","parameters" : [ {"in" : "path","name" : "card-id",@@ -12041,7 +12010,7 @@},"delete" : {"summary" : "DELETE /api/card/{id}",- "description" : "Hard delete a Card. To soft delete, use `PUT /api/card/:id`",+ "description" : "Hard delete a Card. To soft delete, use `PUT /api/queries/:id`","parameters" : [ {"in" : "path","name" : "id",@@ -12125,7 +12094,7 @@"/api/card/{id}/params/{param-key}/remapping" : {"get" : {"summary" : "GET /api/card/{id}/params/{param-key}/remapping",- "description" : "Fetch the remapped value for a given value of the parameter with ID `:param-key`.\n\n ;; fetch the remapped value for Card 1 parameter 'abc' for value 100\n GET /api/card/1/params/abc/remapping?value=100",+ "description" : "Fetch the remapped value for a given value of the parameter with ID `:param-key`.\n\n ;; fetch the remapped value for Card 1 parameter 'abc' for value 100\n GET /api/queries/1/params/abc/remapping?value=100","parameters" : [ {"in" : "path","name" : "id",@@ -12840,7 +12809,7 @@"type" : "array","items" : {"type" : "string",- "enum" : [ "dashboard", "dataset", "no_models", "timeline", "snippet", "collection", "document", "pulse", "metric", "card" ]+ "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "document", "pulse", "metric", "card" ]}}}, {@@ -13255,7 +13224,7 @@"type" : "array","items" : {"type" : "string",- "enum" : [ "dashboard", "dataset", "no_models", "timeline", "snippet", "collection", "document", "pulse", "metric", "card" ]+ "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "document", "pulse", "metric", "card" ]}}}, {@@ -13384,18 +13353,27 @@"tags" : [ "/api/collection" ]}},- "/api/dashboard/" : {+ "/api/comment/" : {"get" : {- "summary" : "GET /api/dashboard/",- "description" : "This endpoint is currently unused by the Metabase frontend and may be out of date with the rest of the application.\n It only exists for backwards compatibility and may be removed in the future.\n\n Get `Dashboards`. With filter option `f` (default `all`), restrict results as follows:\n * `all` - Return all Dashboards.\n * `mine` - Return Dashboards created by the current user.\n * `archived` - Return Dashboards that have been archived. (By default, these are *excluded*.)",+ "summary" : "GET /api/comment/",+ "description" : "Get comments for an entity","parameters" : [ {"in" : "query",- "name" : "f",- "required" : false,+ "name" : "target_type",+ "required" : true,"schema" : {"type" : "string",- "enum" : [ "all", "mine", "archived" ]+ "enum" : [ "document" ]}+ }, {+ "in" : "query",+ "name" : "target_id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."} ],"responses" : {"2XX" : {@@ -13408,12 +13386,11 @@"description" : "Server error response"}},- "deprecated" : true,- "tags" : [ "/api/dashboard" ]+ "tags" : [ "/api/comment" ]},"post" : {- "summary" : "POST /api/dashboard/",- "description" : "Create a new Dashboard.",+ "summary" : "POST /api/comment/",+ "description" : "Create a new comment","parameters" : [ ],"responses" : {"2XX" : {@@ -13432,44 +13409,42 @@"schema" : {"type" : "object","properties" : {- "cache_ttl" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1+ "child_target_id" : {+ "type" : "string"},- "collection_id" : {+ "content" : {+ "type" : "object"+ },+ "html" : {+ "type" : "string"+ },+ "parent_comment_id" : {"description" : "value must be an integer greater than zero.","type" : "integer","minimum" : 1},- "collection_position" : {+ "target_id" : {"description" : "value must be an integer greater than zero.","type" : "integer","minimum" : 1},- "description" : {- "type" : "string"- },- "name" : {+ "target_type" : {"type" : "string",- "minLength" : 1- },- "parameters" : {- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"+ "enum" : [ "document" ]}},- "required" : [ "name" ]+ "required" : [ "target_type", "target_id", "content", "html" ]}}}},- "tags" : [ "/api/dashboard" ]+ "tags" : [ "/api/comment" ]}},- "/api/dashboard/embeddable" : {+ "/api/comment/mentions" : {"get" : {- "summary" : "GET /api/dashboard/embeddable",- "description" : "Fetch a list of Dashboards where `enable_embedding` is `true`. The dashboards can be embedded using the embedding\n endpoints and a signed JWT.",+ "summary" : "GET /api/comment/mentions",+ "description" : "Get a list of entities suitable for mentions. NOTE: only users for now.","parameters" : [ ],"responses" : {"2XX" : {@@ -13482,33 +13457,22 @@"description" : "Server error response"}},- "tags" : [ "/api/dashboard" ]+ "tags" : [ "/api/comment" ]}},- "/api/dashboard/params/valid-filter-fields" : {- "get" : {- "summary" : "GET /api/dashboard/params/valid-filter-fields",- "description" : "Utility endpoint for powering Dashboard UI. Given some set of `filtered` Field IDs (presumably Fields used in\n parameters) and a set of `filtering` Field IDs that will be used to restrict values of `filtered` Fields, for each\n `filtered` Field ID return the subset of `filtering` Field IDs that would actually be used in a chain filter query\n with these Fields.\n\n e.g. in a chain filter query like\n\n GET /api/dashboard/10/params/PARAM_1/values?PARAM_2=100\n\n Assume `PARAM_1` maps to Field 1 and `PARAM_2` maps to Fields 2 and 3. The underlying MBQL query may or may not\n filter against Fields 2 and 3, depending on whether an FK relationship that lets us create a join against Field 1\n can be found. You can use this endpoint to determine which of those Fields is actually used:\n\n GET /api/dashboard/params/valid-filter-fields?filtered=1&filtering=2&filtering=3\n ;; ->\n {1 [2 3]}\n\n Results are returned as a map of\n\n `filtered` Field ID -> subset of `filtering` Field IDs that would be used in chain filter query",+ "/api/comment/{comment-id}" : {+ "put" : {+ "summary" : "PUT /api/comment/{comment-id}",+ "description" : "Update a comment","parameters" : [ {- "in" : "query",- "name" : "filtered",+ "in" : "path",+ "name" : "comment-id","required" : true,"schema" : {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"- }- }- }, {- "in" : "query",- "name" : "filtering",- "required" : false,- "schema" : {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"- }- }+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."} ],"responses" : {"2XX" : {@@ -13521,34 +13485,62 @@"description" : "Server error response"}},- "tags" : [ "/api/dashboard" ]- }- },- "/api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {- "post" : {- "summary" : "POST /api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",- "description" : "Run a pivot table query for a specific DashCard.",- "parameters" : [ {- "in" : "path",- "name" : "dashboard-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "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",+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "content" : {+ "type" : "object"+ },+ "html" : {+ "type" : "string"+ },+ "is_resolved" : {+ "type" : "boolean"+ }+ }+ }+ }+ }+ },+ "tags" : [ "/api/comment" ]+ },+ "delete" : {+ "summary" : "DELETE /api/comment/{comment-id}",+ "description" : "Soft delete a comment",+ "parameters" : [ {+ "in" : "path",+ "name" : "comment-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/comment" ]+ }+ },+ "/api/comment/{comment-id}/reaction" : {+ "post" : {+ "summary" : "POST /api/comment/{comment-id}/reaction",+ "description" : "Toggle a reaction on a comment",+ "parameters" : [ {+ "in" : "path",+ "name" : "comment-id","required" : true,"schema" : {"type" : "integer",@@ -13573,37 +13565,50 @@"schema" : {"type" : "object","properties" : {- "parameters" : {- "type" : "array",- "items" : {- "description" : "value must be a parameter map with an 'id' key",- "allOf" : [ {- "type" : "object",- "properties" : {- "id" : {- "type" : "string",- "minLength" : 1- }- },- "required" : [ "id" ]- }, {- "type" : "object",- "additionalProperties" : { }- } ]- }+ "emoji" : {+ "type" : "string",+ "minLength" : 1,+ "maxLength" : 10}- }+ },+ "required" : [ "emoji" ]}}}},- "tags" : [ "/api/dashboard" ]+ "tags" : [ "/api/comment" ]}},- "/api/dashboard/public" : {+ "/api/dashboard/" : {"get" : {- "summary" : "GET /api/dashboard/public",- "description" : "Fetch a list of Dashboards with public UUIDs. These dashboards are publicly-accessible *if* public sharing is\n enabled.",+ "summary" : "GET /api/dashboard/",+ "description" : "This endpoint is currently unused by the Metabase frontend and may be out of date with the rest of the application.\n It only exists for backwards compatibility and may be removed in the future.\n\n Get `Dashboards`. With filter option `f` (default `all`), restrict results as follows:\n * `all` - Return all Dashboards.\n * `mine` - Return Dashboards created by the current user.\n * `archived` - Return Dashboards that have been archived. (By default, these are *excluded*.)",+ "parameters" : [ {+ "in" : "query",+ "name" : "f",+ "required" : false,+ "schema" : {+ "type" : "string",+ "enum" : [ "all", "mine", "archived" ]+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "deprecated" : true,+ "tags" : [ "/api/dashboard" ]+ },+ "post" : {+ "summary" : "POST /api/dashboard/",+ "description" : "Create a new Dashboard.","parameters" : [ ],"responses" : {"2XX" : {@@ -13616,13 +13621,50 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "cache_ttl" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "collection_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "collection_position" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "description" : {+ "type" : "string"+ },+ "name" : {+ "type" : "string",+ "minLength" : 1+ },+ "parameters" : {+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"+ }+ },+ "required" : [ "name" ]+ }+ }+ }+ },"tags" : [ "/api/dashboard" ]}},- "/api/dashboard/save" : {- "post" : {- "summary" : "POST /api/dashboard/save",- "description" : "Save a denormalized description of dashboard.",+ "/api/dashboard/embeddable" : {+ "get" : {+ "summary" : "GET /api/dashboard/embeddable",+ "description" : "Fetch a list of Dashboards where `enable_embedding` is `true`. The dashboards can be embedded using the embedding\n endpoints and a signed JWT.","parameters" : [ ],"responses" : {"2XX" : {@@ -13638,19 +13680,30 @@"tags" : [ "/api/dashboard" ]}},- "/api/dashboard/save/collection/{parent-collection-id}" : {- "post" : {- "summary" : "POST /api/dashboard/save/collection/{parent-collection-id}",- "description" : "Save a denormalized description of dashboard into collection with ID `:parent-collection-id`.",+ "/api/dashboard/params/valid-filter-fields" : {+ "get" : {+ "summary" : "GET /api/dashboard/params/valid-filter-fields",+ "description" : "Utility endpoint for powering Dashboard UI. Given some set of `filtered` Field IDs (presumably Fields used in\n parameters) and a set of `filtering` Field IDs that will be used to restrict values of `filtered` Fields, for each\n `filtered` Field ID return the subset of `filtering` Field IDs that would actually be used in a chain filter query\n with these Fields.\n\n e.g. in a chain filter query like\n\n GET /api/dashboard/10/params/PARAM_1/values?PARAM_2=100\n\n Assume `PARAM_1` maps to Field 1 and `PARAM_2` maps to Fields 2 and 3. The underlying MBQL query may or may not\n filter against Fields 2 and 3, depending on whether an FK relationship that lets us create a join against Field 1\n can be found. You can use this endpoint to determine which of those Fields is actually used:\n\n GET /api/dashboard/params/valid-filter-fields?filtered=1&filtering=2&filtering=3\n ;; ->\n {1 [2 3]}\n\n Results are returned as a map of\n\n `filtered` Field ID -> subset of `filtering` Field IDs that would be used in chain filter query","parameters" : [ {- "in" : "path",- "name" : "parent-collection-id",+ "in" : "query",+ "name" : "filtered","required" : true,"schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"+ }+ }+ }, {+ "in" : "query",+ "name" : "filtering",+ "required" : false,+ "schema" : {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"+ }+ }} ],"responses" : {"2XX" : {@@ -13666,10 +13719,10 @@"tags" : [ "/api/dashboard" ]}},- "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {+ "/api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {"post" : {- "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",- "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it.",+ "summary" : "POST /api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",+ "description" : "Run a pivot table query for a specific DashCard.","parameters" : [ {"in" : "path","name" : "dashboard-id",@@ -13715,10 +13768,6 @@"schema" : {"type" : "object","properties" : {- "dashboard_load_id" : {- "type" : "string",- "minLength" : 1- },"parameters" : {"type" : "array","items" : {@@ -13746,45 +13795,11 @@"tags" : [ "/api/dashboard" ]}},- "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}" : {- "post" : {- "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}",- "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it, and return\n its results as a file in the specified format.\n\n `parameters` should be passed as query parameter encoded as a serialized JSON string (this is because this endpoint\n is normally used to power 'Download Results' buttons that use HTML `form` actions).",- "parameters" : [ {- "in" : "path",- "name" : "dashboard-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "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"- }- } ],+ "/api/dashboard/public" : {+ "get" : {+ "summary" : "GET /api/dashboard/public",+ "description" : "Fetch a list of Dashboards with public UUIDs. These dashboards are publicly-accessible *if* public sharing is\n enabled.",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response"@@ -13796,17 +13811,197 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "type" : "object",- "properties" : {- "format_rows" : {- "default" : false,- "type" : "boolean"- },- "parameters" : {+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/save" : {+ "post" : {+ "summary" : "POST /api/dashboard/save",+ "description" : "Save a denormalized description of dashboard.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/save/collection/{parent-collection-id}" : {+ "post" : {+ "summary" : "POST /api/dashboard/save/collection/{parent-collection-id}",+ "description" : "Save a denormalized description of dashboard into collection with ID `:parent-collection-id`.",+ "parameters" : [ {+ "in" : "path",+ "name" : "parent-collection-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {+ "post" : {+ "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",+ "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it.",+ "parameters" : [ {+ "in" : "path",+ "name" : "dashboard-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "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."+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "dashboard_load_id" : {+ "type" : "string",+ "minLength" : 1+ },+ "parameters" : {+ "type" : "array",+ "items" : {+ "description" : "value must be a parameter map with an 'id' key",+ "allOf" : [ {+ "type" : "object",+ "properties" : {+ "id" : {+ "type" : "string",+ "minLength" : 1+ }+ },+ "required" : [ "id" ]+ }, {+ "type" : "object",+ "additionalProperties" : { }+ } ]+ }+ }+ }+ }+ }+ }+ },+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}" : {+ "post" : {+ "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}",+ "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it, and return\n its results as a file in the specified format.\n\n `parameters` should be passed as query parameter encoded as a serialized JSON string (this is because this endpoint\n is normally used to power 'Download Results' buttons that use HTML `form` actions).",+ "parameters" : [ {+ "in" : "path",+ "name" : "dashboard-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "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"+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "format_rows" : {+ "default" : false,+ "type" : "boolean"+ },+ "parameters" : {"anyOf" : [ {"type" : "array","items" : {@@ -15945,10 +16140,10 @@"tags" : [ "/api/dataset" ]}},- "/api/ee/action-v2/execute" : {- "post" : {- "summary" : "POST /api/ee/action-v2/execute",- "description" : "Execute an action with a single input.\n\n Takes:\n - `action` - an identifier or an expression for what we want to execute.\n - `scope` - where the action is being invoked from.\n - `input` - a single map. currently these are typically a database table row pk, or query result.\n - `params` (optional) - a map of values for the parameters taken by the action's mapping.\n\n The `input` and `params` are used by the relevant mapping to calculate a map argument to the underlying action fn.\n If there is no mapping, `params` are simply used as overrides for `input`.\n\n Returns the outputs from the performed action.",+ "/api/document/" : {+ "get" : {+ "summary" : "GET /api/document/",+ "description" : "Gets existing `Documents`.","parameters" : [ ],"responses" : {"2XX" : {@@ -15961,39 +16156,11 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "type" : "object",- "properties" : {- "action" : {- "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"- },- "input" : {- "type" : "object",- "properties" : { }- },- "params" : {- "type" : "object",- "properties" : { }- },- "scope" : {- "$ref" : "#/components/schemas/metabase.actions.types..scope.raw"- }- },- "required" : [ "action", "scope" ]- }- }- }- },- "tags" : [ "/api/ee/action-v2" ]- }- },- "/api/ee/action-v2/execute-bulk" : {+ "tags" : [ "/api/document" ]+ },"post" : {- "summary" : "POST /api/ee/action-v2/execute-bulk",- "description" : "Execute an action with multiple inputs.\n\n This is typically more efficient than calling execute with each input individually, for example by performing batch\n SQL operations.\n\n Takes:\n - `action` - an identifier or an expression for what we want to execute.\n - `scope` - where the action is being invoked from.\n - `inputs` - a list of maps. currently these are typically a database table row pk, or query result.\n - `params` (optional) - a map of values for the parameters taken by the action's mapping.\n\n The `inputs` and `params` are used by the relevant mapping to calculate a list of args for the underlying action fn.\n If there is no mapping, `params` are simply used as overrides for each map within `inputs`.\n\n Returns the outputs from the performed action.",+ "summary" : "POST /api/document/",+ "description" : "Create a new `Document`.","parameters" : [ ],"responses" : {"2XX" : {@@ -16012,93 +16179,129 @@"schema" : {"type" : "object","properties" : {- "action" : {- "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"- },- "inputs" : {- "type" : "array",- "items" : {- "type" : "object",- "properties" : { }- },- "minItems" : 1- },- "params" : {+ "cards" : {"type" : "object",- "additionalProperties" : { }- },- "scope" : {- "$ref" : "#/components/schemas/metabase.actions.types..scope.raw"- }- },- "required" : [ "action", "scope", "inputs" ]- }+ "additionalProperties" : {+ "type" : "object",+ "properties" : {+ "visualization_settings" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ },+ "entity_id" : {+ "type" : "string",+ "minLength" : 1+ },+ "dataset_query" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ },+ "parameter_mappings" : {+ "type" : "array",+ "items" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ }+ },+ "name" : {+ "type" : "string",+ "minLength" : 1+ },+ "result_metadata" : {+ "type" : "array",+ "items" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ }+ },+ "cache_ttl" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "display" : {+ "type" : "string",+ "minLength" : 1+ },+ "parameters" : {+ "type" : "array",+ "items" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ }+ },+ "description" : {+ "type" : "string",+ "minLength" : 1+ }+ },+ "required" : [ "name", "dataset_query", "display", "visualization_settings" ]+ }+ },+ "collection_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "collection_position" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "document" : { },+ "name" : {+ "type" : "string",+ "minLength" : 1,+ "maxLength" : 254+ }+ },+ "required" : [ "name", "document" ]+ }}}},- "tags" : [ "/api/ee/action-v2" ]- }- },- "/api/ee/action-v2/execute-form" : {- "post" : {- "summary" : "POST /api/ee/action-v2/execute-form",- "description" : "Temporary endpoint for describing an actions parameters\n such that they can be presented correctly in a modal ahead of execution.",- "parameters" : [ ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/ee/action-v2" ]+ "tags" : [ "/api/document" ]}},- "/api/ee/advanced-permissions/application/graph" : {+ "/api/document/public" : {"get" : {- "summary" : "GET /api/ee/advanced-permissions/application/graph",- "description" : "Fetch a graph of Application Permissions.",+ "summary" : "GET /api/document/public",+ "description" : "List all Documents that have public links.\n\n Returns a sequence of Documents that have been publicly shared. Each Document includes its `:id`, `:name`,\n and `:public_uuid`. Documents are only actually accessible via the public endpoint if public sharing is\n currently enabled. Archived Documents are excluded from the results.\n\n This endpoint is used to populate the public links listing in the Admin settings UI.\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.","parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/ee/advanced-permissions/application" ]- },- "put" : {- "summary" : "PUT /api/ee/advanced-permissions/application/graph",- "description" : "Do a batch update of Application Permissions by passing a modified graph.",- "parameters" : [ {- "in" : "query",- "name" : "skip-graph",- "required" : false,- "schema" : {- "type" : "boolean",- "default" : false- }- }, {- "in" : "query",- "name" : "force",- "required" : false,- "schema" : {- "type" : "boolean",- "default" : false- }- } ],- "responses" : {- "2XX" : {- "description" : "Successful response"+ "description" : "sequence of map where {:name -> <string>, :id -> <value must be an integer greater than zero.>, :public_uuid -> <value must be a valid UUID.>}",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "array",+ "items" : {+ "type" : "object",+ "properties" : {+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "name" : {+ "type" : "string"+ },+ "public_uuid" : {+ "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}"+ }+ },+ "required" : [ "name", "id", "public_uuid" ]+ }+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -16107,36 +16310,17 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "type" : "object",- "properties" : { }- }- }- }- },- "tags" : [ "/api/ee/advanced-permissions/application" ]+ "tags" : [ "/api/document" ]}},- "/api/ee/advanced-permissions/impersonation/" : {+ "/api/document/{document-id}" : {"get" : {- "summary" : "GET /api/ee/advanced-permissions/impersonation/",- "description" : "Fetch a list of all Impersonation policies currently in effect, or a single policy if both `group_id` and `db_id`\n are provided.",+ "summary" : "GET /api/document/{document-id}",+ "description" : "Returns an existing Document by ID.","parameters" : [ {- "in" : "query",- "name" : "group_id",- "required" : false,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "in" : "query",- "name" : "db_id",- "required" : false,+ "in" : "path",+ "name" : "document-id",+ "required" : true,"schema" : {"type" : "integer","minimum" : 1@@ -16154,16 +16338,14 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/advanced-permissions/impersonation" ]- }- },- "/api/ee/advanced-permissions/impersonation/{id}" : {- "delete" : {- "summary" : "DELETE /api/ee/advanced-permissions/impersonation/{id}",- "description" : "Delete a Connection Impersonation entry.",+ "tags" : [ "/api/document" ]+ },+ "put" : {+ "summary" : "PUT /api/document/{document-id}",+ "description" : "Updates an existing `Document`.","parameters" : [ {"in" : "path",- "name" : "id",+ "name" : "document-id","required" : true,"schema" : {"type" : "integer",@@ -16182,72 +16364,115 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/advanced-permissions/impersonation" ]- }- },- "/api/ee/ai-entity-analysis/analyze-chart" : {- "post" : {- "summary" : "POST /api/ee/ai-entity-analysis/analyze-chart",- "description" : "Analyze a chart image using an AI vision model. This function sends the image data to a separate external AI service\n for analysis.",- "parameters" : [ ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },"requestBody" : {"content" : {"application/json" : {"schema" : {"type" : "object","properties" : {- "description" : {- "type" : "string"- },- "image_base64" : {- "type" : "string"- },- "name" : {- "type" : "string"+ "archived" : {+ "type" : "boolean"},- "timeline_events" : {- "type" : "array",- "items" : {+ "cards" : {+ "type" : "object",+ "additionalProperties" : {"type" : "object","properties" : {- "description" : {- "type" : "string"- },- "name" : {- "type" : "string"+ "visualization_settings" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }},- "timestamp" : {- "type" : "string"+ "entity_id" : {+ "type" : "string",+ "minLength" : 1+ },+ "dataset_query" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ },+ "parameter_mappings" : {+ "type" : "array",+ "items" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ }+ },+ "name" : {+ "type" : "string",+ "minLength" : 1+ },+ "result_metadata" : {+ "type" : "array",+ "items" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ }+ },+ "cache_ttl" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "display" : {+ "type" : "string",+ "minLength" : 1+ },+ "parameters" : {+ "type" : "array",+ "items" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ }+ },+ "description" : {+ "type" : "string",+ "minLength" : 1}},- "required" : [ "name", "timestamp" ]+ "required" : [ "name", "dataset_query", "display", "visualization_settings" ]}+ },+ "collection_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "collection_position" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "document" : { },+ "name" : {+ "type" : "string",+ "minLength" : 1,+ "maxLength" : 254}- },- "required" : [ "image_base64" ]+ }}}}},- "tags" : [ "/api/ee/ai-entity-analysis" ]- }- },- "/api/ee/ai-sql-fixer/fix" : {- "post" : {- "summary" : "POST /api/ee/ai-sql-fixer/fix",- "description" : "Suggest fixes for a SQL query.",- "parameters" : [ ],+ "tags" : [ "/api/document" ]+ },+ "delete" : {+ "summary" : "DELETE /api/document/{document-id}",+ "description" : "Permanently deletes an archived Document.",+ "parameters" : [ {+ "in" : "path",+ "name" : "document-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ } ],"responses" : {"2XX" : {"description" : "Successful response"@@ -16259,40 +16484,39 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "type" : "object",- "properties" : {- "error_message" : {- "type" : "string"- },- "query" : {- "type" : "object",- "properties" : {- "database" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }- },- "required" : [ "database" ]- }- },- "required" : [ "query", "error_message" ]- }- }- }- },- "tags" : [ "/api/ee/ai-sql-fixer" ]+ "tags" : [ "/api/document" ]}},- "/api/ee/ai-sql-generation/generate" : {+ "/api/document/{document-id}/card/{card-id}/query/{export-format}" : {"post" : {- "summary" : "POST /api/ee/ai-sql-generation/generate",- "description" : "Generate a SQL query.",- "parameters" : [ ],+ "summary" : "POST /api/document/{document-id}/card/{card-id}/query/{export-format}",+ "description" : "Download query results for a Card embedded in a Document.\n\n Returns query results in the requested format. The user must have read access to the document\n to download results. If the card's query fails, standard query error responses are returned.\n\n Route parameters:\n - document-id: ID of the document containing the card\n - card-id: ID of the card to download results from\n - export-format: Output format (csv, xlsx, json)\n\n Body parameters (snake_case):\n - parameters: Optional query parameters (array of maps or JSON string)\n - format_rows: Whether to apply formatting to results (boolean, default false)\n - pivot_results: Whether to pivot results (boolean, default false)",+ "parameters" : [ {+ "in" : "path",+ "name" : "document-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" : {+ "type" : "string"+ }+ } ],"responses" : {"2XX" : {"description" : "Successful response"@@ -16310,32 +16534,68 @@"schema" : {"type" : "object","properties" : {- "database_id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1+ "format_rows" : {+ "default" : false,+ "type" : "boolean"},- "prompt" : {- "type" : "string",- "minLength" : 1+ "parameters" : {+ "anyOf" : [ {+ "type" : "array",+ "items" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ }+ }, {+ "description" : "value must be a valid JSON string.",+ "type" : "string"+ } ]+ },+ "pivot_results" : {+ "default" : false,+ "type" : "boolean"}},- "required" : [ "prompt", "database_id" ]+ "required" : [ "format_rows", "pivot_results" ]}}}},- "tags" : [ "/api/ee/ai-sql-generation" ]+ "tags" : [ "/api/document" ]}},- "/api/ee/audit-app/user/audit-info" : {- "get" : {- "summary" : "GET /api/ee/audit-app/user/audit-info",- "description" : "Gets audit info for the current user if he has permissions to access the audit collection.\n Otherwise return an empty map.",- "parameters" : [ ],+ "/api/document/{document-id}/public-link" : {+ "post" : {+ "summary" : "POST /api/document/{document-id}/public-link",+ "description" : "Generate a publicly-accessible UUID for a Document.\n\n Creates a public link that allows viewing the Document without authentication. If the Document already has\n a public UUID, returns the existing one rather than generating a new one. This enables sharing the Document\n via `GET /api/ee/public/document/:uuid`.\n\n Returns a map containing `:uuid` (the public UUID string).\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.",+ "parameters" : [ {+ "in" : "path",+ "name" : "document-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ } ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "map where {:uuid -> <value must be a valid UUID.>}",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "uuid" : {+ "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}"+ }+ },+ "required" : [ "uuid" ]+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -16344,16 +16604,14 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/audit-app/user" ]- }- },- "/api/ee/audit-app/user/{id}/subscriptions" : {+ "tags" : [ "/api/document" ]+ },"delete" : {- "summary" : "DELETE /api/ee/audit-app/user/{id}/subscriptions",- "description" : "Delete all Alert and DashboardSubscription subscriptions for a User (i.e., so they will no longer receive them).\n Archive all Alerts and DashboardSubscriptions created by the User. Only allowed for admins or for the current user.",+ "summary" : "DELETE /api/document/{document-id}/public-link",+ "description" : "Remove the public link for a Document.\n\n Deletes the public UUID from the Document, making it no longer accessible via the public sharing endpoint.\n This revokes public access to the Document - the existing public link will no longer work.\n\n Returns a 204 No Content response on success.\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.\n Throws a 404 if the Document doesn't exist, is archived, or doesn't have a public link.","parameters" : [ {"in" : "path",- "name" : "id",+ "name" : "document-id","required" : true,"schema" : {"type" : "integer",@@ -16372,13 +16630,13 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/audit-app/user" ]+ "tags" : [ "/api/document" ]}},- "/api/ee/autodescribe/card/summarize" : {+ "/api/ee/action-v2/execute" : {"post" : {- "summary" : "POST /api/ee/autodescribe/card/summarize",- "description" : "Summarize a question.",+ "summary" : "POST /api/ee/action-v2/execute",+ "description" : "Execute an action with a single input.\n\n Takes:\n - `action` - an identifier or an expression for what we want to execute.\n - `scope` - where the action is being invoked from.\n - `input` - a single map. currently these are typically a database table row pk, or query result.\n - `params` (optional) - a map of values for the parameters taken by the action's mapping.\n\n The `input` and `params` are used by the relevant mapping to calculate a map argument to the underlying action fn.\n If there is no mapping, `params` are simply used as overrides for `input`.\n\n Returns the outputs from the performed action.","parameters" : [ ],"responses" : {"2XX" : {@@ -16397,80 +16655,34 @@"schema" : {"type" : "object","properties" : {- "visualization_settings" : {- "description" : "Value must be a map.",+ "action" : {+ "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"+ },+ "input" : {"type" : "object","properties" : { }},- "dataset" : {- "type" : "boolean"- },- "dataset_query" : {- "description" : "Value must be a map.",+ "params" : {"type" : "object","properties" : { }},- "parameter_mappings" : {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"- }- },- "collection_position" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "result_metadata" : {- "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"- },- "collection_id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "cache_ttl" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "display" : {- "type" : "string",- "minLength" : 1- },- "parameters" : {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"- }- },- "description" : {- "type" : "string",- "minLength" : 1+ "scope" : {+ "$ref" : "#/components/schemas/metabase.actions.types..scope.raw"}},- "required" : [ "dataset_query", "display", "visualization_settings" ]+ "required" : [ "action", "scope" ]}}}},- "tags" : [ "/api/ee/autodescribe" ]+ "tags" : [ "/api/ee/action-v2" ]}},- "/api/ee/autodescribe/dashboard/summarize/{id}" : {+ "/api/ee/action-v2/execute-bulk" : {"post" : {- "summary" : "POST /api/ee/autodescribe/dashboard/summarize/{id}",- "description" : "Provide a summary of a dashboard.",- "parameters" : [ {- "in" : "path",- "name" : "id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- } ],+ "summary" : "POST /api/ee/action-v2/execute-bulk",+ "description" : "Execute an action with multiple inputs.\n\n This is typically more efficient than calling execute with each input individually, for example by performing batch\n SQL operations.\n\n Takes:\n - `action` - an identifier or an expression for what we want to execute.\n - `scope` - where the action is being invoked from.\n - `inputs` - a list of maps. currently these are typically a database table row pk, or query result.\n - `params` (optional) - a map of values for the parameters taken by the action's mapping.\n\n The `inputs` and `params` are used by the relevant mapping to calculate a list of args for the underlying action fn.\n If there is no mapping, `params` are simply used as overrides for each map within `inputs`.\n\n Returns the outputs from the performed action.",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response"@@ -16482,32 +16694,43 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/autodescribe" ]- }- },- "/api/ee/billing/" : {- "get" : {- "summary" : "GET /api/ee/billing/",- "description" : "Get billing information. This acts as a proxy between `metabase-billing-info-url` and the client,\n using the embedding token and signed in user's email to fetch the billing information.",- "parameters" : [ ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "action" : {+ "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"+ },+ "inputs" : {+ "type" : "array",+ "items" : {+ "type" : "object",+ "properties" : { }+ },+ "minItems" : 1+ },+ "params" : {+ "type" : "object",+ "additionalProperties" : { }+ },+ "scope" : {+ "$ref" : "#/components/schemas/metabase.actions.types..scope.raw"+ }+ },+ "required" : [ "action", "scope", "inputs" ]+ }+ }}},- "tags" : [ "/api/ee/billing" ]+ "tags" : [ "/api/ee/action-v2" ]}},- "/api/ee/cloud-add-ons/addons" : {- "get" : {- "summary" : "GET /api/ee/cloud-add-ons/addons",- "description" : "Get addons information from the Metabase Store API.",+ "/api/ee/action-v2/execute-form" : {+ "post" : {+ "summary" : "POST /api/ee/action-v2/execute-form",+ "description" : "Temporary endpoint for describing an actions parameters\n such that they can be presented correctly in a modal ahead of execution.","parameters" : [ ],"responses" : {"2XX" : {@@ -16520,13 +16743,13 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/cloud-add-ons" ]+ "tags" : [ "/api/ee/action-v2" ]}},- "/api/ee/cloud-add-ons/plans" : {+ "/api/ee/advanced-permissions/application/graph" : {"get" : {- "summary" : "GET /api/ee/cloud-add-ons/plans",- "description" : "Get plans information from the Metabase Store API.",+ "summary" : "GET /api/ee/advanced-permissions/application/graph",+ "description" : "Fetch a graph of Application Permissions.","parameters" : [ ],"responses" : {"2XX" : {@@ -16539,20 +16762,26 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/cloud-add-ons" ]- }- },- "/api/ee/cloud-add-ons/{product-type}" : {- "post" : {- "summary" : "POST /api/ee/cloud-add-ons/{product-type}",- "description" : "Purchase an add-on.",+ "tags" : [ "/api/ee/advanced-permissions/application" ]+ },+ "put" : {+ "summary" : "PUT /api/ee/advanced-permissions/application/graph",+ "description" : "Do a batch update of Application Permissions by passing a modified graph.","parameters" : [ {- "in" : "path",- "name" : "product-type",- "required" : true,+ "in" : "query",+ "name" : "skip-graph",+ "required" : false,"schema" : {- "type" : "string",- "enum" : [ "metabase-ai", "metabase-ai-tiered", "python-execution" ]+ "type" : "boolean",+ "default" : false+ }+ }, {+ "in" : "query",+ "name" : "force",+ "required" : false,+ "schema" : {+ "type" : "boolean",+ "default" : false}} ],"responses" : {@@ -16571,37 +16800,31 @@"application/json" : {"schema" : {"type" : "object",- "properties" : {- "quantity" : {- "type" : "integer"- },- "terms_of_service" : {- "type" : "boolean"- }- }+ "properties" : { }}}}},- "tags" : [ "/api/ee/cloud-add-ons" ]+ "tags" : [ "/api/ee/advanced-permissions/application" ]}},- "/api/comment/" : {+ "/api/ee/advanced-permissions/impersonation/" : {"get" : {- "summary" : "GET /api/comment/",- "description" : "Get comments for an entity",+ "summary" : "GET /api/ee/advanced-permissions/impersonation/",+ "description" : "Fetch a list of all Impersonation policies currently in effect, or a single policy if both `group_id` and `db_id`\n are provided.","parameters" : [ {"in" : "query",- "name" : "target_type",- "required" : true,+ "name" : "group_id",+ "required" : false,"schema" : {- "type" : "string",- "enum" : [ "document" ]- }+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."}, {"in" : "query",- "name" : "target_id",- "required" : true,+ "name" : "db_id",+ "required" : false,"schema" : {"type" : "integer","minimum" : 1@@ -16619,12 +16842,23 @@"description" : "Server error response"}},- "tags" : [ "/api/comment" ]- },- "post" : {- "summary" : "POST /api/comment/",- "description" : "Create a new comment",- "parameters" : [ ],+ "tags" : [ "/api/ee/advanced-permissions/impersonation" ]+ }+ },+ "/api/ee/advanced-permissions/impersonation/{id}" : {+ "delete" : {+ "summary" : "DELETE /api/ee/advanced-permissions/impersonation/{id}",+ "description" : "Delete a Connection Impersonation entry.",+ "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"@@ -16636,48 +16870,13 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "type" : "object",- "properties" : {- "child_target_id" : {- "type" : "string"- },- "content" : {- "type" : "object"- },- "html" : {- "type" : "string"- },- "parent_comment_id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "target_id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "target_type" : {- "type" : "string",- "enum" : [ "document" ]- }- },- "required" : [ "target_type", "target_id", "content", "html" ]- }- }- }- },- "tags" : [ "/api/comment" ]+ "tags" : [ "/api/ee/advanced-permissions/impersonation" ]}},- "/api/comment/mentions" : {- "get" : {- "summary" : "GET /api/comment/mentions",- "description" : "Get a list of entities suitable for mentions. NOTE: only users for now.",+ "/api/ee/ai-entity-analysis/analyze-chart" : {+ "post" : {+ "summary" : "POST /api/ee/ai-entity-analysis/analyze-chart",+ "description" : "Analyze a chart image using an AI vision model. This function sends the image data to a separate external AI service\n for analysis.","parameters" : [ ],"responses" : {"2XX" : {@@ -16690,23 +16889,53 @@"description" : "Server error response"}},- "tags" : [ "/api/comment" ]+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "description" : {+ "type" : "string"+ },+ "image_base64" : {+ "type" : "string"+ },+ "name" : {+ "type" : "string"+ },+ "timeline_events" : {+ "type" : "array",+ "items" : {+ "type" : "object",+ "properties" : {+ "description" : {+ "type" : "string"+ },+ "name" : {+ "type" : "string"+ },+ "timestamp" : {+ "type" : "string"+ }+ },+ "required" : [ "name", "timestamp" ]+ }+ }+ },+ "required" : [ "image_base64" ]+ }+ }+ }+ },+ "tags" : [ "/api/ee/ai-entity-analysis" ]}},- "/api/comment/{comment-id}" : {- "put" : {- "summary" : "PUT /api/comment/{comment-id}",- "description" : "Update a comment",- "parameters" : [ {- "in" : "path",- "name" : "comment-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- } ],+ "/api/ee/ai-sql-fixer/fix" : {+ "post" : {+ "summary" : "POST /api/ee/ai-sql-fixer/fix",+ "description" : "Suggest fixes for a SQL query.",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response"@@ -16724,63 +16953,34 @@"schema" : {"type" : "object","properties" : {- "content" : {- "type" : "object"- },- "html" : {+ "error_message" : {"type" : "string"},- "is_resolved" : {- "type" : "boolean"+ "query" : {+ "type" : "object",+ "properties" : {+ "database" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }+ },+ "required" : [ "database" ]}- }+ },+ "required" : [ "query", "error_message" ]}}}},- "tags" : [ "/api/comment" ]- },- "delete" : {- "summary" : "DELETE /api/comment/{comment-id}",- "description" : "Soft delete a comment",- "parameters" : [ {- "in" : "path",- "name" : "comment-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- } ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/comment" ]+ "tags" : [ "/api/ee/ai-sql-fixer" ]}},- "/api/comment/{comment-id}/reaction" : {+ "/api/ee/ai-sql-generation/generate" : {"post" : {- "summary" : "POST /api/comment/{comment-id}/reaction",- "description" : "Toggle a reaction on a comment",- "parameters" : [ {- "in" : "path",- "name" : "comment-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- } ],+ "summary" : "POST /api/ee/ai-sql-generation/generate",+ "description" : "Generate a SQL query.",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response"@@ -16798,28 +16998,43 @@"schema" : {"type" : "object","properties" : {- "emoji" : {+ "database_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "prompt" : {"type" : "string",- "minLength" : 1,- "maxLength" : 10+ "minLength" : 1}},- "required" : [ "emoji" ]+ "required" : [ "prompt", "database_id" ]}}}},- "tags" : [ "/api/comment" ]+ "tags" : [ "/api/ee/ai-sql-generation" ]}},- "/api/ee/content-translation/csv" : {- "get" : {- "summary" : "GET /api/ee/content-translation/csv",- "description" : "Provides content translation dictionary in CSV",+ "/api/ee/audit-app/analytics-dev/export" : {+ "post" : {+ "summary" : "POST /api/ee/audit-app/analytics-dev/export",+ "description" : "Export analytics content as a .tar.gz file for local development.\n\n Only available when MB_ANALYTICS_DEV_MODE=true. Returns a tarball containing\n the analytics YAMLs in canonical format, ready to commit to source control.\n\n Requires superuser permissions.","parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "map where {:body -> <anything>}",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "body" : { }+ },+ "required" : [ "body" ]+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -16828,39 +17043,13 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/content-translation" ]+ "tags" : [ "/api/ee/audit-app/analytics-dev" ]}},- "/api/ee/content-translation/dictionary/{token}" : {+ "/api/ee/audit-app/user/audit-info" : {"get" : {- "summary" : "GET /api/ee/content-translation/dictionary/{token}",- "description" : "Fetch the content translation dictionary via a JSON Web Token signed with the `embedding-secret-key`.",- "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/ee/content-translation" ]- }- },- "/api/ee/content-translation/upload-dictionary" : {- "post" : {- "summary" : "POST /api/ee/content-translation/upload-dictionary",- "description" : "Upload a CSV of content translations",+ "summary" : "GET /api/ee/audit-app/user/audit-info",+ "description" : "Gets audit info for the current user if he has permissions to access the audit collection.\n Otherwise return an empty map.","parameters" : [ ],"responses" : {"2XX" : {@@ -16873,36 +17062,23 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "multipart/form-data" : {- "schema" : {- "type" : "object",- "properties" : {- "file" : {- "type" : "object",- "properties" : {- "filename" : {- "type" : "string"- },- "tempfile" : { }- },- "required" : [ "filename", "tempfile" ]- }- },- "required" : [ "file" ]- }- }- }- },- "tags" : [ "/api/ee/content-translation" ]+ "tags" : [ "/api/ee/audit-app/user" ]}},- "/api/ee/data-studio/table/discard-values" : {- "post" : {- "summary" : "POST /api/ee/data-studio/table/discard-values",- "description" : "Batch version of /table/:id/discard_values. Takes an abstract table selection as /table/edit does.",- "parameters" : [ ],+ "/api/ee/audit-app/user/{id}/subscriptions" : {+ "delete" : {+ "summary" : "DELETE /api/ee/audit-app/user/{id}/subscriptions",+ "description" : "Delete all Alert and DashboardSubscription subscriptions for a User (i.e., so they will no longer receive them).\n Archive all Alerts and DashboardSubscriptions created by the User. Only allowed for admins or for the current user.",+ "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"@@ -16914,22 +17090,13 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"- }- }- }- },- "tags" : [ "/api/ee/data-studio/table" ]+ "tags" : [ "/api/ee/audit-app/user" ]}},- "/api/ee/data-studio/table/edit" : {+ "/api/ee/autodescribe/card/summarize" : {"post" : {- "summary" : "POST /api/ee/data-studio/table/edit",- "description" : "Bulk updating tables.",+ "summary" : "POST /api/ee/autodescribe/card/summarize",+ "description" : "Summarize a question.","parameters" : [ ],"responses" : {"2XX" : {@@ -16948,60 +17115,80 @@"schema" : {"type" : "object","properties" : {- "data_authority" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-authorities"+ "visualization_settings" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }},- "data_layer" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-layers"+ "dataset" : {+ "type" : "boolean"},- "table_ids" : {+ "dataset_query" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ },+ "parameter_mappings" : {"type" : "array","items" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"}},- "owner_email" : {- "type" : "string"+ "collection_position" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1},- "owner_user_id" : {- "type" : "integer"+ "result_metadata" : {+ "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"},- "data_source" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-sources"+ "collection_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1},- "schema_ids" : {- "type" : "array",- "items" : {- "type" : "string"- }+ "cache_ttl" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1},- "entity_type" : {- "type" : "string"+ "display" : {+ "type" : "string",+ "minLength" : 1},- "database_ids" : {+ "parameters" : {"type" : "array","items" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"}+ },+ "description" : {+ "type" : "string",+ "minLength" : 1}},- "additionalProperties" : false+ "required" : [ "dataset_query", "display", "visualization_settings" ]}}}},- "tags" : [ "/api/ee/data-studio/table" ]+ "tags" : [ "/api/ee/autodescribe" ]}},- "/api/ee/data-studio/table/publish-model" : {+ "/api/ee/autodescribe/dashboard/summarize/{id}" : {"post" : {- "summary" : "POST /api/ee/data-studio/table/publish-model",- "description" : "Create a model for each of selected tables",- "parameters" : [ ],+ "summary" : "POST /api/ee/autodescribe/dashboard/summarize/{id}",+ "description" : "Provide a summary of a dashboard.",+ "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"@@ -17013,55 +17200,13 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "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- }- },- "target_collection_id" : {- "anyOf" : [ {- "type" : "integer",- "minimum" : 1- }, {- "const" : "library"- } ]- }- },- "required" : [ ]- }- }- }- },- "tags" : [ "/api/ee/data-studio/table" ]+ "tags" : [ "/api/ee/autodescribe" ]}},- "/api/ee/data-studio/table/rescan-values" : {- "post" : {- "summary" : "POST /api/ee/data-studio/table/rescan-values",- "description" : "Batch version of /table/:id/rescan_values. Takes an abstract table selection as /table/edit does.",+ "/api/ee/billing/" : {+ "get" : {+ "summary" : "GET /api/ee/billing/",+ "description" : "Get billing information. This acts as a proxy between `metabase-billing-info-url` and the client,\n using the embedding token and signed in user's email to fetch the billing information.","parameters" : [ ],"responses" : {"2XX" : {@@ -17074,22 +17219,13 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"- }- }- }- },- "tags" : [ "/api/ee/data-studio/table" ]+ "tags" : [ "/api/ee/billing" ]}},- "/api/ee/data-studio/table/sync-schema" : {- "post" : {- "summary" : "POST /api/ee/data-studio/table/sync-schema",- "description" : "Batch version of /table/:id/sync_schema. Takes an abstract table selection as /table/edit does.\n - Currently checks policy before returning (so you might receive a 4xx on e.g. AuthZ policy failure)\n - The sync itself is however, asyncronous. This call may return before all tables synced.",+ "/api/ee/cloud-add-ons/addons" : {+ "get" : {+ "summary" : "GET /api/ee/cloud-add-ons/addons",+ "description" : "Get addons information from the Metabase Store API.","parameters" : [ ],"responses" : {"2XX" : {@@ -17102,31 +17238,40 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"- }- }+ "tags" : [ "/api/ee/cloud-add-ons" ]+ }+ },+ "/api/ee/cloud-add-ons/plans" : {+ "get" : {+ "summary" : "GET /api/ee/cloud-add-ons/plans",+ "description" : "Get plans information from the Metabase Store API.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"}},- "tags" : [ "/api/ee/data-studio/table" ]+ "tags" : [ "/api/ee/cloud-add-ons" ]}},- "/api/ee/database-replication/connection/{database-id}" : {+ "/api/ee/cloud-add-ons/{product-type}" : {"post" : {- "summary" : "POST /api/ee/database-replication/connection/{database-id}",- "description" : "Create a new PG replication connection for the specified database.",+ "summary" : "POST /api/ee/cloud-add-ons/{product-type}",+ "description" : "Purchase an add-on.","parameters" : [ {"in" : "path",- "name" : "database-id",+ "name" : "product-type","required" : true,"schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."+ "type" : "string",+ "enum" : [ "metabase-ai", "metabase-ai-tiered", "python-execution" ]+ }} ],"responses" : {"2XX" : {@@ -17145,38 +17290,50 @@"schema" : {"type" : "object","properties" : {- "replicationSchemaFilters" : {- "type" : "object",- "properties" : {- "schema-filters-patterns" : {- "type" : "string"- },- "schema-filters-type" : {- "type" : "string",- "enum" : [ "inclusion", "exclusion", "all" ]- }- },- "required" : [ "schema-filters-type", "schema-filters-patterns" ]+ "quantity" : {+ "type" : "integer"+ },+ "terms_of_service" : {+ "type" : "boolean"}}}}}},- "tags" : [ "/api/ee/database-replication" ]- },- "delete" : {- "summary" : "DELETE /api/ee/database-replication/connection/{database-id}",- "description" : "Delete PG replication connection for the specified database.",+ "tags" : [ "/api/ee/cloud-add-ons" ]+ }+ },+ "/api/ee/content-translation/csv" : {+ "get" : {+ "summary" : "GET /api/ee/content-translation/csv",+ "description" : "Provides content translation dictionary in CSV",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/ee/content-translation" ]+ }+ },+ "/api/ee/content-translation/dictionary/{token}" : {+ "get" : {+ "summary" : "GET /api/ee/content-translation/dictionary/{token}",+ "description" : "Fetch the content translation dictionary via a JSON Web Token signed with the `embedding-secret-key`.","parameters" : [ {"in" : "path",- "name" : "database-id",+ "name" : "token","required" : true,"schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."+ "type" : "string"+ }} ],"responses" : {"2XX" : {@@ -17189,23 +17346,14 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/database-replication" ]+ "tags" : [ "/api/ee/content-translation" ]}},- "/api/ee/database-replication/connection/{database-id}/preview" : {+ "/api/ee/content-translation/upload-dictionary" : {"post" : {- "summary" : "POST /api/ee/database-replication/connection/{database-id}/preview",- "description" : "Return info about pg-replication connection that is about to be created.",- "parameters" : [ {- "in" : "path",- "name" : "database-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- } ],+ "summary" : "POST /api/ee/content-translation/upload-dictionary",+ "description" : "Upload a CSV of content translations",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response"@@ -17219,46 +17367,44 @@},"requestBody" : {"content" : {- "application/json" : {+ "multipart/form-data" : {"schema" : {"type" : "object","properties" : {- "replicationSchemaFilters" : {+ "file" : {"type" : "object","properties" : {- "schema-filters-patterns" : {+ "filename" : {"type" : "string"},- "schema-filters-type" : {- "type" : "string",- "enum" : [ "inclusion", "exclusion", "all" ]- }+ "tempfile" : { }},- "required" : [ "schema-filters-type", "schema-filters-patterns" ]+ "required" : [ "filename", "tempfile" ]}- }+ },+ "required" : [ "file" ]}}}},- "tags" : [ "/api/ee/database-replication" ]+ "tags" : [ "/api/ee/content-translation" ]}},- "/api/ee/database-routing/destination-database" : {+ "/api/ee/data-studio/table/discard-values" : {"post" : {- "summary" : "POST /api/ee/database-routing/destination-database",- "description" : "Create new Destination Databases.\n\n Note that unlike the normal `POST /api/database` endpoint, does NOT check the details before adding the Database.\n\n This is OK, it's not an invariant that all database details are always valid, but it's something to note.",- "parameters" : [ {- "in" : "query",- "name" : "check_connection_details",- "required" : false,- "schema" : {- "type" : "boolean"- }- } ],+ "summary" : "POST /api/ee/data-studio/table/discard-values",+ "description" : "Batch version of /table/:id/discard_values. Takes an abstract table selection as /table/edit does.",+ "parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "null",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "null"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -17271,57 +17417,31 @@"content" : {"application/json" : {"schema" : {- "type" : "object",- "properties" : {- "destinations" : {- "type" : "array",- "items" : {- "type" : "object",- "properties" : {- "details" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- },- "name" : {- "type" : "string",- "minLength" : 1- }- },- "required" : [ "name", "details" ]- }- },- "router_database_id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }- },- "required" : [ "router_database_id", "destinations" ]+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"}}}},- "tags" : [ "/api/ee/database-routing" ]+ "tags" : [ "/api/ee/data-studio/table" ]}},- "/api/ee/database-routing/router-database/{id}" : {- "put" : {- "summary" : "PUT /api/ee/database-routing/router-database/{id}",- "description" : "Updates an existing Database with the `user_attribute` to route on. Will either:\n - turn an existing Database into a Router database\n - change the `user_attribute` used to route for an existing Router database, or\n - turn a Router database into a regular Database\n depending on the value of `user_attribute`",- "parameters" : [ {- "in" : "path",- "name" : "id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- } ],+ "/api/ee/data-studio/table/edit" : {+ "post" : {+ "summary" : "POST /api/ee/data-studio/table/edit",+ "description" : "Bulk updating tables.",+ "parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "map with no other keys",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : { },+ "additionalProperties" : false+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -17336,26 +17456,70 @@"schema" : {"type" : "object","properties" : {- "user_attribute" : {- "type" : "string",- "minLength" : 1+ "data_authority" : {+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-authorities"+ },+ "data_layer" : {+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-layers"+ },+ "table_ids" : {+ "type" : "array",+ "items" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }+ },+ "owner_email" : {+ "type" : "string"+ },+ "owner_user_id" : {+ "type" : "integer"+ },+ "data_source" : {+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-sources"+ },+ "schema_ids" : {+ "type" : "array",+ "items" : {+ "type" : "string"+ }+ },+ "entity_type" : {+ "type" : "string"+ },+ "database_ids" : {+ "type" : "array",+ "items" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }}- }+ },+ "additionalProperties" : false}}}},- "tags" : [ "/api/ee/database-routing" ]+ "tags" : [ "/api/ee/data-studio/table" ]}},- "/api/ee/dependencies/check_card" : {+ "/api/ee/data-studio/table/publish-tables" : {"post" : {- "summary" : "POST /api/ee/dependencies/check_card",- "description" : "Check a proposed edit to a card, and return the card IDs for those cards this edit will break.",+ "summary" : "POST /api/ee/data-studio/table/publish-tables",+ "description" : "Set collection for each of selected tables and all upstream dependencies recursively.","parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Schema for /publish-tables endpoint response. Matches frontend PublishTablesResponse type.",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.publish-tables-response"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -17368,22 +17532,29 @@"content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-body"+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"}}}},- "tags" : [ "/api/ee/dependencies" ]+ "tags" : [ "/api/ee/data-studio/table" ]}},- "/api/ee/dependencies/check_snippet" : {+ "/api/ee/data-studio/table/rescan-values" : {"post" : {- "summary" : "POST /api/ee/dependencies/check_snippet",- "description" : "Check a proposed edit to a native snippet, and return the cards, etc. which will be broken.",+ "summary" : "POST /api/ee/data-studio/table/rescan-values",+ "description" : "Batch version of /table/:id/rescan_values. Takes an abstract table selection as /table/edit does.","parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "null",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "null"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -17396,36 +17567,29 @@"content" : {"application/json" : {"schema" : {- "type" : "object",- "properties" : {- "content" : {- "type" : "string"- },- "id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "name" : {- "description" : "snippet names cannot include '}' or start with spaces"- }- },- "required" : [ "id" ]+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"}}}},- "tags" : [ "/api/ee/dependencies" ]+ "tags" : [ "/api/ee/data-studio/table" ]}},- "/api/ee/dependencies/check_transform" : {+ "/api/ee/data-studio/table/selection" : {"post" : {- "summary" : "POST /api/ee/dependencies/check_transform",- "description" : "Check a proposed edit to a transform, and return the card, transform, etc. IDs for things that will break.",+ "summary" : "POST /api/ee/data-studio/table/selection",+ "description" : "Gets information about selected tables","parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-selection-info"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -17438,46 +17602,29 @@"content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-body"+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"}}}},- "tags" : [ "/api/ee/dependencies" ]+ "tags" : [ "/api/ee/data-studio/table" ]}},- "/api/ee/dependencies/graph" : {- "get" : {- "summary" : "GET /api/ee/dependencies/graph",- "description" : "This endpoint takes an :id and a supported entity :type, and returns a graph of all its upstream dependencies.\n The graph is represented by a list of :nodes and a list of :edges. Each node has an :id, :type, :data (which\n depends on the node type), and a map of :dependent_counts per entity type. Each edge is a :model/Dependency.\n\n Optional :archived parameter controls whether entities in archived collections are included:\n - false (default): Excludes entities in archived collections\n - true: Includes entities in archived collections",- "parameters" : [ {- "in" : "query",- "name" : "id",- "required" : false,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "in" : "query",- "name" : "type",- "required" : false,- "schema" : {- "type" : "string",- "enum" : [ "table", "card", "snippet", "transform", "dashboard", "document", "sandbox" ]- }- }, {- "in" : "query",- "name" : "archived",- "required" : false,- "schema" : {- "type" : "boolean"- }- } ],+ "/api/ee/data-studio/table/sync-schema" : {+ "post" : {+ "summary" : "POST /api/ee/data-studio/table/sync-schema",+ "description" : "Batch version of /table/:id/sync_schema. Takes an abstract table selection as /table/edit does.\n - Currently checks policy before returning (so you might receive a 4xx on e.g. AuthZ policy failure)\n - The sync itself is however, asyncronous. This call may return before all tables synced.",+ "parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "null",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "null"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -17486,76 +17633,33 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/dependencies" ]- }- },- "/api/ee/dependencies/graph/dependents" : {- "get" : {- "summary" : "GET /api/ee/dependencies/graph/dependents",- "description" : "This endpoint takes an :id, :type, :dependent_type, and an optional :dependent_card_type, and returns a list of\n all that entity's dependents with :dependent_type. If the :dependent_type is :card, the dependents are further\n filtered by :dependent_card_type.\n\n Optional :archived parameter controls whether entities in archived collections are included:\n - false (default): Excludes entities in archived collections\n - true: Includes entities in archived collections",- "parameters" : [ {- "in" : "query",- "name" : "id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "in" : "query",- "name" : "type",- "required" : true,- "schema" : {- "type" : "string",- "enum" : [ "table", "card", "snippet", "transform", "dashboard", "document", "sandbox" ]- }- }, {- "in" : "query",- "name" : "dependent_type",- "required" : true,- "schema" : {- "type" : "string",- "enum" : [ "table", "card", "snippet", "transform", "dashboard", "document", "sandbox" ]- }- }, {- "in" : "query",- "name" : "dependent_card_type",- "required" : false,- "schema" : {- "type" : "string",- "enum" : [ "question", "model", "metric" ]- }- }, {- "in" : "query",- "name" : "archived",- "required" : false,- "schema" : {- "type" : "boolean"- }- } ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"+ }+ }}},- "tags" : [ "/api/ee/dependencies" ]+ "tags" : [ "/api/ee/data-studio/table" ]}},- "/api/document/" : {- "get" : {- "summary" : "GET /api/document/",- "description" : "Gets existing `Documents`.",+ "/api/ee/data-studio/table/unpublish-tables" : {+ "post" : {+ "summary" : "POST /api/ee/data-studio/table/unpublish-tables",+ "description" : "Unset collection for each of selected tables and all downstream dependents recursively.","parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "null",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "null"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -17564,12 +17668,32 @@"description" : "Server error response"}},- "tags" : [ "/api/document" ]- },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"+ }+ }+ }+ },+ "tags" : [ "/api/ee/data-studio/table" ]+ }+ },+ "/api/ee/database-replication/connection/{database-id}" : {"post" : {- "summary" : "POST /api/document/",- "description" : "Create a new `Document`.",- "parameters" : [ ],+ "summary" : "POST /api/ee/database-replication/connection/{database-id}",+ "description" : "Create a new PG replication connection for the specified database.",+ "parameters" : [ {+ "in" : "path",+ "name" : "database-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ } ],"responses" : {"2XX" : {"description" : "Successful response"@@ -17587,129 +17711,42 @@"schema" : {"type" : "object","properties" : {- "cards" : {- "type" : "object",- "additionalProperties" : {- "type" : "object",- "properties" : {- "visualization_settings" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- },- "entity_id" : {- "type" : "string",- "minLength" : 1- },- "dataset_query" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- },- "parameter_mappings" : {- "type" : "array",- "items" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- }- },- "name" : {- "type" : "string",- "minLength" : 1- },- "result_metadata" : {- "type" : "array",- "items" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- }- },- "cache_ttl" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "display" : {- "type" : "string",- "minLength" : 1- },- "parameters" : {- "type" : "array",- "items" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- }- },- "description" : {- "type" : "string",- "minLength" : 1- }- },- "required" : [ "name", "dataset_query", "display", "visualization_settings" ]- }- },- "collection_id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "collection_position" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "document" : { },- "name" : {- "type" : "string",- "minLength" : 1,- "maxLength" : 254- }- },- "required" : [ "name", "document" ]- }- }- }- },- "tags" : [ "/api/document" ]- }- },- "/api/document/public" : {- "get" : {- "summary" : "GET /api/document/public",- "description" : "List all Documents that have public links.\n\n Returns a sequence of Documents that have been publicly shared. Each Document includes its `:id`, `:name`,\n and `:public_uuid`. Documents are only actually accessible via the public endpoint if public sharing is\n currently enabled. Archived Documents are excluded from the results.\n\n This endpoint is used to populate the public links listing in the Admin settings UI.\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.",- "parameters" : [ ],- "responses" : {- "2XX" : {- "description" : "sequence of map where {:name -> <string>, :id -> <value must be an integer greater than zero.>, :public_uuid -> <value must be a valid UUID.>}",- "content" : {- "application/json" : {- "schema" : {- "type" : "array",- "items" : {+ "replicationSchemaFilters" : {"type" : "object","properties" : {- "id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "name" : {+ "schema-filters-patterns" : {"type" : "string"},- "public_uuid" : {- "description" : "value must be a valid UUID.",+ "schema-filters-type" : {"type" : "string",- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"+ "enum" : [ "inclusion", "exclusion", "all" ]}},- "required" : [ "name", "id", "public_uuid" ]+ "required" : [ "schema-filters-type", "schema-filters-patterns" ]}}}}+ }+ },+ "tags" : [ "/api/ee/database-replication" ]+ },+ "delete" : {+ "summary" : "DELETE /api/ee/database-replication/connection/{database-id}",+ "description" : "Delete PG replication connection for the specified database.",+ "parameters" : [ {+ "in" : "path",+ "name" : "database-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"},"4XX" : {"description" : "Client error response"@@ -17718,16 +17755,16 @@"description" : "Server error response"}},- "tags" : [ "/api/document" ]+ "tags" : [ "/api/ee/database-replication" ]}},- "/api/document/{document-id}" : {- "get" : {- "summary" : "GET /api/document/{document-id}",- "description" : "Returns an existing Document by ID.",+ "/api/ee/database-replication/connection/{database-id}/preview" : {+ "post" : {+ "summary" : "POST /api/ee/database-replication/connection/{database-id}/preview",+ "description" : "Return info about pg-replication connection that is about to be created.","parameters" : [ {"in" : "path",- "name" : "document-id",+ "name" : "database-id","required" : true,"schema" : {"type" : "integer",@@ -17746,20 +17783,44 @@"description" : "Server error response"}},- "tags" : [ "/api/document" ]- },- "put" : {- "summary" : "PUT /api/document/{document-id}",- "description" : "Updates an existing `Document`.",+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "replicationSchemaFilters" : {+ "type" : "object",+ "properties" : {+ "schema-filters-patterns" : {+ "type" : "string"+ },+ "schema-filters-type" : {+ "type" : "string",+ "enum" : [ "inclusion", "exclusion", "all" ]+ }+ },+ "required" : [ "schema-filters-type", "schema-filters-patterns" ]+ }+ }+ }+ }+ }+ },+ "tags" : [ "/api/ee/database-replication" ]+ }+ },+ "/api/ee/database-routing/destination-database" : {+ "post" : {+ "summary" : "POST /api/ee/database-routing/destination-database",+ "description" : "Create new Destination Databases.\n\n Note that unlike the normal `POST /api/database` endpoint, does NOT check the details before adding the Database.\n\n This is OK, it's not an invariant that all database details are always valid, but it's something to note.","parameters" : [ {- "in" : "path",- "name" : "document-id",- "required" : true,+ "in" : "query",+ "name" : "check_connection_details",+ "required" : false,"schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."+ "type" : "boolean"+ }} ],"responses" : {"2XX" : {@@ -17778,102 +17839,45 @@"schema" : {"type" : "object","properties" : {- "archived" : {- "type" : "boolean"- },- "cards" : {- "type" : "object",- "additionalProperties" : {+ "destinations" : {+ "type" : "array",+ "items" : {"type" : "object","properties" : {- "visualization_settings" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- },- "entity_id" : {- "type" : "string",- "minLength" : 1- },- "dataset_query" : {+ "details" : {"description" : "Value must be a map.","type" : "object","properties" : { }},- "parameter_mappings" : {- "type" : "array",- "items" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- }- },"name" : {"type" : "string","minLength" : 1- },- "result_metadata" : {- "type" : "array",- "items" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- }- },- "cache_ttl" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "display" : {- "type" : "string",- "minLength" : 1- },- "parameters" : {- "type" : "array",- "items" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- }- },- "description" : {- "type" : "string",- "minLength" : 1}},- "required" : [ "name", "dataset_query", "display", "visualization_settings" ]+ "required" : [ "name", "details" ]}},- "collection_id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "collection_position" : {+ "router_database_id" : {"description" : "value must be an integer greater than zero.","type" : "integer","minimum" : 1- },- "document" : { },- "name" : {- "type" : "string",- "minLength" : 1,- "maxLength" : 254}- }+ },+ "required" : [ "router_database_id", "destinations" ]}}}},- "tags" : [ "/api/document" ]- },- "delete" : {- "summary" : "DELETE /api/document/{document-id}",- "description" : "Permanently deletes an archived Document.",+ "tags" : [ "/api/ee/database-routing" ]+ }+ },+ "/api/ee/database-routing/router-database/{id}" : {+ "put" : {+ "summary" : "PUT /api/ee/database-routing/router-database/{id}",+ "description" : "Updates an existing Database with the `user_attribute` to route on. Will either:\n - turn an existing Database into a Router database\n - change the `user_attribute` used to route for an existing Router database, or\n - turn a Router database into a regular Database\n depending on the value of `user_attribute`","parameters" : [ {"in" : "path",- "name" : "document-id",+ "name" : "id","required" : true,"schema" : {"type" : "integer",@@ -17892,39 +17896,99 @@"description" : "Server error response"}},- "tags" : [ "/api/document" ]+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "user_attribute" : {+ "type" : "string",+ "minLength" : 1+ }+ }+ }+ }+ }+ },+ "tags" : [ "/api/ee/database-routing" ]}},- "/api/document/{document-id}/card/{card-id}/query/{export-format}" : {+ "/api/ee/dependencies/check_card" : {"post" : {- "summary" : "POST /api/document/{document-id}/card/{card-id}/query/{export-format}",- "description" : "Download query results for a Card embedded in a Document.\n\n Returns query results in the requested format. The user must have read access to the document\n to download results. If the card's query fails, standard query error responses are returned.\n\n Route parameters:\n - document-id: ID of the document containing the card\n - card-id: ID of the card to download results from\n - export-format: Output format (csv, xlsx, json)\n\n Body parameters (snake_case):\n - parameters: Optional query parameters (array of maps or JSON string)\n - format_rows: Whether to apply formatting to results (boolean, default false)\n - pivot_results: Whether to pivot results (boolean, default false)",- "parameters" : [ {- "in" : "path",- "name" : "document-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1+ "summary" : "POST /api/ee/dependencies/check_card",+ "description" : "Check a proposed edit to a card, and return the card IDs for those cards this edit will break.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"},- "description" : "value must be an integer greater than zero."- }, {- "in" : "path",- "name" : "card-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1+ "4XX" : {+ "description" : "Client error response"},- "description" : "value must be an integer greater than zero."- }, {- "in" : "path",- "name" : "export-format",- "required" : true,- "schema" : {- "type" : "string"+ "5XX" : {+ "description" : "Server error response"}- } ],+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-body"+ }+ }+ }+ },+ "tags" : [ "/api/ee/dependencies" ]+ }+ },+ "/api/ee/dependencies/check_snippet" : {+ "post" : {+ "summary" : "POST /api/ee/dependencies/check_snippet",+ "description" : "Check a proposed edit to a native snippet, and return the cards, etc. which will be broken.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "content" : {+ "type" : "string"+ },+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "name" : {+ "description" : "snippet names cannot include '}' or start with spaces"+ }+ },+ "required" : [ "id" ]+ }+ }+ }+ },+ "tags" : [ "/api/ee/dependencies" ]+ }+ },+ "/api/ee/dependencies/check_transform" : {+ "post" : {+ "summary" : "POST /api/ee/dependencies/check_transform",+ "description" : "Check a proposed edit to a transform, and return the card, transform, etc. IDs for things that will break.",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response"@@ -17940,70 +18004,46 @@"content" : {"application/json" : {"schema" : {- "type" : "object",- "properties" : {- "format_rows" : {- "default" : false,- "type" : "boolean"- },- "parameters" : {- "anyOf" : [ {- "type" : "array",- "items" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- }- }, {- "description" : "value must be a valid JSON string.",- "type" : "string"- } ]- },- "pivot_results" : {- "default" : false,- "type" : "boolean"- }- },- "required" : [ "format_rows", "pivot_results" ]+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-body"}}}},- "tags" : [ "/api/document" ]+ "tags" : [ "/api/ee/dependencies" ]}},- "/api/document/{document-id}/public-link" : {- "post" : {- "summary" : "POST /api/document/{document-id}/public-link",- "description" : "Generate a publicly-accessible UUID for a Document.\n\n Creates a public link that allows viewing the Document without authentication. If the Document already has\n a public UUID, returns the existing one rather than generating a new one. This enables sharing the Document\n via `GET /api/ee/public/document/:uuid`.\n\n Returns a map containing `:uuid` (the public UUID string).\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.",+ "/api/ee/dependencies/graph" : {+ "get" : {+ "summary" : "GET /api/ee/dependencies/graph",+ "description" : "This endpoint takes an :id and a supported entity :type, and returns a graph of all its upstream dependencies.\n The graph is represented by a list of :nodes and a list of :edges. Each node has an :id, :type, :data (which\n depends on the node type), and a map of :dependent_counts per entity type. Each edge is a :model/Dependency.\n\n Optional :archived parameter controls whether entities in archived collections are included:\n - false (default): Excludes entities in archived collections\n - true: Includes entities in archived collections","parameters" : [ {- "in" : "path",- "name" : "document-id",- "required" : true,+ "in" : "query",+ "name" : "id",+ "required" : false,"schema" : {"type" : "integer","minimum" : 1},"description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "type",+ "required" : false,+ "schema" : {+ "type" : "string",+ "enum" : [ "table", "card", "snippet", "transform", "dashboard", "document", "sandbox", "segment" ]+ }+ }, {+ "in" : "query",+ "name" : "archived",+ "required" : false,+ "schema" : {+ "type" : "boolean"+ }} ],"responses" : {"2XX" : {- "description" : "map where {:uuid -> <value must be a valid UUID.>}",- "content" : {- "application/json" : {- "schema" : {- "type" : "object",- "properties" : {- "uuid" : {- "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}"- }- },- "required" : [ "uuid" ]- }- }- }+ "description" : "Successful response"},"4XX" : {"description" : "Client error response"@@ -18012,20 +18052,53 @@"description" : "Server error response"}},- "tags" : [ "/api/document" ]- },- "delete" : {- "summary" : "DELETE /api/document/{document-id}/public-link",- "description" : "Remove the public link for a Document.\n\n Deletes the public UUID from the Document, making it no longer accessible via the public sharing endpoint.\n This revokes public access to the Document - the existing public link will no longer work.\n\n Returns a 204 No Content response on success.\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.\n Throws a 404 if the Document doesn't exist, is archived, or doesn't have a public link.",+ "tags" : [ "/api/ee/dependencies" ]+ }+ },+ "/api/ee/dependencies/graph/dependents" : {+ "get" : {+ "summary" : "GET /api/ee/dependencies/graph/dependents",+ "description" : "This endpoint takes an :id, :type, :dependent_type, and an optional :dependent_card_type, and returns a list of\n all that entity's dependents with :dependent_type. If the :dependent_type is :card, the dependents are further\n filtered by :dependent_card_type.\n\n Optional :archived parameter controls whether entities in archived collections are included:\n - false (default): Excludes entities in archived collections\n - true: Includes entities in archived collections","parameters" : [ {- "in" : "path",- "name" : "document-id",+ "in" : "query",+ "name" : "id","required" : true,"schema" : {"type" : "integer","minimum" : 1},"description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "type",+ "required" : true,+ "schema" : {+ "type" : "string",+ "enum" : [ "table", "card", "snippet", "transform", "dashboard", "document", "sandbox", "segment" ]+ }+ }, {+ "in" : "query",+ "name" : "dependent_type",+ "required" : true,+ "schema" : {+ "type" : "string",+ "enum" : [ "table", "card", "snippet", "transform", "dashboard", "document", "sandbox", "segment" ]+ }+ }, {+ "in" : "query",+ "name" : "dependent_card_type",+ "required" : false,+ "schema" : {+ "type" : "string",+ "enum" : [ "question", "model", "metric" ]+ }+ }, {+ "in" : "query",+ "name" : "archived",+ "required" : false,+ "schema" : {+ "type" : "boolean"+ }} ],"responses" : {"2XX" : {@@ -18038,7 +18111,7 @@"description" : "Server error response"}},- "tags" : [ "/api/document" ]+ "tags" : [ "/api/ee/dependencies" ]}},"/api/ee/email/override" : {@@ -18279,7 +18352,7 @@"/api/ee/library/" : {"post" : {"summary" : "POST /api/ee/library/",- "description" : "Creates the Library if it doesn't exist. Returns the created collection.\n\n Requires data-studio application permission.",+ "description" : "Creates the Library if it doesn't exist. Returns the created collection.\n\n Requires superuser permissions.","parameters" : [ ],"responses" : {"2XX" : {@@ -18366,10 +18439,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18394,6 +18468,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -18420,10 +18495,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18448,6 +18524,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -18474,10 +18551,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:output -> <string>, :conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18505,6 +18583,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -18531,10 +18610,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18559,6 +18639,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -18585,10 +18666,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18613,6 +18695,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -18639,10 +18722,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18667,6 +18751,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -18693,10 +18778,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:output -> <string>, :reactions -> <sequence of map where {:type -> <must equal :metabot.reaction/redirect>, :url -> <string>}>, :conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18730,6 +18816,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -18756,10 +18843,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18784,7 +18872,7 @@"content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.tool-request"+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"}}}@@ -18799,10 +18887,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18827,16 +18916,11 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {- "type" : "object",- "properties" : {- "dashboard_id" : {- "type" : "integer"- }- },- "required" : [ "dashboard_id" ]+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-dashboard-details-arguments"},"conversation_id" : {"description" : "value must be a valid UUID.",@@ -18855,14 +18939,15 @@"/api/ee/metabot-tools/get-document-details" : {"post" : {"summary" : "POST /api/ee/metabot-tools/get-document-details",- "description" : "Get information about a given report.",+ "description" : "Get information about a given document.","parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18887,6 +18972,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -18913,10 +18999,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18941,6 +19028,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -18967,10 +19055,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -18995,17 +19084,11 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {- "type" : "object",- "properties" : {- "query" : {- "type" : "object",- "properties" : { }- }- },- "required" : [ "query" ]+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-query-details-arguments"},"conversation_id" : {"description" : "value must be a valid UUID.",@@ -19028,10 +19111,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19056,6 +19140,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -19082,11 +19167,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "Schema for SQL snippet detail results",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {- "description" : "Schema for SQL snippet detail results",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19114,6 +19199,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -19140,11 +19226,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "Schema for SQL snippet list results",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {- "description" : "Schema for SQL snippet list results",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19175,7 +19261,7 @@"content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.tool-request"+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"}}}@@ -19190,10 +19276,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19218,6 +19305,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -19244,10 +19332,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19272,6 +19361,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -19298,10 +19388,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19326,6 +19417,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -19352,10 +19444,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19380,6 +19473,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -19406,10 +19500,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19434,7 +19529,7 @@"content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.tool-request"+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"}}}@@ -19449,10 +19544,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19477,6 +19573,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -19503,10 +19600,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19531,6 +19629,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -19557,10 +19656,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19585,6 +19685,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -19611,10 +19712,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19639,6 +19741,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -19665,10 +19768,11 @@"parameters" : [ ],"responses" : {"2XX" : {- "description" : "map where {:conversation_id -> <value must be a valid UUID.>}",+ "description" : "Base schema for all tool requests. Contains the conversation ID.","content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"conversation_id" : {@@ -19693,6 +19797,7 @@"content" : {"application/json" : {"schema" : {+ "description" : "Base schema for all tool requests. Contains the conversation ID.","type" : "object","properties" : {"arguments" : {@@ -20009,123 +20114,11 @@"parameters" : [ {"in" : "path","name" : "id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- }- } ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/ee/metabot-v3/metabot" ]- }- },- "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}" : {- "delete" : {- "summary" : "DELETE /api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}",- "description" : "Delete the prompt suggestion with ID `prompt-id` for the metabot instance with `id`.",- "parameters" : [ {- "in" : "path",- "name" : "id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- }- }, {- "in" : "path",- "name" : "prompt-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- }- } ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/ee/metabot-v3/metabot" ]- }- },- "/api/ee/permission_debug/" : {- "get" : {- "summary" : "GET /api/ee/permission_debug/",- "description" : "This endpoint expects a `user_id`, a `model_id` to debug permissions against, and `action_type`.\n The type of model we are debugging against is inferred by the `action_type`.\n\n It will return:\n - `decision`: The overall permission decision (\"allow\", \"denied\", or \"limited\")\n - `model-type`: The type of model being checked (e.g., \"question\")\n - `model-id`: The ID of the model being checked\n - `segment`: A set of segmentation types applied (e.g., \"sandboxed\", \"impersonated\", \"routed\")\n - `message`: A sequence of strings explaining the decision\n - `data`: A map containing details about permissions (table or collection names to group names)\n - `suggestions`: A map of group IDs to group names that could provide access\n\n Example requests:\n - Check if user can read a card: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/read`\n - Check if user can query a card: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/query`\n - Check if user can download data: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/download-data`\n\n Example responses:\n - Allowed access:\n ```json\n {\n \"decision\": \"allow\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User has permission to read this card\"],\n \"data\": {},\n \"suggestions\": {}\n }\n ```\n - Denied access with blocked table:\n ```json\n {\n \"decision\": \"denied\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User does not have permission to query this card\"],\n \"data\": {\"sample-db.PUBLIC.ORDERS\": [\"All Users\"]},\n \"suggestions\": {}\n }\n ```\n - Limited access:\n ```json\n {\n \"decision\": \"limited\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User has permission to download some data from this card\"],\n \"data\": {},\n \"suggestions\": {}\n }\n ```",- "parameters" : [ {- "in" : "query",- "name" : "user_id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- }- }, {- "in" : "query",- "name" : "model_id",- "required" : true,- "schema" : {- "type" : "string"- }- }, {- "in" : "query",- "name" : "action_type",- "required" : true,- "schema" : {- "type" : "string",- "enum" : [ "card/read", "card/query", "card/download-data" ]- }- } ],- "responses" : {- "2XX" : {- "description" : "map where {:model-type -> <enum of card, invalid>, :model-id -> <string>, :decision -> <enum of allow, denied, limited>, :segment -> <set of enum of sandboxed, impersonated, routed>, :message -> <sequence of string>, :data -> <map>, :suggestions -> <map from <integer> to <string>>}",- "content" : {- "application/json" : {- "schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.permission-debug.impl.perm-debug-info"- }- }- }- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/ee/permission_debug" ]- }- },- "/api/ee/public/document/{uuid}" : {- "get" : {- "summary" : "GET /api/ee/public/document/{uuid}",- "description" : "Fetch a publicly-accessible Document. Does not require auth credentials. Public sharing must be enabled.\n\n Returns a Document with sensitive fields removed (excludes collection_id, permissions, creator details, etc.).\n Includes all embedded Cards with their metadata hydrated so the frontend doesn't need to make separate\n requests for each card — just like public Dashboards do.",- "parameters" : [ {- "in" : "path",- "name" : "uuid",- "required" : true,- "schema" : {- "type" : "string",- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"- },- "description" : "value must be a valid UUID."+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ }} ],"responses" : {"2XX" : {@@ -20138,39 +20131,29 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/public" ]+ "tags" : [ "/api/ee/metabot-v3/metabot" ]}},- "/api/ee/public/document/{uuid}/card/{card-id}" : {- "get" : {- "summary" : "GET /api/ee/public/document/{uuid}/card/{card-id}",- "description" : "Run a query for a Card that's embedded in a public Document. Doesn't require auth credentials. Public sharing must\n be enabled.",+ "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}" : {+ "delete" : {+ "summary" : "DELETE /api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}",+ "description" : "Delete the prompt suggestion with ID `prompt-id` for the metabot instance with `id`.","parameters" : [ {"in" : "path",- "name" : "uuid",+ "name" : "id","required" : true,"schema" : {- "type" : "string",- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"- },- "description" : "value must be a valid UUID."+ "type" : "integer",+ "minimum" : 1+ }}, {"in" : "path",- "name" : "card-id",+ "name" : "prompt-id","required" : true,"schema" : {"type" : "integer","minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "in" : "query",- "name" : "parameters",- "required" : false,- "schema" : {- "type" : "string"- },- "description" : "value must be a valid JSON string."+ }} ],"responses" : {"2XX" : {@@ -20183,42 +20166,47 @@"description" : "Server error response"}},- "tags" : [ "/api/ee/public" ]+ "tags" : [ "/api/ee/metabot-v3/metabot" ]}},- "/api/ee/public/document/{uuid}/card/{card-id}/{export-format}" : {- "post" : {- "summary" : "POST /api/ee/public/document/{uuid}/card/{card-id}/{export-format}",- "description" : "Fetch a Card embedded in a public Document and return query results in the specified format.\n Does not require auth credentials. Public sharing must be enabled.",+ "/api/ee/permission_debug/" : {+ "get" : {+ "summary" : "GET /api/ee/permission_debug/",+ "description" : "This endpoint expects a `user_id`, a `model_id` to debug permissions against, and `action_type`.\n The type of model we are debugging against is inferred by the `action_type`.\n\n It will return:\n - `decision`: The overall permission decision (\"allow\", \"denied\", or \"limited\")\n - `model-type`: The type of model being checked (e.g., \"question\")\n - `model-id`: The ID of the model being checked\n - `segment`: A set of segmentation types applied (e.g., \"sandboxed\", \"impersonated\", \"routed\")\n - `message`: A sequence of strings explaining the decision\n - `data`: A map containing details about permissions (table or collection names to group names)\n - `suggestions`: A map of group IDs to group names that could provide access\n\n Example requests:\n - Check if user can read a card: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/read`\n - Check if user can query a card: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/query`\n - Check if user can download data: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/download-data`\n\n Example responses:\n - Allowed access:\n ```json\n {\n \"decision\": \"allow\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User has permission to read this card\"],\n \"data\": {},\n \"suggestions\": {}\n }\n ```\n - Denied access with blocked table:\n ```json\n {\n \"decision\": \"denied\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User does not have permission to query this card\"],\n \"data\": {\"sample-db.PUBLIC.ORDERS\": [\"All Users\"]},\n \"suggestions\": {}\n }\n ```\n - Limited access:\n ```json\n {\n \"decision\": \"limited\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User has permission to download some data from this card\"],\n \"data\": {},\n \"suggestions\": {}\n }\n ```","parameters" : [ {- "in" : "path",- "name" : "uuid",+ "in" : "query",+ "name" : "user_id","required" : true,"schema" : {- "type" : "string",- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"- },- "description" : "value must be a valid UUID."+ "type" : "integer",+ "minimum" : 1+ }}, {- "in" : "path",- "name" : "card-id",+ "in" : "query",+ "name" : "model_id","required" : true,"schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."+ "type" : "string"+ }}, {- "in" : "path",- "name" : "export-format",+ "in" : "query",+ "name" : "action_type","required" : true,"schema" : {- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"+ "type" : "string",+ "enum" : [ "card/read", "card/query", "card/download-data" ]}} ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "map where {:model-type -> <enum of card, invalid>, :model-id -> <string>, :decision -> <enum of allow, denied, limited>, :segment -> <set of enum of sandboxed, impersonated, routed>, :message -> <sequence of string>, :data -> <map>, :suggestions -> <map from <integer> to <string>>}",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.permission-debug.impl.perm-debug-info"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -20227,40 +20215,7 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "type" : "object",- "properties" : {- "format_rows" : {- "default" : false,- "type" : "boolean"- },- "parameters" : {- "anyOf" : [ {- "type" : "array",- "items" : {- "description" : "Value must be a map.",- "type" : "object",- "properties" : { }- }- }, {- "description" : "value must be a valid JSON string.",- "type" : "string"- } ]- },- "pivot_results" : {- "default" : false,- "type" : "boolean"- }- },- "required" : [ "format_rows", "pivot_results" ]- }- }- }- },- "tags" : [ "/api/ee/public" ]+ "tags" : [ "/api/ee/permission_debug" ]}},"/api/ee/remote-sync/branches" : {@@ -27603,6 +27558,156 @@"tags" : [ "/api/public" ]}},+ "/api/public/document/{uuid}" : {+ "get" : {+ "summary" : "GET /api/public/document/{uuid}",+ "description" : "Fetch a publicly-accessible Document. Does not require auth credentials. Public sharing must be enabled.\n\n Returns a Document with sensitive fields removed (excludes collection_id, permissions, creator details, etc.).\n Includes all embedded Cards with their metadata hydrated so the frontend doesn't need to make separate\n requests for each card — just like public Dashboards do.",+ "parameters" : [ {+ "in" : "path",+ "name" : "uuid",+ "required" : true,+ "schema" : {+ "type" : "string",+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"+ },+ "description" : "value must be a valid UUID."+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/public" ]+ }+ },+ "/api/public/document/{uuid}/card/{card-id}" : {+ "get" : {+ "summary" : "GET /api/public/document/{uuid}/card/{card-id}",+ "description" : "Run a query for a Card that's embedded in a public Document. Doesn't require auth credentials. Public sharing must\n be enabled.",+ "parameters" : [ {+ "in" : "path",+ "name" : "uuid",+ "required" : true,+ "schema" : {+ "type" : "string",+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"+ },+ "description" : "value must be a valid UUID."+ }, {+ "in" : "path",+ "name" : "card-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "parameters",+ "required" : false,+ "schema" : {+ "type" : "string"+ },+ "description" : "value must be a valid JSON string."+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/public" ]+ }+ },+ "/api/public/document/{uuid}/card/{card-id}/{export-format}" : {+ "post" : {+ "summary" : "POST /api/public/document/{uuid}/card/{card-id}/{export-format}",+ "description" : "Fetch a Card embedded in a public Document and return query results in the specified format.\n Does not require auth credentials. Public sharing must be enabled.",+ "parameters" : [ {+ "in" : "path",+ "name" : "uuid",+ "required" : true,+ "schema" : {+ "type" : "string",+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"+ },+ "description" : "value must be a valid UUID."+ }, {+ "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"+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "format_rows" : {+ "default" : false,+ "type" : "boolean"+ },+ "parameters" : {+ "anyOf" : [ {+ "type" : "array",+ "items" : {+ "description" : "Value must be a map.",+ "type" : "object",+ "properties" : { }+ }+ }, {+ "description" : "value must be a valid JSON string.",+ "type" : "string"+ } ]+ },+ "pivot_results" : {+ "default" : false,+ "type" : "boolean"+ }+ },+ "required" : [ "format_rows", "pivot_results" ]+ }+ }+ }+ },+ "tags" : [ "/api/public" ]+ }+ },"/api/public/oembed" : {"get" : {"summary" : "GET /api/public/oembed",@@ -31662,4 +31767,4 @@"url" : "http://localhost:3000","description" : "Localhost"} ]-}+}\ No newline at end of filediff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.mdindex 647054d1653..fc3dbd9462e 100644--- a/docs/configuring-metabase/config-template.md+++ b/docs/configuring-metabase/config-template.md@@ -223,10 +223,10 @@ config:report-timezone: nullreset-token-ttl-hours: 48retry-initial-interval: 500- retry-max-retries: 6+ retry-jitter-factor: 0.1retry-max-interval-millis: 30000+ retry-max-retries: 6retry-multiplier: 2.0- retry-jitter-factor: 0.1saml-application-name: Metabasesaml-attribute-email: nullsaml-attribute-firstname: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givennamediff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.mdindex 5f372b61aec..ebcb0890db5 100644--- a/docs/configuring-metabase/environment-variables.md+++ b/docs/configuring-metabase/environment-variables.md@@ -1371,13 +1371,13 @@ Number of hours a password reset is considered valid.The initial retry delay in milliseconds.-### `MB_RETRY_MAX_RETRIES`+### `MB_RETRY_JITTER_FACTOR`-- Type: integer-- Default: `6`-- [Configuration file name](./config-file.md): `retry-max-retries`+- Type: double+- Default: `0.1`+- [Configuration file name](./config-file.md): `retry-jitter-factor`-The maximum number of retries for a failed event.+The jitter factor of the retry delay.### `MB_RETRY_MAX_INTERVAL_MILLIS`@@ -1387,6 +1387,14 @@ The maximum number of retries for a failed event.The maximum delay between attempts.+### `MB_RETRY_MAX_RETRIES`++- Type: integer+- Default: `6`+- [Configuration file name](./config-file.md): `retry-max-retries`++The maximum number of retries for an event.+### `MB_RETRY_MULTIPLIER`- Type: double@@ -1395,14 +1403,6 @@ The maximum delay between attempts.The delay multiplier between attempts.-### `MB_RETRY_RANDOMIZATION_FACTOR`--- Type: double-- Default: `0.1`-- [Configuration file name](./config-file.md): `retry-jitter-factor`--The randomization factor of the retry delay.-### `MB_SAML_APPLICATION_NAME`> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.