Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Auto-update documentation for master (#70096)

github-automation-metabasee4d1706837c8
diff --git a/docs/api.json b/docs/api.json
index ff20f43410a..81a393c79f6 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -1,9 +1,4 @@
{
- "openapi" : "3.1.0",
- "info" : {
- "title" : "Metabase API documentation",
- "description" : "- **The API is subject to change.** We rarely change API endpoints, and almost never remove them, but if you write code that relies on the API, there's a chance you might have to update your code in the future.\n- **The API isn't versioned.** So don’t expect to stay on a particular version of Metabase in order to use a “stable” API.\n\n## API tutorial\n\nCheck out an introduction to the [Metabase API](https://www.metabase.com/learn/administration/metabase-api.html).\n\n## API keys\n\nCreate keys to authenticate programmatic requests to your Metabase. See [API keys](./people-and-groups/api-keys).\n\n## API changelog\n\nFor breaking changes, see the API [changelog](./developers-guide/api-changelog).\n\n## View the API docs for your Metabase\n\nYou can view the API docs for your Metabase by visiting `https://[your-metabase-url]/api/docs`.\n\n## Generating API docs\n\nYou can generate these docs by running:\n\n```\nclojure -M:ee:doc api-documentation\n```\n"
- },
"components" : {
"schemas" : {
"gsheets.response" : {
@@ -105,15 +100,6 @@
} ]
} ]
},
- "mbql.clause.!=" : { },
- "mbql.clause.*" : { },
- "mbql.clause.+" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-temporal-interval-schema"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-numeric-schema"
- } ]
- },
"mbql.clause.-" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-temporal-interval-schema"
@@ -127,11 +113,12 @@
} ]
} ]
},
- "mbql.clause./" : { },
- "mbql.clause.<" : {
+ "mbql.clause._BANG__EQ_" : { },
+ "mbql.clause._EQ_" : { },
+ "mbql.clause._GT_" : {
"type" : "array",
"prefixItems" : [ {
- "const" : "<"
+ "const" : ">"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
@@ -140,10 +127,10 @@
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
- "mbql.clause.<=" : {
+ "mbql.clause._GT__EQ_" : {
"type" : "array",
"prefixItems" : [ {
- "const" : "<="
+ "const" : ">="
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
@@ -152,11 +139,10 @@
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
- "mbql.clause.=" : { },
- "mbql.clause.>" : {
+ "mbql.clause._LT_" : {
"type" : "array",
"prefixItems" : [ {
- "const" : ">"
+ "const" : "<"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
@@ -165,10 +151,10 @@
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
- "mbql.clause.>=" : {
+ "mbql.clause._LT__EQ_" : {
"type" : "array",
"prefixItems" : [ {
- "const" : ">="
+ "const" : "<="
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
@@ -177,6 +163,15 @@
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
+ "mbql.clause._PLUS_" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-temporal-interval-schema"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-numeric-schema"
+ } ]
+ },
+ "mbql.clause._SLASH_" : { },
+ "mbql.clause._STAR_" : { },
"mbql.clause.abs" : {
"type" : "array",
"prefixItems" : [ {
@@ -5176,10 +5171,10 @@
"required" : [ "conversation_id" ]
},
"metabase-enterprise.metabot-v3.tools.transforms.transform-source" : {
- "$ref" : "#/components/schemas/metabase.transforms-rest.api.transform.transform-source"
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-source"
},
"metabase-enterprise.metabot-v3.tools.transforms.transform-target" : {
- "$ref" : "#/components/schemas/metabase.transforms-rest.api.transform.transform-target"
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
},
"metabase-enterprise.permission-debug.impl.group-id" : {
"type" : "integer"
@@ -6950,18 +6945,6 @@
"type" : "string",
"enum" : [ "default", "write-data" ]
},
- "metabase.legacy-mbql.schema.!=" : {
- "description" : "schema for a valid MBQL 4 :!= clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.*" : {
- "description" : "schema for a valid MBQL 4 :* clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.+" : {
- "description" : "schema for a valid MBQL 4 :+ clause",
- "allOf" : [ ]
- },
"metabase.legacy-mbql.schema.-" : {
"description" : "schema for a valid MBQL 4 :- clause",
"allOf" : [ ]
@@ -7241,6 +7224,14 @@
"type" : "null"
} ]
},
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "default", "hour", "hour-of-day", "millisecond", "minute", "minute-of-hour", "month", "month-of-year", "quarter", "quarter-of-year", "second", "second-of-minute", "week", "week-of-year", "year", "year-of-era" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/type" : {
"default" : "metadata/column",
"const" : "metadata/column"
@@ -7274,6 +7265,13 @@
"type" : "null"
} ]
},
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/original-expression-name" : {
"oneOf" : [ {
"type" : "string",
@@ -7306,15 +7304,29 @@
"type" : "null"
} ]
},
- "metabase.lib.field/temporal-unit" : {
+ "lib/original-effective-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/join-alias" : {
"oneOf" : [ {
"type" : "string",
- "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "default", "hour", "hour-of-day", "millisecond", "minute", "minute-of-hour", "month", "month-of-year", "quarter", "quarter-of-year", "second", "second-of-minute", "week", "week-of-year", "year", "year-of-era" ]
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "metabase.lib.field/binning" : {
+ "lib/internal-remap" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
"allOf" : [ {
@@ -7362,22 +7374,22 @@
"type" : "null"
} ]
},
- "lib/internal-remap" : {
+ "lib/original-join-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "metabase.lib.join/join-alias" : {
+ "lib/original-display-name" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/original-binning" : {
+ "lib/binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
"allOf" : [ {
@@ -7425,21 +7437,6 @@
"type" : "null"
} ]
},
- "lib/original-join-alias" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
"metabase.lib.metadata.result-metadata/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
@@ -7469,7 +7466,7 @@
"type" : "null"
} ]
},
- "metabase.lib.field/simple-display-name" : {
+ "lib/simple-display-name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
@@ -7487,30 +7484,6 @@
}
}
},
- "metabase.legacy-mbql.schema./" : {
- "description" : "schema for a valid MBQL 4 :/ clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.<" : {
- "description" : "schema for a valid MBQL 4 :< clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.<=" : {
- "description" : "schema for a valid MBQL 4 :<= clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.=" : {
- "description" : "schema for a valid MBQL 4 := clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.>" : {
- "description" : "schema for a valid MBQL 4 :> clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.>=" : {
- "description" : "schema for a valid MBQL 4 :>= clause",
- "allOf" : [ ]
- },
"metabase.legacy-mbql.schema.Addable" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpressionArg"
@@ -7595,17 +7568,17 @@
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.="
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._EQ_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.!="
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._BANG__EQ_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.<"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._LT_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.>"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._GT_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.<="
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._LT__EQ_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.>="
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._GT__EQ_"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.between"
}, {
@@ -7727,7 +7700,7 @@
"metabase.legacy-mbql.schema.DatetimeExpression" : {
"description" : "Schema for the definition of a date function expression.",
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.+"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._PLUS_"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime-add"
}, {
@@ -7937,87 +7910,91 @@
"metabase.legacy-mbql.schema.FieldRefOptions" : {
"description" : "Options for an MBQL 4 `:field` ref are the same as MBQL 5, except that `:lib/uuid` is not required and it cannot be\n empty.",
"oneOf" : [ {
- "default" : { },
- "type" : "object",
- "properties" : {
- "binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "inherited-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "database-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "display-name" : {
- "oneOf" : [ {
+ "allOf" : [ {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "inherited-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "database-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source-field-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "source-field-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "effective-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "base-type" : {
- "oneOf" : [ {
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "base-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/uuid" : {
+ "type" : "string",
+ "minLength" : 36,
+ "maxLength" : 36
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-effective-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "lib/uuid" : {
- "type" : "string",
- "minLength" : 36,
- "maxLength" : 36
- },
- "name" : {
- "oneOf" : [ {
+ },
+ "source-field" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ },
+ "lib/original-binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "source-field-join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "metabase.lib.field/original-effective-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "source-field" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- },
- "lib/original-binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "source-field-join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "semantic-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
- },
- "original-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "original-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }
}
- }
+ }, {
+ "allOf" : [ ]
+ } ]
}, {
"type" : "null"
} ]
@@ -8232,13 +8209,13 @@
"metabase.legacy-mbql.schema.NumericExpression" : {
"description" : "Schema for the definition of a numeric expression. All numeric expressions evaluate to numeric values.",
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.+"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._PLUS_"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.-"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.~1"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._SLASH_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.*"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._STAR_"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.coalesce"
}, {
@@ -8642,6 +8619,42 @@
"description" : "Schema for valid values of `:widget-type` for a `::TemplateTag.FieldFilter`.",
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.widget-type"
},
+ "metabase.legacy-mbql.schema._BANG__EQ_" : {
+ "description" : "schema for a valid MBQL 4 :!= clause",
+ "allOf" : [ ]
+ },
+ "metabase.legacy-mbql.schema._EQ_" : {
+ "description" : "schema for a valid MBQL 4 := clause",
+ "allOf" : [ ]
+ },
+ "metabase.legacy-mbql.schema._GT_" : {
+ "description" : "schema for a valid MBQL 4 :> clause",
+ "allOf" : [ ]
+ },
+ "metabase.legacy-mbql.schema._GT__EQ_" : {
+ "description" : "schema for a valid MBQL 4 :>= clause",
+ "allOf" : [ ]
+ },
+ "metabase.legacy-mbql.schema._LT_" : {
+ "description" : "schema for a valid MBQL 4 :< clause",
+ "allOf" : [ ]
+ },
+ "metabase.legacy-mbql.schema._LT__EQ_" : {
+ "description" : "schema for a valid MBQL 4 :<= clause",
+ "allOf" : [ ]
+ },
+ "metabase.legacy-mbql.schema._PLUS_" : {
+ "description" : "schema for a valid MBQL 4 :+ clause",
+ "allOf" : [ ]
+ },
+ "metabase.legacy-mbql.schema._SLASH_" : {
+ "description" : "schema for a valid MBQL 4 :/ clause",
+ "allOf" : [ ]
+ },
+ "metabase.legacy-mbql.schema._STAR_" : {
+ "description" : "schema for a valid MBQL 4 :* clause",
+ "allOf" : [ ]
+ },
"metabase.legacy-mbql.schema.abs" : {
"description" : "schema for a valid MBQL 4 :abs clause",
"allOf" : [ ]
@@ -8901,6 +8914,14 @@
"type" : "null"
} ]
},
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "default", "hour", "hour-of-day", "millisecond", "minute", "minute-of-hour", "month", "month-of-year", "quarter", "quarter-of-year", "second", "second-of-minute", "week", "week-of-year", "year", "year-of-era" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/type" : {
"default" : "metadata/column",
"const" : "metadata/column"
@@ -8959,6 +8980,13 @@
"type" : "null"
} ]
},
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/original-expression-name" : {
"oneOf" : [ {
"type" : "string",
@@ -8994,65 +9022,24 @@
"type" : "null"
} ]
},
- "metabase.lib.field/temporal-unit" : {
+ "semantic_type" : {
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "default", "hour", "hour-of-day", "millisecond", "minute", "minute-of-hour", "month", "month-of-year", "quarter", "quarter-of-year", "second", "second-of-minute", "week", "week-of-year", "year", "year-of-era" ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
- "metabase.lib.field/binning" : {
+ "lib/original-effective-type" : {
"oneOf" : [ {
- "description" : "Schema for `:binning` options passed to a `:field` clause.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "const" : "default"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "type" : "object",
- "properties" : {
- "bin-width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
- },
- "strategy" : {
- "const" : "bin-width"
- }
- },
- "required" : [ "strategy", "bin-width" ]
- }, {
- "type" : "object",
- "properties" : {
- "num-bins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
- },
- "strategy" : {
- "const" : "num-bins"
- }
- },
- "required" : [ "strategy", "num-bins" ]
- } ]
- } ]
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "semantic_type" : {
+ "lib/join-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
@@ -9081,14 +9068,6 @@
"type" : "null"
} ]
},
- "metabase.lib.join/join-alias" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
"binning_info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema..legacy-column-metadata.binning-info"
@@ -9169,6 +9148,54 @@
"type" : "null"
} ]
},
+ "lib/binning" : {
+ "oneOf" : [ {
+ "description" : "Schema for `:binning` options passed to a `:field` clause.",
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ }
+ },
+ "required" : [ "strategy" ]
+ }, {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "strategy" : {
+ "const" : "default"
+ }
+ },
+ "required" : [ "strategy" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "bin-width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
+ },
+ "strategy" : {
+ "const" : "bin-width"
+ }
+ },
+ "required" : [ "strategy", "bin-width" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "num-bins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
+ },
+ "strategy" : {
+ "const" : "num-bins"
+ }
+ },
+ "required" : [ "strategy", "num-bins" ]
+ } ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
"metabase.lib.metadata.result-metadata/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
@@ -9205,7 +9232,7 @@
"type" : "null"
} ]
},
- "metabase.lib.field/simple-display-name" : {
+ "lib/simple-display-name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
@@ -9998,7 +10025,7 @@
"metabase.lib.schema.info.context" : {
"description" : "Schema for `info.context`; used for informational purposes to record how a query was executed.",
"type" : "string",
- "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid" ]
+ "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "transform-inspector" ]
},
"metabase.lib.schema.info.hash" : {
"type" : "string",
@@ -10022,6 +10049,13 @@
"type" : "null"
} ]
},
+ "lens-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"pivot/original-query" : {
"oneOf" : [ {
"type" : "object",
@@ -10058,6 +10092,13 @@
"type" : "null"
} ]
},
+ "transform-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
+ }, {
+ "type" : "null"
+ } ]
+ },
"context" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.info.context"
@@ -10072,6 +10113,14 @@
"type" : "null"
} ]
},
+ "lens-params" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
"metadata/model-metadata" : {
"oneOf" : [ {
"type" : "array",
@@ -10322,25 +10371,25 @@
},
"metabase.lib.schema.mbql-clause.clause" : {
"oneOf" : [ { }, {
- "$ref" : "#/components/schemas/mbql.clause.!="
+ "$ref" : "#/components/schemas/mbql.clause._BANG__EQ_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.*"
+ "$ref" : "#/components/schemas/mbql.clause._STAR_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.+"
+ "$ref" : "#/components/schemas/mbql.clause._PLUS_"
}, {
"$ref" : "#/components/schemas/mbql.clause.-"
}, {
- "$ref" : "#/components/schemas/mbql.clause.~1"
+ "$ref" : "#/components/schemas/mbql.clause._SLASH_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.<"
+ "$ref" : "#/components/schemas/mbql.clause._LT_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.<="
+ "$ref" : "#/components/schemas/mbql.clause._LT__EQ_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.="
+ "$ref" : "#/components/schemas/mbql.clause._EQ_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.>"
+ "$ref" : "#/components/schemas/mbql.clause._GT_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.>="
+ "$ref" : "#/components/schemas/mbql.clause._GT__EQ_"
}, {
"$ref" : "#/components/schemas/mbql.clause.abs"
}, {
@@ -10705,6 +10754,13 @@
"type" : "null"
} ]
},
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/type" : {
"default" : "metadata/column",
"const" : "metadata/column"
@@ -10773,6 +10829,13 @@
"default" : "type/*",
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/original-expression-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -10811,16 +10874,16 @@
"type" : "null"
} ]
},
- "metabase.lib.field/temporal-unit" : {
+ "lib/original-effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "metabase.lib.field/binning" : {
+ "lib/join-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
@@ -10852,13 +10915,6 @@
"selected?" : {
"type" : "boolean"
},
- "metabase.lib.join/join-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- }, {
- "type" : "null"
- } ]
- },
"fk-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
@@ -10887,6 +10943,13 @@
"type" : "null"
} ]
},
+ "lib/binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ }, {
+ "type" : "null"
+ } ]
+ },
"metabase.lib.metadata.result-metadata/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
@@ -10928,7 +10991,7 @@
"type" : "null"
} ]
},
- "metabase.lib.field/simple-display-name" : {
+ "lib/simple-display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
@@ -11188,6 +11251,13 @@
"type" : "null"
} ]
},
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/type" : {
"default" : "metadata/column",
"const" : "metadata/column"
@@ -11256,6 +11326,13 @@
"default" : "type/*",
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/original-expression-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -11294,16 +11371,16 @@
"type" : "null"
} ]
},
- "metabase.lib.field/temporal-unit" : {
+ "lib/original-effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "metabase.lib.field/binning" : {
+ "lib/join-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
@@ -11335,13 +11412,6 @@
"selected?" : {
"type" : "boolean"
},
- "metabase.lib.join/join-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- }, {
- "type" : "null"
- } ]
- },
"fk-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
@@ -11370,6 +11440,13 @@
"type" : "null"
} ]
},
+ "lib/binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ }, {
+ "type" : "null"
+ } ]
+ },
"metabase.lib.metadata.result-metadata/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
@@ -11411,7 +11488,7 @@
"type" : "null"
} ]
},
- "metabase.lib.field/simple-display-name" : {
+ "lib/simple-display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
@@ -11811,164 +11888,172 @@
} ]
},
"metabase.lib.schema.ref..field.literal.options" : {
- "default" : { },
- "type" : "object",
- "properties" : {
- "binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "inherited-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "database-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "display-name" : {
- "oneOf" : [ {
+ "allOf" : [ {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "inherited-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "database-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source-field-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "source-field-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "effective-type" : {
- "oneOf" : [ {
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "base-type" : {
+ "type" : "string"
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-effective-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "base-type" : {
- "type" : "string"
- },
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- },
- "name" : {
- "oneOf" : [ {
+ },
+ "source-field" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ },
+ "lib/original-binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "source-field-join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "metabase.lib.field/original-effective-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "source-field" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- },
- "lib/original-binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "source-field-join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "semantic-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "original-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }
},
- "original-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }
- },
- "required" : [ "lib/uuid", "base-type" ]
+ "required" : [ "lib/uuid", "base-type" ]
+ }, {
+ "allOf" : [ ]
+ } ]
},
"metabase.lib.schema.ref..field.options" : {
- "default" : { },
- "type" : "object",
- "properties" : {
- "binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "inherited-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "database-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "display-name" : {
- "oneOf" : [ {
+ "allOf" : [ {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "inherited-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "database-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source-field-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "source-field-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "effective-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "base-type" : {
- "oneOf" : [ {
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "base-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-effective-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- },
- "name" : {
- "oneOf" : [ {
+ },
+ "source-field" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ },
+ "lib/original-binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "source-field-join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "metabase.lib.field/original-effective-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "source-field" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- },
- "lib/original-binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "source-field-join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "semantic-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "original-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }
},
- "original-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }
- },
- "required" : [ "lib/uuid" ]
+ "required" : [ "lib/uuid" ]
+ }, {
+ "allOf" : [ ]
+ } ]
},
"metabase.lib.schema.ref.aggregation-options" : {
"default" : { },
@@ -13922,15 +14007,513 @@
"type" : "string",
"enum" : [ "events" ]
},
- "metabase.transforms-rest.api.transform.run-trigger" : {
+ "metabase.transforms-inspector.schema.alert-trigger" : {
+ "description" : "Definition for conditional alerts.\n FE evaluates condition against card results and shows alert if triggered.",
+ "type" : "object",
+ "properties" : {
+ "condition" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-condition"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "message" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-metadata"
+ },
+ "severity" : {
+ "type" : "string",
+ "enum" : [ "info", "warning", "error" ]
+ }
+ },
+ "required" : [ "id", "condition", "severity", "message" ]
+ },
+ "metabase.transforms-inspector.schema.card" : {
+ "description" : "A visualization card in the inspector output.\n\n Cards are generic - lens-specific data goes in :metadata.\n The :metadata map is opaque to the core but interpreted by\n lens-specific lib utilities on the frontend. ",
+ "type" : "object",
+ "properties" : {
+ "dataset_query" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.query"
+ },
+ "display" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.display-type"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.card-metadata"
+ },
+ "section_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "title" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "title", "display", "dataset_query" ]
+ },
+ "metabase.transforms-inspector.schema.card-metadata" : {
+ "description" : "Common metadata for join-related cards and triggers.",
+ "type" : "object",
+ "properties" : {
+ "dedup_key" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.dedup-key"
+ },
+ "group_id" : {
+ "type" : "string"
+ },
+ "group_order" : {
+ "type" : "integer"
+ },
+ "card_type" : {
+ "type" : "string"
+ },
+ "group_role" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.group-role"
+ },
+ "join_step" : {
+ "type" : "integer"
+ },
+ "join_alias" : {
+ "type" : "string"
+ },
+ "join_strategy" : {
+ "type" : "string"
+ },
+ "depends_on_cards" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ }
+ }
+ },
+ "metabase.transforms-inspector.schema.complexity" : {
+ "description" : "Complexity estimate for a lens.",
+ "type" : "object",
+ "properties" : {
+ "level" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.complexity-level"
+ },
+ "score" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "level" ]
+ },
+ "metabase.transforms-inspector.schema.complexity-level" : {
+ "description" : "Estimated complexity/cost of generating a lens.",
"type" : "string",
- "enum" : [ "none", "global-schedule" ]
+ "enum" : [ "fast", "slow", "very-slow" ]
},
- "metabase.transforms-rest.api.transform.transform-source" : {
- "$ref" : "#/components/schemas/metabase.transforms.schema.transform-source"
+ "metabase.transforms-inspector.schema.dedup-key" : {
+ "description" : "Key for deduplicating identical queries across lenses.\n Typically a vector like [:table_count table-id].",
+ "type" : "array",
+ "items" : { }
},
- "metabase.transforms-rest.api.transform.transform-target" : {
- "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
+ "metabase.transforms-inspector.schema.discovery-response" : {
+ "description" : "Response from lens discovery.",
+ "type" : "object",
+ "properties" : {
+ "available_lenses" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.lens-metadata"
+ }
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "sources" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.table"
+ }
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.inspector-status"
+ },
+ "target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visited_fields" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.visited-fields"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name", "status", "sources", "available_lenses" ]
+ },
+ "metabase.transforms-inspector.schema.display-type" : {
+ "description" : "Valid display types for cards.",
+ "type" : "string",
+ "enum" : [ "bar", "row", "line", "area", "pie", "scalar", "gauge", "progress", "table", "hidden" ]
+ },
+ "metabase.transforms-inspector.schema.drill-lens" : {
+ "description" : "A drill-down lens available from the current lens.",
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "display_name" ]
+ },
+ "metabase.transforms-inspector.schema.drill-lens-trigger" : {
+ "description" : "Definition for conditional drill lens availability.\n FE evaluates condition and shows drill lens option if triggered.\n :params is passed to the drill lens when triggered.",
+ "type" : "object",
+ "properties" : {
+ "condition" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-condition"
+ },
+ "lens_id" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-metadata"
+ },
+ "params" : {
+ "type" : "object",
+ "additionalProperties" : { }
+ },
+ "reason" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "lens_id", "condition" ]
+ },
+ "metabase.transforms-inspector.schema.field" : {
+ "description" : "Field metadata for inspector.",
+ "type" : "object",
+ "properties" : {
+ "base_type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "stats" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.field-stats"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "base_type" ]
+ },
+ "metabase.transforms-inspector.schema.field-stats" : {
+ "description" : "Statistics for a field from fingerprints.",
+ "type" : "object",
+ "properties" : {
+ "min" : {
+ "type" : "number"
+ },
+ "earliest" : {
+ "type" : "string"
+ },
+ "q1" : {
+ "type" : "number"
+ },
+ "max" : {
+ "type" : "number"
+ },
+ "distinct_count" : {
+ "type" : "integer"
+ },
+ "nil_percent" : {
+ "type" : "number"
+ },
+ "avg" : {
+ "type" : "number"
+ },
+ "latest" : {
+ "type" : "string"
+ },
+ "q3" : {
+ "type" : "number"
+ }
+ }
+ },
+ "metabase.transforms-inspector.schema.group-role" : {
+ "description" : "Role of a card within a comparison group.",
+ "type" : "string",
+ "enum" : [ "input", "output" ]
+ },
+ "metabase.transforms-inspector.schema.inspector-status" : {
+ "description" : "Status of the inspector result.",
+ "type" : "string",
+ "enum" : [ "not-run", "ready" ]
+ },
+ "metabase.transforms-inspector.schema.layout-type" : {
+ "description" : "Layout hints for sections.\n - :flat - cards displayed in a grid\n - :comparison - cards grouped for side-by-side comparison",
+ "type" : "string",
+ "enum" : [ "flat", "comparison" ]
+ },
+ "metabase.transforms-inspector.schema.lens" : {
+ "description" : "Full lens contents and drill lens/alert triggers.",
+ "type" : "object",
+ "properties" : {
+ "complexity" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.complexity"
+ },
+ "sections" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.section"
+ }
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "summary" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.lens-summary"
+ },
+ "alert_triggers" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.alert-trigger"
+ }
+ },
+ "drill_lenses" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.drill-lens"
+ }
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "drill_lens_triggers" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.drill-lens-trigger"
+ }
+ },
+ "cards" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.card"
+ }
+ }
+ },
+ "required" : [ "id", "display_name", "sections", "cards" ]
+ },
+ "metabase.transforms-inspector.schema.lens-metadata" : {
+ "type" : "object",
+ "properties" : {
+ "complexity" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.complexity"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "display_name" ]
+ },
+ "metabase.transforms-inspector.schema.lens-summary" : {
+ "description" : "Summary section of a lens.",
+ "type" : "object",
+ "properties" : {
+ "alerts" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "highlights" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.summary-highlight"
+ }
+ },
+ "text" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ },
+ "metabase.transforms-inspector.schema.section" : {
+ "description" : "A section grouping cards in a lens.",
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "layout" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.layout-type"
+ },
+ "title" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "title" ]
+ },
+ "metabase.transforms-inspector.schema.summary-highlight" : {
+ "description" : "A highlight in the lens summary.",
+ "type" : "object",
+ "properties" : {
+ "card_id" : {
+ "type" : "string"
+ },
+ "label" : {
+ "type" : "string"
+ },
+ "value" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "label" ]
+ },
+ "metabase.transforms-inspector.schema.table" : {
+ "description" : "Table metadata.",
+ "type" : "object",
+ "properties" : {
+ "column_count" : {
+ "type" : "integer"
+ },
+ "db_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "fields" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.field"
+ }
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "table_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_id", "table_name", "db_id", "column_count", "fields" ]
+ },
+ "metabase.transforms-inspector.schema.trigger-condition" : {
+ "description" : "A named condition that triggers an alert or drill lens.\n Evaluated by multimethod in lib against card results.\n Only :name is required; other keys are condition-specific.",
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name" ]
+ },
+ "metabase.transforms-inspector.schema.trigger-metadata" : {
+ "description" : "Common metadata for join-related cards and triggers.",
+ "type" : "object",
+ "properties" : {
+ "join_alias" : {
+ "type" : "string"
+ },
+ "join_step" : {
+ "type" : "integer"
+ },
+ "join_strategy" : {
+ "type" : "string"
+ }
+ }
+ },
+ "metabase.transforms-inspector.schema.visited-fields" : {
+ "description" : "Field IDs used in semantically important query clauses.\n Used for interestingness scoring and preselection.",
+ "type" : "object",
+ "properties" : {
+ "all" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "uniqueItems" : true
+ }
+ }
+ },
+ "metabase.transforms-rest.api.transform.run-trigger" : {
+ "type" : "string",
+ "enum" : [ "none", "global-schedule" ]
},
"metabase.transforms.schema.append-config" : {
"type" : "object",
@@ -14264,12 +14847,26 @@
},
"required" : [ "type", "url" ]
}
+ },
+ "securitySchemes" : {
+ "ApiKeyAuth" : {
+ "type" : "apiKey",
+ "in" : "header",
+ "name" : "X-Metabase-Session",
+ "description" : "Session token obtained from /api/session endpoint"
+ }
}
},
+ "info" : {
+ "title" : "Metabase API documentation",
+ "description" : "- **The API is subject to change.** We rarely change API endpoints, and almost never remove them, but if you write code that relies on the API, there's a chance you might have to update your code in the future.\n- **The API isn't versioned.** So don’t expect to stay on a particular version of Metabase in order to use a “stable” API.\n\n## API tutorial\n\nCheck out an introduction to the [Metabase API](https://www.metabase.com/learn/administration/metabase-api.html).\n\n## API keys\n\nCreate keys to authenticate programmatic requests to your Metabase. See [API keys](./people-and-groups/api-keys).\n\n## API changelog\n\nFor breaking changes, see the API [changelog](./developers-guide/api-changelog).\n\n## View the API docs for your Metabase\n\nYou can view the API docs for your Metabase by visiting `https://[your-metabase-url]/api/docs`.\n\n## Generating API docs\n\nYou can generate these docs by running:\n\n```\nclojure -M:ee:doc api-documentation\n```\n"
+ },
+ "openapi" : "3.1.0",
"paths" : {
- "/api/action/" : {
+ "/api/action" : {
"get" : {
- "summary" : "GET /api/action/",
+ "operationId" : "get-api-action",
+ "summary" : "GET /api/action",
"description" : "Returns actions that can be used for QueryActions. By default lists all viewable actions. Pass optional\n `?model-id=<model-id>` to limit to actions on a particular model.",
"parameters" : [ {
"in" : "query",
@@ -14307,7 +14904,8 @@
"tags" : [ "/api/action" ]
},
"post" : {
- "summary" : "POST /api/action/",
+ "operationId" : "post-api-action",
+ "summary" : "POST /api/action",
"description" : "Create a new action.",
"parameters" : [ ],
"responses" : {
@@ -14342,6 +14940,7 @@
},
"/api/action/public" : {
"get" : {
+ "operationId" : "get-api-action-public",
"summary" : "GET /api/action/public",
"description" : "Fetch a list of Actions with public UUIDs. These actions are publicly-accessible *if* public sharing is enabled.",
"parameters" : [ ],
@@ -14371,6 +14970,7 @@
},
"/api/action/{action-id}" : {
"get" : {
+ "operationId" : "get-api-action-action-id",
"summary" : "GET /api/action/{action-id}",
"description" : "Fetch an Action.",
"parameters" : [ {
@@ -14404,6 +15004,7 @@
"tags" : [ "/api/action" ]
},
"delete" : {
+ "operationId" : "delete-api-action-action-id",
"summary" : "DELETE /api/action/{action-id}",
"description" : "Delete an Action.",
"parameters" : [ {
@@ -14432,6 +15033,7 @@
},
"/api/action/{action-id}/execute" : {
"get" : {
+ "operationId" : "get-api-action-action-id-execute",
"summary" : "GET /api/action/{action-id}/execute",
"description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",
"parameters" : [ {
@@ -14468,6 +15070,7 @@
},
"/api/action/{id}" : {
"put" : {
+ "operationId" : "put-api-action-id",
"summary" : "PUT /api/action/{id}",
"description" : "Update an Action.",
"parameters" : [ {
@@ -14503,6 +15106,7 @@
},
"/api/action/{id}/execute" : {
"post" : {
+ "operationId" : "post-api-action-id-execute",
"summary" : "POST /api/action/{id}/execute",
"description" : "Execute the Action.\n\n `parameters` should be the mapped dashboard parameters with values.",
"parameters" : [ {
@@ -14552,6 +15156,7 @@
},
"/api/action/{id}/public_link" : {
"post" : {
+ "operationId" : "post-api-action-id-public_link",
"summary" : "POST /api/action/{id}/public_link",
"description" : "Generate publicly-accessible links for this Action. Returns UUID to be used in public links. (If this\n Action has already been shared, it will return the existing public link rather than creating a new one.) Public\n sharing must be enabled.",
"parameters" : [ {
@@ -14576,6 +15181,7 @@
"tags" : [ "/api/action" ]
},
"delete" : {
+ "operationId" : "delete-api-action-id-public_link",
"summary" : "DELETE /api/action/{id}/public_link",
"description" : "Delete the publicly-accessible link to this Dashboard.",
"parameters" : [ {
@@ -14602,6 +15208,7 @@
},
"/api/activity/most_recently_viewed_dashboard" : {
"get" : {
+ "operationId" : "get-api-activity-most_recently_viewed_dashboard",
"summary" : "GET /api/activity/most_recently_viewed_dashboard",
"description" : "Get the most recently viewed dashboard for the current user. Returns a 204 if the user has not viewed any dashboards\n in the last 24 hours.",
"parameters" : [ ],
@@ -14621,6 +15228,7 @@
},
"/api/activity/popular_items" : {
"get" : {
+ "operationId" : "get-api-activity-popular_items",
"summary" : "GET /api/activity/popular_items",
"description" : "Get the list of 5 popular things on the instance. Query takes 8 and limits to 5 so that if it finds anything\n archived, deleted, etc it can usually still get 5. ",
"parameters" : [ ],
@@ -14640,6 +15248,7 @@
},
"/api/activity/recent_views" : {
"get" : {
+ "operationId" : "get-api-activity-recent_views",
"summary" : "GET /api/activity/recent_views",
"description" : "Get a list of 100 models (cards, models, tables, dashboards, and collections) that the current user has been viewing most\n recently. Return a maximum of 20 model of each, if they've looked at at least 20.",
"parameters" : [ ],
@@ -14660,6 +15269,7 @@
},
"/api/activity/recents" : {
"get" : {
+ "operationId" : "get-api-activity-recents",
"summary" : "GET /api/activity/recents",
"description" : "Get a list of recent items the current user has been viewing most recently under the `:recents` key.\n Allows for filtering by context: views or selections",
"parameters" : [ {
@@ -14700,6 +15310,7 @@
"tags" : [ "/api/activity" ]
},
"post" : {
+ "operationId" : "post-api-activity-recents",
"summary" : "POST /api/activity/recents",
"description" : "Adds a model to the list of recently selected items.",
"parameters" : [ ],
@@ -14744,6 +15355,7 @@
},
"/api/agent/v1/construct-query" : {
"post" : {
+ "operationId" : "post-api-agent-v1-construct-query",
"summary" : "POST /api/agent/v1/construct-query",
"description" : "Construct an MBQL query from a table or metric.\n\n Returns a base64-encoded MBQL query that can be used with the query API.\n\n For tables, supports: filters, fields, aggregations, group_by, order_by, limit.\n For metrics, supports: filters, group_by (aggregation is defined by the metric).",
"parameters" : [ ],
@@ -14779,6 +15391,7 @@
},
"/api/agent/v1/execute" : {
"post" : {
+ "operationId" : "post-api-agent-v1-execute",
"summary" : "POST /api/agent/v1/execute",
"description" : "Execute an MBQL query and return results.\n\n Accepts a base64-encoded MBQL query (as returned by /v1/construct-query) and executes it,\n returning results with column metadata.\n\n Response format:\n - On success: {:data {:cols [...] :rows [...]} :row_count N :status :completed :running_time M}\n - On failure: {:status :failed :error \"message\" ...}\n\n Standard userspace query limits are enforced (2000 rows for simple queries, 10000 for aggregated).",
"parameters" : [ ],
@@ -14814,6 +15427,7 @@
},
"/api/agent/v1/metric/{id}" : {
"get" : {
+ "operationId" : "get-api-agent-v1-metric-id",
"summary" : "GET /api/agent/v1/metric/{id}",
"description" : "Get details for a metric by ID.",
"parameters" : [ {
@@ -14893,6 +15507,7 @@
},
"/api/agent/v1/metric/{id}/field/{field-id}/values" : {
"get" : {
+ "operationId" : "get-api-agent-v1-metric-id-field-field-id-values",
"summary" : "GET /api/agent/v1/metric/{id}/field/{field-id}/values",
"description" : "Get statistics and sample values for a metric field.",
"parameters" : [ {
@@ -14936,6 +15551,7 @@
},
"/api/agent/v1/ping" : {
"get" : {
+ "operationId" : "get-api-agent-v1-ping",
"summary" : "GET /api/agent/v1/ping",
"description" : "Health check endpoint for the Agent API.",
"parameters" : [ ],
@@ -14968,6 +15584,7 @@
},
"/api/agent/v1/search" : {
"post" : {
+ "operationId" : "post-api-agent-v1-search",
"summary" : "POST /api/agent/v1/search",
"description" : "Search for tables and metrics.\n\n Supports both term-based and semantic search queries. Results are ranked using\n Reciprocal Rank Fusion when both query types are provided.",
"parameters" : [ ],
@@ -15027,6 +15644,7 @@
},
"/api/agent/v1/table/{id}" : {
"get" : {
+ "operationId" : "get-api-agent-v1-table-id",
"summary" : "GET /api/agent/v1/table/{id}",
"description" : "Get details for a table by ID.",
"parameters" : [ {
@@ -15128,6 +15746,7 @@
},
"/api/agent/v1/table/{id}/field/{field-id}/values" : {
"get" : {
+ "operationId" : "get-api-agent-v1-table-id-field-field-id-values",
"summary" : "GET /api/agent/v1/table/{id}/field/{field-id}/values",
"description" : "Get statistics and sample values for a table field.",
"parameters" : [ {
@@ -15169,9 +15788,10 @@
"tags" : [ "/api/agent" ]
}
},
- "/api/alert/" : {
+ "/api/alert" : {
"get" : {
- "summary" : "GET /api/alert/",
+ "operationId" : "get-api-alert",
+ "summary" : "GET /api/alert",
"description" : "Fetch alerts which the current user has created or will receive, or all alerts if the user is an admin.\n The optional `user_id` will return alerts created by the corresponding user, but is ignored for non-admin users.",
"parameters" : [ {
"in" : "query",
@@ -15215,6 +15835,7 @@
},
"/api/alert/{id}" : {
"get" : {
+ "operationId" : "get-api-alert-id",
"summary" : "GET /api/alert/{id}",
"description" : "Fetch an alert by ID",
"parameters" : [ {
@@ -15243,6 +15864,7 @@
},
"/api/alert/{id}/subscription" : {
"delete" : {
+ "operationId" : "delete-api-alert-id-subscription",
"summary" : "DELETE /api/alert/{id}/subscription",
"description" : "For users to unsubscribe themselves from the given alert.",
"parameters" : [ {
@@ -15271,6 +15893,7 @@
},
"/api/analytics/anonymous-stats" : {
"get" : {
+ "operationId" : "get-api-analytics-anonymous-stats",
"summary" : "GET /api/analytics/anonymous-stats",
"description" : "Anonymous usage stats. Endpoint for testing, and eventually exposing this to instance admins to let them see\n what is being phoned home.",
"parameters" : [ ],
@@ -15288,9 +15911,10 @@
"tags" : [ "/api/analytics" ]
}
},
- "/api/api-key/" : {
+ "/api/api-key" : {
"post" : {
- "summary" : "POST /api/api-key/",
+ "operationId" : "post-api-api-key",
+ "summary" : "POST /api/api-key",
"description" : "Create a new API key (and an associated `User`) with the provided name and group ID.",
"parameters" : [ ],
"responses" : {
@@ -15326,7 +15950,8 @@
"tags" : [ "/api/api-key" ]
},
"get" : {
- "summary" : "GET /api/api-key/",
+ "operationId" : "get-api-api-key",
+ "summary" : "GET /api/api-key",
"description" : "Get a list of API keys with the default scope. Non-paginated.",
"parameters" : [ ],
"responses" : {
@@ -15345,6 +15970,7 @@
},
"/api/api-key/count" : {
"get" : {
+ "operationId" : "get-api-api-key-count",
"summary" : "GET /api/api-key/count",
"description" : "Get the count of API keys in the DB with the default scope.",
"parameters" : [ ],
@@ -15364,6 +15990,7 @@
},
"/api/api-key/{id}" : {
"put" : {
+ "operationId" : "put-api-api-key-id",
"summary" : "PUT /api/api-key/{id}",
"description" : "Update an API key by changing its group and/or its name",
"parameters" : [ {
@@ -15417,6 +16044,7 @@
"tags" : [ "/api/api-key" ]
},
"delete" : {
+ "operationId" : "delete-api-api-key-id",
"summary" : "DELETE /api/api-key/{id}",
"description" : "Delete an ApiKey",
"parameters" : [ {
@@ -15443,6 +16071,7 @@
},
"/api/api-key/{id}/regenerate" : {
"put" : {
+ "operationId" : "put-api-api-key-id-regenerate",
"summary" : "PUT /api/api-key/{id}/regenerate",
"description" : "Regenerate an API Key",
"parameters" : [ {
@@ -15491,6 +16120,7 @@
},
"/api/automagic-dashboards/database/{id}/candidates" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-database-id-candidates",
"summary" : "GET /api/automagic-dashboards/database/{id}/candidates",
"description" : "Return a list of candidates for automagic dashboards ordered by interestingness.",
"parameters" : [ {
@@ -15519,6 +16149,7 @@
},
"/api/automagic-dashboards/model_index/{model-index-id}/primary_key/{pk-id}" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-model_index-model-index-id-primary_key-pk-id",
"summary" : "GET /api/automagic-dashboards/model_index/{model-index-id}/primary_key/{pk-id}",
"description" : "Return an automagic dashboard for an entity detail specified by `entity`\n with id `id` and a primary key of `indexed-value`.",
"parameters" : [ {
@@ -15552,6 +16183,7 @@
},
"/api/automagic-dashboards/{entity}/{entity-id-or-query}" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query",
"summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}",
"description" : "Return an automagic dashboard for entity `entity` with id `id`.",
"parameters" : [ {
@@ -15602,6 +16234,7 @@
},
"/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-cell-cell-query",
"summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}",
"description" : "Return an automagic dashboard analyzing cell in automagic dashboard for entity `entity` defined by query\n `cell-query`.",
"parameters" : [ {
@@ -15661,6 +16294,7 @@
},
"/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-cell-cell-query-compare-comparison-entity-comparison-entity-id-or-query",
"summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
"description" : "Return an automagic comparison dashboard for cell in automagic dashboard for entity `entity`\n with id `id` defined by query `cell-query`; compared with entity `comparison-entity` with id\n `comparison-entity-id-or-query.`.",
"parameters" : [ {
@@ -15736,6 +16370,7 @@
},
"/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-cell-cell-query-rule-prefix-dashboard-template",
"summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}",
"description" : "Return an automagic dashboard analyzing cell in question with id `id` defined by query `cell-query` using\n dashboard-template `dashboard-template`.",
"parameters" : [ {
@@ -15806,6 +16441,7 @@
},
"/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-cell-cell-query-rule-prefix-dashboard-template-compare-comparison-entity-comparison-entity-id-or-query",
"summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
"description" : "Return an automagic comparison dashboard for cell in automagic dashboard for entity `entity`\n with id `id` defined by query `cell-query` using dashboard-template `dashboard-template`; compared with entity\n `comparison-entity` with id `comparison-entity-id-or-query.`.",
"parameters" : [ {
@@ -15892,6 +16528,7 @@
},
"/api/automagic-dashboards/{entity}/{entity-id-or-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-compare-comparison-entity-comparison-entity-id-or-query",
"summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
"description" : "Return an automagic comparison dashboard for entity `entity` with id `id` compared with entity `comparison-entity`\n with id `comparison-entity-id-or-query.`",
"parameters" : [ {
@@ -15960,6 +16597,7 @@
},
"/api/automagic-dashboards/{entity}/{entity-id-or-query}/query_metadata" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-query_metadata",
"summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/query_metadata",
"description" : "Return all metadata for an automagic dashboard for entity `entity` with id `id`.",
"parameters" : [ {
@@ -15994,6 +16632,7 @@
},
"/api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-rule-prefix-dashboard-template",
"summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}",
"description" : "Return an automagic dashboard for entity `entity` with id `id` using dashboard-template `dashboard-template`.",
"parameters" : [ {
@@ -16057,6 +16696,7 @@
},
"/api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
"get" : {
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-rule-prefix-dashboard-template-compare-comparison-entity-comparison-entity-id-or-query",
"summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
"description" : "Return an automagic comparison dashboard for entity `entity` with id `id` using dashboard-template\n `dashboard-template`; compared with entity `comparison-entity` with id `comparison-entity-id-or-query.`.",
"parameters" : [ {
@@ -16134,9 +16774,10 @@
"tags" : [ "/api/automagic-dashboards" ]
}
},
- "/api/bookmark/" : {
+ "/api/bookmark" : {
"get" : {
- "summary" : "GET /api/bookmark/",
+ "operationId" : "get-api-bookmark",
+ "summary" : "GET /api/bookmark",
"description" : "Fetch all bookmarks for the user",
"parameters" : [ ],
"responses" : {
@@ -16155,6 +16796,7 @@
},
"/api/bookmark/ordering" : {
"put" : {
+ "operationId" : "put-api-bookmark-ordering",
"summary" : "PUT /api/bookmark/ordering",
"description" : "Sets the order of bookmarks for user.",
"parameters" : [ ],
@@ -16204,6 +16846,7 @@
},
"/api/bookmark/{model}/{id}" : {
"post" : {
+ "operationId" : "post-api-bookmark-model-id",
"summary" : "POST /api/bookmark/{model}/{id}",
"description" : "Create a new bookmark for user.",
"parameters" : [ {
@@ -16238,6 +16881,7 @@
"tags" : [ "/api/bookmark" ]
},
"delete" : {
+ "operationId" : "delete-api-bookmark-model-id",
"summary" : "DELETE /api/bookmark/{model}/{id}",
"description" : "Delete a bookmark. Will delete a bookmark assigned to the user making the request by model and id.",
"parameters" : [ {
@@ -16274,6 +16918,7 @@
},
"/api/bug-reporting/connection-pool-details" : {
"get" : {
+ "operationId" : "get-api-bug-reporting-connection-pool-details",
"summary" : "GET /api/bug-reporting/connection-pool-details",
"description" : "Returns database connection pool info for the current Metabase instance.",
"parameters" : [ ],
@@ -16293,6 +16938,7 @@
},
"/api/bug-reporting/details" : {
"get" : {
+ "operationId" : "get-api-bug-reporting-details",
"summary" : "GET /api/bug-reporting/details",
"description" : "Returns version and system information relevant to filing a bug report against Metabase.",
"parameters" : [ ],
@@ -16310,9 +16956,10 @@
"tags" : [ "/api/bug-reporting" ]
}
},
- "/api/cache/" : {
+ "/api/cache" : {
"get" : {
- "summary" : "GET /api/cache/",
+ "operationId" : "get-api-cache",
+ "summary" : "GET /api/cache",
"description" : "Return cache configuration. Supports pagination via `limit` and `offset` query parameters,\n and sorting via `sort_column` and `sort_direction`.",
"parameters" : [ {
"in" : "query",
@@ -16388,7 +17035,8 @@
"tags" : [ "/api/cache" ]
},
"put" : {
- "summary" : "PUT /api/cache/",
+ "operationId" : "put-api-cache",
+ "summary" : "PUT /api/cache",
"description" : "Store cache configuration.",
"parameters" : [ ],
"responses" : {
@@ -16429,7 +17077,8 @@
"tags" : [ "/api/cache" ]
},
"delete" : {
- "summary" : "DELETE /api/cache/",
+ "operationId" : "delete-api-cache",
+ "summary" : "DELETE /api/cache",
"description" : "Delete cache configurations.",
"parameters" : [ ],
"responses" : {
@@ -16472,6 +17121,7 @@
},
"/api/cache/invalidate" : {
"post" : {
+ "operationId" : "post-api-cache-invalidate",
"summary" : "POST /api/cache/invalidate",
"description" : "Invalidate cache entries.\n\n Use it like `/api/cache/invalidate?database=1&dashboard=15` (any number of database/dashboard/question can be\n supplied).\n\n `&include=overrides` controls whenever you want to invalidate cache for a specific cache configuration without\n touching all nested configurations, or you want your invalidation to trickle down to every card.",
"parameters" : [ {
@@ -16552,9 +17202,10 @@
"tags" : [ "/api/cache" ]
}
},
- "/api/card/" : {
+ "/api/card" : {
"get" : {
- "summary" : "GET /api/card/",
+ "operationId" : "get-api-card",
+ "summary" : "GET /api/card",
"description" : "Get all the Cards. Option filter param `f` can be used to change the set of Cards that are returned; default is\n `all`, but other options include `mine`, `bookmarked`, `database`, `table`, `using_model`, `using_segment`, and\n `archived`. See corresponding implementation functions above for the specific behavior of each filter\n option. :card_index:",
"parameters" : [ {
"in" : "query",
@@ -16593,7 +17244,8 @@
"tags" : [ "/api/card" ]
},
"post" : {
- "summary" : "POST /api/card/",
+ "operationId" : "post-api-card",
+ "summary" : "POST /api/card",
"description" : "Create a new `Card`. Card `type` can be `question`, `metric`, or `model`.",
"parameters" : [ ],
"responses" : {
@@ -16737,6 +17389,7 @@
},
"/api/card/collections" : {
"post" : {
+ "operationId" : "post-api-card-collections",
"summary" : "POST /api/card/collections",
"description" : "Bulk update endpoint for Card Collections. Move a set of `Cards` with `card_ids` into a `Collection` with\n `collection_id`, or remove them from any Collections by passing a `null` `collection_id`.",
"parameters" : [ ],
@@ -16785,6 +17438,7 @@
},
"/api/card/embeddable" : {
"get" : {
+ "operationId" : "get-api-card-embeddable",
"summary" : "GET /api/card/embeddable",
"description" : "Fetch a list of Cards where `enable_embedding` is `true`. The cards can be embedded using the embedding endpoints\n and a signed JWT.",
"parameters" : [ ],
@@ -16804,6 +17458,7 @@
},
"/api/card/pivot/{card-id}/query" : {
"post" : {
+ "operationId" : "post-api-card-pivot-card-id-query",
"summary" : "POST /api/card/pivot/{card-id}/query",
"description" : "Run the query associated with a Card.",
"parameters" : [ {
@@ -16850,6 +17505,7 @@
},
"/api/card/public" : {
"get" : {
+ "operationId" : "get-api-card-public",
"summary" : "GET /api/card/public",
"description" : "Fetch a list of Cards with public UUIDs. These cards are publicly-accessible *if* public sharing is enabled.",
"parameters" : [ ],
@@ -16869,6 +17525,7 @@
},
"/api/card/{card-id}/params/{param-key}/search/{query}" : {
"get" : {
+ "operationId" : "get-api-card-card-id-params-param-key-search-query",
"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/queries/1/params/abc/search/Orange\n\n Currently limited to first 1000 results.",
"parameters" : [ {
@@ -16912,6 +17569,7 @@
},
"/api/card/{card-id}/params/{param-key}/values" : {
"get" : {
+ "operationId" : "get-api-card-card-id-params-param-key-values",
"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/queries/1/params/abc/values",
"parameters" : [ {
@@ -16947,6 +17605,7 @@
},
"/api/card/{card-id}/public_link" : {
"post" : {
+ "operationId" : "post-api-card-card-id-public_link",
"summary" : "POST /api/card/{card-id}/public_link",
"description" : "Generate publicly-accessible links for this Card. Returns UUID to be used in public links. (If this Card has\n already been shared, it will return the existing public link rather than creating a new one.) Public sharing must\n be enabled.",
"parameters" : [ {
@@ -16973,6 +17632,7 @@
"tags" : [ "/api/card" ]
},
"delete" : {
+ "operationId" : "delete-api-card-card-id-public_link",
"summary" : "DELETE /api/card/{card-id}/public_link",
"description" : "Delete the publicly-accessible link to this Card.",
"parameters" : [ {
@@ -17001,6 +17661,7 @@
},
"/api/card/{card-id}/query" : {
"post" : {
+ "operationId" : "post-api-card-card-id-query",
"summary" : "POST /api/card/{card-id}/query",
"description" : "Run the query associated with a Card.",
"parameters" : [ {
@@ -17067,6 +17728,7 @@
},
"/api/card/{card-id}/query/{export-format}" : {
"post" : {
+ "operationId" : "post-api-card-card-id-query-export-format",
"summary" : "POST /api/card/{card-id}/query/{export-format}",
"description" : "Run the query associated with a Card, and return its results as a file in the specified format.\n\n `parameters`, `pivot-results?` and `format-rows?` should be passed as application/x-www-form-urlencoded form content\n or json in the body. This is because this endpoint is normally used to power 'Download Results' buttons that use\n HTML `form` actions).",
"parameters" : [ {
@@ -17133,6 +17795,7 @@
},
"/api/card/{id}" : {
"get" : {
+ "operationId" : "get-api-card-id",
"summary" : "GET /api/card/{id}",
"description" : "Get `Card` with ID.\n\n As of v57, returns the MBQL query (`dataset_query`) as MBQL 5; to return the query as MBQL 4 (aka legacy MBQL)\n instead, you can specify `?legacy-mbql=true`.",
"parameters" : [ {
@@ -17177,6 +17840,7 @@
"tags" : [ "/api/card" ]
},
"put" : {
+ "operationId" : "put-api-card-id",
"summary" : "PUT /api/card/{id}",
"description" : "Update a `Card`.",
"parameters" : [ {
@@ -17383,6 +18047,7 @@
"tags" : [ "/api/card" ]
},
"delete" : {
+ "operationId" : "delete-api-card-id",
"summary" : "DELETE /api/card/{id}",
"description" : "Hard delete a Card. To soft delete, use `PUT /api/queries/:id`",
"parameters" : [ {
@@ -17411,6 +18076,7 @@
},
"/api/card/{id}/copy" : {
"post" : {
+ "operationId" : "post-api-card-id-copy",
"summary" : "POST /api/card/{id}/copy",
"description" : "Copy a `Card`, with the new name 'Copy of _name_'",
"parameters" : [ {
@@ -17439,6 +18105,7 @@
},
"/api/card/{id}/dashboards" : {
"get" : {
+ "operationId" : "get-api-card-id-dashboards",
"summary" : "GET /api/card/{id}/dashboards",
"description" : "Get a list of `{:name ... :id ...}` pairs for all the dashboards this card appears in.",
"parameters" : [ {
@@ -17467,6 +18134,7 @@
},
"/api/card/{id}/params/{param-key}/remapping" : {
"get" : {
+ "operationId" : "get-api-card-id-params-param-key-remapping",
"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/queries/1/params/abc/remapping?value=100",
"parameters" : [ {
@@ -17507,6 +18175,7 @@
},
"/api/card/{id}/query_metadata" : {
"get" : {
+ "operationId" : "get-api-card-id-query_metadata",
"summary" : "GET /api/card/{id}/query_metadata",
"description" : "Get all of the required query metadata for a card.",
"parameters" : [ {
@@ -17541,6 +18210,7 @@
},
"/api/card/{id}/series" : {
"get" : {
+ "operationId" : "get-api-card-id-series",
"summary" : "GET /api/card/{id}/series",
"description" : "Fetches a list of compatible series with the card with id `card_id`.\n\n - `last_cursor` with value is the id of the last card from the previous page to fetch the next page.\n - `query` to search card by name.\n - `exclude_ids` to filter out a list of card ids",
"parameters" : [ {
@@ -17601,6 +18271,7 @@
},
"/api/cards/dashboards" : {
"post" : {
+ "operationId" : "post-api-cards-dashboards",
"summary" : "POST /api/cards/dashboards",
"description" : "Get the dashboards that multiple cards appear in. The response is a sequence of maps, each of which has a `card_id`\n and `dashboards`. `dashboard` may include an `:error` key, either `:unreadable-dashboard` or\n `:unwritable-dashboard`. In the case of an `unreadable-dashboard` the dashboard details (name, ID) will NOT be\n present.",
"parameters" : [ ],
@@ -17640,6 +18311,7 @@
},
"/api/cards/move" : {
"post" : {
+ "operationId" : "post-api-cards-move",
"summary" : "POST /api/cards/move",
"description" : "Moves a number of Cards to a single collection or dashboard.\n\n For now, just either succeed or fail as a batch - we can think more about error handling later down the road.",
"parameters" : [ ],
@@ -17695,9 +18367,10 @@
"tags" : [ "/api/cards" ]
}
},
- "/api/channel/" : {
+ "/api/channel" : {
"get" : {
- "summary" : "GET /api/channel/",
+ "operationId" : "get-api-channel",
+ "summary" : "GET /api/channel",
"description" : "Get all channels",
"parameters" : [ ],
"responses" : {
@@ -17733,7 +18406,8 @@
"tags" : [ "/api/channel" ]
},
"post" : {
- "summary" : "POST /api/channel/",
+ "operationId" : "post-api-channel",
+ "summary" : "POST /api/channel",
"description" : "Create a channel",
"parameters" : [ ],
"responses" : {
@@ -17791,6 +18465,7 @@
},
"/api/channel/test" : {
"post" : {
+ "operationId" : "post-api-channel-test",
"summary" : "POST /api/channel/test",
"description" : "Test a channel connection",
"parameters" : [ ],
@@ -17829,6 +18504,7 @@
},
"/api/channel/{id}" : {
"get" : {
+ "operationId" : "get-api-channel-id",
"summary" : "GET /api/channel/{id}",
"description" : "Get a channel",
"parameters" : [ {
@@ -17855,6 +18531,7 @@
"tags" : [ "/api/channel" ]
},
"put" : {
+ "operationId" : "put-api-channel-id",
"summary" : "PUT /api/channel/{id}",
"description" : "Update a channel",
"parameters" : [ {
@@ -17930,9 +18607,10 @@
"tags" : [ "/api/channel" ]
}
},
- "/api/cloud-migration/" : {
+ "/api/cloud-migration" : {
"post" : {
- "summary" : "POST /api/cloud-migration/",
+ "operationId" : "post-api-cloud-migration",
+ "summary" : "POST /api/cloud-migration",
"description" : "Initiate a new cloud migration.",
"parameters" : [ ],
"responses" : {
@@ -17949,7 +18627,8 @@
"tags" : [ "/api/cloud-migration" ]
},
"get" : {
- "summary" : "GET /api/cloud-migration/",
+ "operationId" : "get-api-cloud-migration",
+ "summary" : "GET /api/cloud-migration",
"description" : "Get the latest cloud migration, if any.",
"parameters" : [ ],
"responses" : {
@@ -17968,6 +18647,7 @@
},
"/api/cloud-migration/cancel" : {
"put" : {
+ "operationId" : "put-api-cloud-migration-cancel",
"summary" : "PUT /api/cloud-migration/cancel",
"description" : "Cancel any ongoing cloud migrations, if any.",
"parameters" : [ ],
@@ -17985,9 +18665,10 @@
"tags" : [ "/api/cloud-migration" ]
}
},
- "/api/collection/" : {
+ "/api/collection" : {
"get" : {
- "summary" : "GET /api/collection/",
+ "operationId" : "get-api-collection",
+ "summary" : "GET /api/collection",
"description" : "Fetch a list of all Collections that the current user has read permissions for (`:can_write` is returned as an\n additional property of each Collection so you can tell which of these you have write permissions for.)\n\n By default, this returns non-archived Collections, but instead you can show archived ones by passing\n `?archived=true`.\n\n By default, admin users will see all collections. To hide other user's collections pass in\n `?exclude-other-user-collections=true`.\n\n If personal-only is `true`, then return only personal collections where `personal_owner_id` is not `nil`.",
"parameters" : [ {
"in" : "query",
@@ -18052,7 +18733,8 @@
"tags" : [ "/api/collection" ]
},
"post" : {
- "summary" : "POST /api/collection/",
+ "operationId" : "post-api-collection",
+ "summary" : "POST /api/collection",
"description" : "Create a new Collection.",
"parameters" : [ ],
"responses" : {
@@ -18120,6 +18802,7 @@
},
"/api/collection/graph" : {
"get" : {
+ "operationId" : "get-api-collection-graph",
"summary" : "GET /api/collection/graph",
"description" : "Fetch a graph of all Collection Permissions.",
"parameters" : [ {
@@ -18149,6 +18832,7 @@
"tags" : [ "/api/collection" ]
},
"put" : {
+ "operationId" : "put-api-collection-graph",
"summary" : "PUT /api/collection/graph",
"description" : "Do a batch update of Collections Permissions by passing in a modified graph. Will overwrite parts of the graph that\n are present in the request, and leave the rest unchanged.\n\n If the `force` query parameter is `true`, a `revision` number is not required. The provided graph will be persisted\n as-is, and has the potential to clobber other writes that happened since the last read.\n\n If the `skip_graph` query parameter is `true`, it will only return the current revision, not the entire permissions\n graph.",
"parameters" : [ {
@@ -18224,6 +18908,7 @@
},
"/api/collection/root" : {
"get" : {
+ "operationId" : "get-api-collection-root",
"summary" : "GET /api/collection/root",
"description" : "Return the 'Root' Collection object with standard details added",
"parameters" : [ {
@@ -18255,6 +18940,7 @@
},
"/api/collection/root/dashboard-question-candidates" : {
"get" : {
+ "operationId" : "get-api-collection-root-dashboard-question-candidates",
"summary" : "GET /api/collection/root/dashboard-question-candidates",
"description" : "Find cards in the root collection that can be moved into dashboards in the root collection. (Same as the above\n endpoint, but for the root collection)",
"parameters" : [ ],
@@ -18281,6 +18967,7 @@
},
"/api/collection/root/items" : {
"get" : {
+ "operationId" : "get-api-collection-root-items",
"summary" : "GET /api/collection/root/items",
"description" : "Fetch objects that the current user should see at their root level. As mentioned elsewhere, the 'Root' Collection\n doesn't actually exist as a row in the application DB: it's simply a virtual Collection where things with no\n `collection_id` exist. It does, however, have its own set of Permissions.\n\n This endpoint will actually show objects with no `collection_id` for Users that have Root Collection\n permissions, but for people without Root Collection perms, we'll just show the objects that have an effective\n location of `/`.\n\n This endpoint is intended to power a 'Root Folder View' for the Current User, so regardless you'll see all the\n top-level objects you're allowed to access.\n\n By default, this will show the 'normal' Collections namespace; to view a different Collections namespace, such as\n `snippets`, you can pass the `?namespace=` parameter.\n\n By default, library collections are excluded from the results; to include them, pass `?include_library=true`.\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
"parameters" : [ {
@@ -18396,8 +19083,7 @@
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean",
- "optional" : true
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -18408,8 +19094,7 @@
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean",
- "optional" : true
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -18431,6 +19116,7 @@
},
"/api/collection/root/move-dashboard-question-candidates" : {
"post" : {
+ "operationId" : "post-api-collection-root-move-dashboard-question-candidates",
"summary" : "POST /api/collection/root/move-dashboard-question-candidates",
"description" : "Move candidate cards to the dashboards they appear in (for the root collection)",
"parameters" : [ ],
@@ -18481,6 +19167,7 @@
},
"/api/collection/trash" : {
"get" : {
+ "operationId" : "get-api-collection-trash",
"summary" : "GET /api/collection/trash",
"description" : "Fetch the trash collection, as in `/api/collection/:trash-id`",
"parameters" : [ ],
@@ -18500,6 +19187,7 @@
},
"/api/collection/tree" : {
"get" : {
+ "operationId" : "get-api-collection-tree",
"summary" : "GET /api/collection/tree",
"description" : "Similar to `GET /`, but returns Collections in a tree structure, e.g.\n\n ```\n [{:name \"A\"\n :below #{:card :dataset}\n :children [{:name \"B\"}\n {:name \"C\"\n :here #{:dataset :card}\n :below #{:dataset :card}\n :children [{:name \"D\"\n :here #{:dataset}\n :children [{:name \"E\"}]}\n {:name \"F\"\n :here #{:card}\n :children [{:name \"G\"}]}]}]}\n {:name \"H\"}]\n ```\n\n The here and below keys indicate the types of items at this particular level of the tree (here) and in its\n subtree (below).\n\n TODO: for historical reasons this returns Saved Questions AS 'card' AND Models as 'dataset'; we should fix this at\n some point in the future.\n\n By default, looks at the `analytics` (if enabled) and regular (`nil`) namespaces. You can optionally pass a\n `namespace` argument, or one or many `namespaces`, to specify the particular collection namespaces you wish to look\n at. For example, `namespaces=analytics&namespaces=` would match the default behavior.\n\n When `shallow` is true, takes an optional `collection-id` and returns only the requested collection (or\n the root, if `collection-id` is `nil`).",
"parameters" : [ {
@@ -18606,6 +19294,7 @@
},
"/api/collection/{id}" : {
"get" : {
+ "operationId" : "get-api-collection-id",
"summary" : "GET /api/collection/{id}",
"description" : "Fetch a specific Collection with standard details added",
"parameters" : [ {
@@ -18638,6 +19327,7 @@
"tags" : [ "/api/collection" ]
},
"put" : {
+ "operationId" : "put-api-collection-id",
"summary" : "PUT /api/collection/{id}",
"description" : "Modify an existing Collection, including archiving or unarchiving it, or moving it.",
"parameters" : [ {
@@ -18725,6 +19415,7 @@
"tags" : [ "/api/collection" ]
},
"delete" : {
+ "operationId" : "delete-api-collection-id",
"summary" : "DELETE /api/collection/{id}",
"description" : "Deletes a collection permanently",
"parameters" : [ {
@@ -18753,6 +19444,7 @@
},
"/api/collection/{id}/dashboard-question-candidates" : {
"get" : {
+ "operationId" : "get-api-collection-id-dashboard-question-candidates",
"summary" : "GET /api/collection/{id}/dashboard-question-candidates",
"description" : "Find cards in this collection that can be moved into dashboards in this collection.\n\n To be eligible, a card must only appear in one dashboard (which is also in this collection), and must not already be a\n dashboard question.",
"parameters" : [ {
@@ -18788,6 +19480,7 @@
},
"/api/collection/{id}/items" : {
"get" : {
+ "operationId" : "get-api-collection-id-items",
"summary" : "GET /api/collection/{id}/items",
"description" : "Fetch a specific Collection's items with the following options:\n\n * `models` - only include objects of a specific set of `models`. If unspecified, returns objects of all models\n * `archived` - when `true`, return archived objects *instead* of unarchived ones. Defaults to `false`.\n * `pinned_state` - when `is_pinned`, return pinned objects only.\n when `is_not_pinned`, return non pinned objects only.\n when `all`, return everything. By default returns everything.\n * `include_can_run_adhoc_query` - when this is true hydrates the `can_run_adhoc_query` flag on card models\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
"parameters" : [ {
@@ -18886,8 +19579,7 @@
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean",
- "optional" : true
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -18921,6 +19613,7 @@
},
"/api/collection/{id}/move-dashboard-question-candidates" : {
"post" : {
+ "operationId" : "post-api-collection-id-move-dashboard-question-candidates",
"summary" : "POST /api/collection/{id}/move-dashboard-question-candidates",
"description" : "Move candidate cards to the dashboards they appear in.",
"parameters" : [ {
@@ -18978,9 +19671,10 @@
"tags" : [ "/api/collection" ]
}
},
- "/api/comment/" : {
+ "/api/comment" : {
"get" : {
- "summary" : "GET /api/comment/",
+ "operationId" : "get-api-comment",
+ "summary" : "GET /api/comment",
"description" : "Get comments for an entity",
"parameters" : [ {
"in" : "query",
@@ -19014,7 +19708,8 @@
"tags" : [ "/api/comment" ]
},
"post" : {
- "summary" : "POST /api/comment/",
+ "operationId" : "post-api-comment",
+ "summary" : "POST /api/comment",
"description" : "Create a new comment",
"parameters" : [ ],
"responses" : {
@@ -19076,6 +19771,7 @@
},
"/api/comment/mentions" : {
"get" : {
+ "operationId" : "get-api-comment-mentions",
"summary" : "GET /api/comment/mentions",
"description" : "Get a list of entities suitable for mentions. NOTE: only users for now.",
"parameters" : [ ],
@@ -19095,6 +19791,7 @@
},
"/api/comment/{comment-id}" : {
"put" : {
+ "operationId" : "put-api-comment-comment-id",
"summary" : "PUT /api/comment/{comment-id}",
"description" : "Update a comment",
"parameters" : [ {
@@ -19141,6 +19838,7 @@
"tags" : [ "/api/comment" ]
},
"delete" : {
+ "operationId" : "delete-api-comment-comment-id",
"summary" : "DELETE /api/comment/{comment-id}",
"description" : "Soft delete a comment",
"parameters" : [ {
@@ -19169,6 +19867,7 @@
},
"/api/comment/{comment-id}/reaction" : {
"post" : {
+ "operationId" : "post-api-comment-comment-id-reaction",
"summary" : "POST /api/comment/{comment-id}/reaction",
"description" : "Toggle a reaction on a comment",
"parameters" : [ {
@@ -19212,9 +19911,10 @@
"tags" : [ "/api/comment" ]
}
},
- "/api/dashboard/" : {
+ "/api/dashboard" : {
"get" : {
- "summary" : "GET /api/dashboard/",
+ "operationId" : "get-api-dashboard",
+ "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",
@@ -19244,7 +19944,8 @@
"tags" : [ "/api/dashboard" ]
},
"post" : {
- "summary" : "POST /api/dashboard/",
+ "operationId" : "post-api-dashboard",
+ "summary" : "POST /api/dashboard",
"description" : "Create a new Dashboard.",
"parameters" : [ ],
"responses" : {
@@ -19320,6 +20021,7 @@
},
"/api/dashboard/embeddable" : {
"get" : {
+ "operationId" : "get-api-dashboard-embeddable",
"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" : [ ],
@@ -19339,6 +20041,7 @@
},
"/api/dashboard/params/valid-filter-fields" : {
"get" : {
+ "operationId" : "get-api-dashboard-params-valid-filter-fields",
"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" : [ {
@@ -19382,6 +20085,7 @@
},
"/api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {
"post" : {
+ "operationId" : "post-api-dashboard-pivot-dashboard-id-dashcard-dashcard-id-card-card-id-query",
"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" : [ {
@@ -19462,6 +20166,7 @@
},
"/api/dashboard/public" : {
"get" : {
+ "operationId" : "get-api-dashboard-public",
"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" : [ ],
@@ -19481,6 +20186,7 @@
},
"/api/dashboard/save" : {
"post" : {
+ "operationId" : "post-api-dashboard-save",
"summary" : "POST /api/dashboard/save",
"description" : "Save a denormalized description of dashboard.",
"parameters" : [ ],
@@ -19500,6 +20206,7 @@
},
"/api/dashboard/save/collection/{parent-collection-id}" : {
"post" : {
+ "operationId" : "post-api-dashboard-save-collection-parent-collection-id",
"summary" : "POST /api/dashboard/save/collection/{parent-collection-id}",
"description" : "Save a denormalized description of dashboard into collection with ID `:parent-collection-id`.",
"parameters" : [ {
@@ -19528,6 +20235,7 @@
},
"/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {
"post" : {
+ "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-card-card-id-query",
"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" : [ {
@@ -19616,6 +20324,7 @@
},
"/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}" : {
"post" : {
+ "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-card-card-id-query-export-format",
"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" : [ {
@@ -19717,6 +20426,7 @@
},
"/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute" : {
"get" : {
+ "operationId" : "get-api-dashboard-dashboard-id-dashcard-dashcard-id-execute",
"summary" : "GET /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute",
"description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",
"parameters" : [ {
@@ -19760,6 +20470,7 @@
"tags" : [ "/api/dashboard" ]
},
"post" : {
+ "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-execute",
"summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute",
"description" : "Execute the associated Action in the context of a `Dashboard` and `DashboardCard` that includes it.\n\n `parameters` should be the mapped dashboard parameters with values.\n `extra_parameters` should be the extra, user entered parameter values.",
"parameters" : [ {
@@ -19816,6 +20527,7 @@
},
"/api/dashboard/{dashboard-id}/public_link" : {
"post" : {
+ "operationId" : "post-api-dashboard-dashboard-id-public_link",
"summary" : "POST /api/dashboard/{dashboard-id}/public_link",
"description" : "Generate publicly-accessible links for this Dashboard. Returns UUID to be used in public links. (If this\n Dashboard has already been shared, it will return the existing public link rather than creating a new one.) Public\n sharing must be enabled.",
"parameters" : [ {
@@ -19842,6 +20554,7 @@
"tags" : [ "/api/dashboard" ]
},
"delete" : {
+ "operationId" : "delete-api-dashboard-dashboard-id-public_link",
"summary" : "DELETE /api/dashboard/{dashboard-id}/public_link",
"description" : "Delete the publicly-accessible link to this Dashboard.",
"parameters" : [ {
@@ -19870,6 +20583,7 @@
},
"/api/dashboard/{from-dashboard-id}/copy" : {
"post" : {
+ "operationId" : "post-api-dashboard-from-dashboard-id-copy",
"summary" : "POST /api/dashboard/{from-dashboard-id}/copy",
"description" : "Copy a Dashboard.",
"parameters" : [ {
@@ -19951,6 +20665,7 @@
},
"/api/dashboard/{id}" : {
"get" : {
+ "operationId" : "get-api-dashboard-id",
"summary" : "GET /api/dashboard/{id}",
"description" : "Get Dashboard with ID.",
"parameters" : [ {
@@ -19983,6 +20698,7 @@
"tags" : [ "/api/dashboard" ]
},
"delete" : {
+ "operationId" : "delete-api-dashboard-id",
"summary" : "DELETE /api/dashboard/{id}",
"description" : "Hard delete a Dashboard. To soft delete, use `PUT /api/dashboard/:id`\n\n This will remove also any questions/models/segments/metrics that use this database.",
"parameters" : [ {
@@ -20009,6 +20725,7 @@
"tags" : [ "/api/dashboard" ]
},
"put" : {
+ "operationId" : "put-api-dashboard-id",
"summary" : "PUT /api/dashboard/{id}",
"description" : "Update a Dashboard, and optionally the `dashcards` and `tabs` of a Dashboard. The request body should be a JSON object with the same\n structure as the response from `GET /api/dashboard/:id`.",
"parameters" : [ {
@@ -20255,6 +20972,7 @@
},
"/api/dashboard/{id}/cards" : {
"put" : {
+ "operationId" : "put-api-dashboard-id-cards",
"summary" : "PUT /api/dashboard/{id}/cards",
"description" : "(DEPRECATED -- Use the `PUT /api/dashboard/:id` endpoint instead.)\n Update `Cards` and `Tabs` on a Dashboard. Request body should have the form:\n\n {:cards [{:id ... ; DashboardCard ID\n :size_x ...\n :size_y ...\n :row ...\n :col ...\n :parameter_mappings ...\n :series [{:id 123\n ...}]}\n ...]\n :tabs [{:id ... ; DashboardTab ID\n :name ...}]}",
"parameters" : [ {
@@ -20378,6 +21096,7 @@
},
"/api/dashboard/{id}/items" : {
"get" : {
+ "operationId" : "get-api-dashboard-id-items",
"summary" : "GET /api/dashboard/{id}/items",
"description" : "Get Dashboard with ID.",
"parameters" : [ {
@@ -20406,6 +21125,7 @@
},
"/api/dashboard/{id}/params/{param-key}/remapping" : {
"get" : {
+ "operationId" : "get-api-dashboard-id-params-param-key-remapping",
"summary" : "GET /api/dashboard/{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 Dashboard 1 parameter 'abc' for value 100\n GET /api/dashboard/1/params/abc/remapping?value=100",
"parameters" : [ {
@@ -20449,6 +21169,7 @@
},
"/api/dashboard/{id}/params/{param-key}/search/{query}" : {
"get" : {
+ "operationId" : "get-api-dashboard-id-params-param-key-search-query",
"summary" : "GET /api/dashboard/{id}/params/{param-key}/search/{query}",
"description" : "Fetch possible values of the parameter whose ID is `:param-key` that contain `:query`. Optionally restrict\n these values by passing query parameters like `other-parameter=value` e.g.\n\n ;; fetch values for Dashboard 1 parameter 'abc' that contain 'Cam' and are possible when parameter 'def' is set\n ;; to 100\n GET /api/dashboard/1/params/abc/search/Cam?def=100\n\n Currently limited to first 1000 results.",
"parameters" : [ {
@@ -20493,6 +21214,7 @@
},
"/api/dashboard/{id}/params/{param-key}/values" : {
"get" : {
+ "operationId" : "get-api-dashboard-id-params-param-key-values",
"summary" : "GET /api/dashboard/{id}/params/{param-key}/values",
"description" : "Fetch possible values of the parameter whose ID is `:param-key`. If the values come directly from a query, optionally\n restrict these values by passing query parameters like `other-parameter=value` e.g.\n\n ;; fetch values for Dashboard 1 parameter 'abc' that are possible when parameter 'def' is set to 100\n GET /api/dashboard/1/params/abc/values?def=100",
"parameters" : [ {
@@ -20529,6 +21251,7 @@
},
"/api/dashboard/{id}/query_metadata" : {
"get" : {
+ "operationId" : "get-api-dashboard-id-query_metadata",
"summary" : "GET /api/dashboard/{id}/query_metadata",
"description" : "Get all of the required query metadata for the cards on dashboard.",
"parameters" : [ {
@@ -20563,6 +21286,7 @@
},
"/api/dashboard/{id}/related" : {
"get" : {
+ "operationId" : "get-api-dashboard-id-related",
"summary" : "GET /api/dashboard/{id}/related",
"description" : "Return related entities.",
"parameters" : [ {
@@ -20591,6 +21315,7 @@
},
"/api/data-studio/table/discard-values" : {
"post" : {
+ "operationId" : "post-api-data-studio-table-discard-values",
"summary" : "POST /api/data-studio/table/discard-values",
"description" : "Batch version of /table/:id/discard_values. Takes an abstract table selection as /table/edit does.",
"parameters" : [ ],
@@ -20626,6 +21351,7 @@
},
"/api/data-studio/table/edit" : {
"post" : {
+ "operationId" : "post-api-data-studio-table-edit",
"summary" : "POST /api/data-studio/table/edit",
"description" : "Bulk updating tables.",
"parameters" : [ ],
@@ -20730,6 +21456,7 @@
},
"/api/data-studio/table/rescan-values" : {
"post" : {
+ "operationId" : "post-api-data-studio-table-rescan-values",
"summary" : "POST /api/data-studio/table/rescan-values",
"description" : "Batch version of /table/:id/rescan_values. Takes an abstract table selection as /table/edit does.",
"parameters" : [ ],
@@ -20765,6 +21492,7 @@
},
"/api/data-studio/table/selection" : {
"post" : {
+ "operationId" : "post-api-data-studio-table-selection",
"summary" : "POST /api/data-studio/table/selection",
"description" : "Gets information about selected tables",
"parameters" : [ ],
@@ -20800,6 +21528,7 @@
},
"/api/data-studio/table/sync-schema" : {
"post" : {
+ "operationId" : "post-api-data-studio-table-sync-schema",
"summary" : "POST /api/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, asynchronous. This call may return before all tables synced.",
"parameters" : [ ],
@@ -20833,9 +21562,10 @@
"tags" : [ "/api/data-studio/table" ]
}
},
- "/api/database/" : {
+ "/api/database" : {
"get" : {
- "summary" : "GET /api/database/",
+ "operationId" : "get-api-database",
+ "summary" : "GET /api/database",
"description" : "Fetch all `Databases`.\n\n * `include=tables` means we should hydrate the Tables belonging to each DB. Default: `false`.\n\n * `saved` means we should include the saved questions virtual database. Default: `false`.\n\n * `include_editable_data_model` will only include DBs for which the current user has data model editing\n permissions. (If `include=tables`, this also applies to the list of tables in each DB). Should only be used if\n Enterprise Edition code is available the advanced-permissions feature is enabled.\n\n * `exclude_uneditable_details` will only include DBs for which the current user can edit the DB details. Has no\n effect unless Enterprise Edition code is available and the advanced-permissions feature is enabled.\n\n * `include_only_uploadable` will only include DBs into which Metabase can insert new data.\n\n * `can-query` will only include DBs for which the current user has query permissions. Default: `false`.\n\n * `can-write-metadata` will only include DBs for which the current user has data model editing permissions\n for at least one table in the database. Default: `false`.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for\n `:model/Database` in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user\n lacks permission to change the database details.",
"parameters" : [ {
"in" : "query",
@@ -20959,7 +21689,8 @@
"tags" : [ "/api/database" ]
},
"post" : {
- "summary" : "POST /api/database/",
+ "operationId" : "post-api-database",
+ "summary" : "POST /api/database",
"description" : "Add a new `Database`.",
"parameters" : [ ],
"responses" : {
@@ -21059,6 +21790,7 @@
},
"/api/database/sample_database" : {
"post" : {
+ "operationId" : "post-api-database-sample_database",
"summary" : "POST /api/database/sample_database",
"description" : "Add the sample database as a new `Database`.",
"parameters" : [ ],
@@ -21078,6 +21810,7 @@
},
"/api/database/validate" : {
"post" : {
+ "operationId" : "post-api-database-validate",
"summary" : "POST /api/database/validate",
"description" : "Validate that we can connect to a database given a set of details.",
"parameters" : [ ],
@@ -21124,6 +21857,7 @@
},
"/api/database/{id}" : {
"get" : {
+ "operationId" : "get-api-database-id",
"summary" : "GET /api/database/{id}",
"description" : "Get a single Database with `id`. Optionally pass `?include=tables` or `?include=tables.fields` to include the Tables\n belonging to this database, or the Tables and Fields, respectively. If the requestor has write permissions for the\n DB\n (i.e. is an admin or has data model permissions), then certain inferred secret values will also be included in the\n returned details (see [[metabase.secrets.models.secret/expand-db-details-inferred-secret-values]] for full details).\n\n Passing include_editable_data_model will only return tables for which the current user has data model editing\n permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present.\n In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID\n and tables, with no additional metadata.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for `:model/Database`\n in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user lacks permission to change the\n database details.",
"parameters" : [ {
@@ -21176,6 +21910,7 @@
"tags" : [ "/api/database" ]
},
"put" : {
+ "operationId" : "put-api-database-id",
"summary" : "PUT /api/database/{id}",
"description" : "Update a `Database`.",
"parameters" : [ {
@@ -21315,6 +22050,7 @@
"tags" : [ "/api/database" ]
},
"delete" : {
+ "operationId" : "delete-api-database-id",
"summary" : "DELETE /api/database/{id}",
"description" : "Delete a `Database`.",
"parameters" : [ {
@@ -21343,6 +22079,7 @@
},
"/api/database/{id}/autocomplete_suggestions" : {
"get" : {
+ "operationId" : "get-api-database-id-autocomplete_suggestions",
"summary" : "GET /api/database/{id}/autocomplete_suggestions",
"description" : "Return a list of autocomplete suggestions for a given `prefix`, or `substring`. Should only specify one, but\n `substring` will have priority if both are present.\n\n This is intended for use with the ACE Editor when the User is typing raw SQL. Suggestions include matching `Tables`\n and `Fields` in this `Database`.\n\n Tables are returned in the format `[table_name \"Table\"]`;\n When Fields have a semantic_type, they are returned in the format `[field_name \"table_name base_type semantic_type\"]`\n When Fields lack a semantic_type, they are returned in the format `[field_name \"table_name base_type\"]`",
"parameters" : [ {
@@ -21395,6 +22132,7 @@
},
"/api/database/{id}/card_autocomplete_suggestions" : {
"get" : {
+ "operationId" : "get-api-database-id-card_autocomplete_suggestions",
"summary" : "GET /api/database/{id}/card_autocomplete_suggestions",
"description" : "Return a list of `Card` autocomplete suggestions for a given `query` in a given `Database`.\n\n This is intended for use with the ACE Editor when the User is typing in a template tag for a `Card`, e.g. {{#...}}.",
"parameters" : [ {
@@ -21438,6 +22176,7 @@
},
"/api/database/{id}/discard_values" : {
"post" : {
+ "operationId" : "post-api-database-id-discard_values",
"summary" : "POST /api/database/{id}/discard_values",
"description" : "Discards all saved field values for this `Database`.",
"parameters" : [ {
@@ -21466,6 +22205,7 @@
},
"/api/database/{id}/dismiss_spinner" : {
"post" : {
+ "operationId" : "post-api-database-id-dismiss_spinner",
"summary" : "POST /api/database/{id}/dismiss_spinner",
"description" : "Manually set the initial sync status of the `Database` and corresponding\n tables to be `complete` (see #20863)",
"parameters" : [ {
@@ -21494,6 +22234,7 @@
},
"/api/database/{id}/fields" : {
"get" : {
+ "operationId" : "get-api-database-id-fields",
"summary" : "GET /api/database/{id}/fields",
"description" : "Get a list of all `Fields` in `Database`.",
"parameters" : [ {
@@ -21522,6 +22263,7 @@
},
"/api/database/{id}/healthcheck" : {
"get" : {
+ "operationId" : "get-api-database-id-healthcheck",
"summary" : "GET /api/database/{id}/healthcheck",
"description" : "Reports whether the database can currently connect",
"parameters" : [ {
@@ -21557,6 +22299,7 @@
},
"/api/database/{id}/idfields" : {
"get" : {
+ "operationId" : "get-api-database-id-idfields",
"summary" : "GET /api/database/{id}/idfields",
"description" : "Get a list of all primary key `Fields` for `Database`.",
"parameters" : [ {
@@ -21585,6 +22328,7 @@
},
"/api/database/{id}/metadata" : {
"get" : {
+ "operationId" : "get-api-database-id-metadata",
"summary" : "GET /api/database/{id}/metadata",
"description" : "Get metadata about a `Database`, including all of its `Tables` and `Fields`. Returns DB, fields, and field values.\n By default only non-hidden tables and fields are returned. Passing include_hidden=true includes them.\n\n Passing include_editable_data_model will only return tables for which the current user has data model editing\n permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present.\n In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID\n and tables, with no additional metadata.",
"parameters" : [ {
@@ -21661,6 +22405,7 @@
},
"/api/database/{id}/permission/workspace/check" : {
"post" : {
+ "operationId" : "post-api-database-id-permission-workspace-check",
"summary" : "POST /api/database/{id}/permission/workspace/check",
"description" : "Check if database's connection has the required permissions to manage workspaces.\n By default it'll return the cached permission check.",
"parameters" : [ {
@@ -21716,6 +22461,7 @@
},
"/api/database/{id}/rescan_values" : {
"post" : {
+ "operationId" : "post-api-database-id-rescan_values",
"summary" : "POST /api/database/{id}/rescan_values",
"description" : "Trigger a manual scan of the field values for this `Database`.",
"parameters" : [ {
@@ -21742,9 +22488,10 @@
"tags" : [ "/api/database" ]
}
},
- "/api/database/{id}/schema/" : {
+ "/api/database/{id}/schema" : {
"get" : {
- "summary" : "GET /api/database/{id}/schema/",
+ "operationId" : "get-api-database-id-schema",
+ "summary" : "GET /api/database/{id}/schema",
"description" : "Return a list of Tables for a Database whose `schema` is `nil` or an empty string.\n\n Optional filters:\n - `can-query=true` - filter to only tables the user can query\n - `can-write-metadata=true` - filter to only tables the user can edit metadata for",
"parameters" : [ {
"in" : "path",
@@ -21818,6 +22565,7 @@
},
"/api/database/{id}/schema/{schema}" : {
"get" : {
+ "operationId" : "get-api-database-id-schema-schema",
"summary" : "GET /api/database/{id}/schema/{schema}",
"description" : "Returns a list of Tables for the given Database `id` and `schema`.\n\n Optional filters:\n - `can-query=true` - filter to only tables the user can query\n - `can-write-metadata=true` - filter to only tables the user can edit metadata for",
"parameters" : [ {
@@ -21900,6 +22648,7 @@
},
"/api/database/{id}/schemas" : {
"get" : {
+ "operationId" : "get-api-database-id-schemas",
"summary" : "GET /api/database/{id}/schemas",
"description" : "Returns a list of all the schemas with tables found for the database `id`. Excludes schemas with no tables.\n\n Optional filters:\n - `can-query=true` - filter to only schemas containing tables the user can query\n - `can-write-metadata=true` - filter to only schemas containing tables the user can edit metadata for",
"parameters" : [ {
@@ -21996,6 +22745,7 @@
},
"/api/database/{id}/settings-available" : {
"get" : {
+ "operationId" : "get-api-database-id-settings-available",
"summary" : "GET /api/database/{id}/settings-available",
"description" : "Get all database-local settings and their availability for the given database.",
"parameters" : [ {
@@ -22037,6 +22787,7 @@
},
"/api/database/{id}/sync_schema" : {
"post" : {
+ "operationId" : "post-api-database-id-sync_schema",
"summary" : "POST /api/database/{id}/sync_schema",
"description" : "Trigger a manual update of the schema metadata for this `Database`.",
"parameters" : [ {
@@ -22065,6 +22816,7 @@
},
"/api/database/{id}/syncable_schemas" : {
"get" : {
+ "operationId" : "get-api-database-id-syncable_schemas",
"summary" : "GET /api/database/{id}/syncable_schemas",
"description" : "Returns a list of all syncable schemas found for the database `id`.",
"parameters" : [ {
@@ -22093,6 +22845,7 @@
},
"/api/database/{id}/usage_info" : {
"get" : {
+ "operationId" : "get-api-database-id-usage_info",
"summary" : "GET /api/database/{id}/usage_info",
"description" : "Get usage info for a database.\n Returns a map with keys are models and values are the number of entities that use this database.",
"parameters" : [ {
@@ -22121,6 +22874,7 @@
},
"/api/database/{virtual-db}/datasets" : {
"get" : {
+ "operationId" : "get-api-database-virtual-db-datasets",
"summary" : "GET /api/database/{virtual-db}/datasets",
"description" : "Returns a list of all the datasets found for the saved questions virtual database.",
"parameters" : [ ],
@@ -22140,6 +22894,7 @@
},
"/api/database/{virtual-db}/datasets/{schema}" : {
"get" : {
+ "operationId" : "get-api-database-virtual-db-datasets-schema",
"summary" : "GET /api/database/{virtual-db}/datasets/{schema}",
"description" : "Returns a list of Tables for the datasets virtual database.",
"parameters" : [ ],
@@ -22159,6 +22914,7 @@
},
"/api/database/{virtual-db}/metadata" : {
"get" : {
+ "operationId" : "get-api-database-virtual-db-metadata",
"summary" : "GET /api/database/{virtual-db}/metadata",
"description" : "Endpoint that provides metadata for the Saved Questions 'virtual' database. Used for fooling the frontend\n and allowing it to treat the Saved Questions virtual DB just like any other database.",
"parameters" : [ ],
@@ -22178,6 +22934,7 @@
},
"/api/database/{virtual-db}/schema/{schema}" : {
"get" : {
+ "operationId" : "get-api-database-virtual-db-schema-schema",
"summary" : "GET /api/database/{virtual-db}/schema/{schema}",
"description" : "Returns a list of Tables for the saved questions virtual database.",
"parameters" : [ ],
@@ -22197,6 +22954,7 @@
},
"/api/database/{virtual-db}/schemas" : {
"get" : {
+ "operationId" : "get-api-database-virtual-db-schemas",
"summary" : "GET /api/database/{virtual-db}/schemas",
"description" : "Returns a list of all the schemas found for the saved questions virtual database.",
"parameters" : [ ],
@@ -22214,9 +22972,10 @@
"tags" : [ "/api/database" ]
}
},
- "/api/dataset/" : {
+ "/api/dataset" : {
"post" : {
- "summary" : "POST /api/dataset/",
+ "operationId" : "post-api-dataset",
+ "summary" : "POST /api/dataset",
"description" : "Execute a query and retrieve the results in the usual format. The query will not use the cache.",
"parameters" : [ ],
"responses" : {
@@ -22260,6 +23019,7 @@
},
"/api/dataset/native" : {
"post" : {
+ "operationId" : "post-api-dataset-native",
"summary" : "POST /api/dataset/native",
"description" : "Fetch a native version of an MBQL query.",
"parameters" : [ ],
@@ -22304,6 +23064,7 @@
},
"/api/dataset/parameter/remapping" : {
"post" : {
+ "operationId" : "post-api-dataset-parameter-remapping",
"summary" : "POST /api/dataset/parameter/remapping",
"description" : "Return the remapped parameter values for cards or dashboards that are being edited.",
"parameters" : [ ],
@@ -22349,6 +23110,7 @@
},
"/api/dataset/parameter/search/{query}" : {
"post" : {
+ "operationId" : "post-api-dataset-parameter-search-query",
"summary" : "POST /api/dataset/parameter/search/{query}",
"description" : "Return parameter values for cards or dashboards that are being edited. Expects a query string at `?query=foo`.",
"parameters" : [ {
@@ -22401,6 +23163,7 @@
},
"/api/dataset/parameter/values" : {
"post" : {
+ "operationId" : "post-api-dataset-parameter-values",
"summary" : "POST /api/dataset/parameter/values",
"description" : "Return parameter values for cards or dashboards that are being edited.",
"parameters" : [ ],
@@ -22445,6 +23208,7 @@
},
"/api/dataset/pivot" : {
"post" : {
+ "operationId" : "post-api-dataset-pivot",
"summary" : "POST /api/dataset/pivot",
"description" : "Generate a pivoted dataset for an ad-hoc query",
"parameters" : [ ],
@@ -22488,6 +23252,7 @@
},
"/api/dataset/query_metadata" : {
"post" : {
+ "operationId" : "post-api-dataset-query_metadata",
"summary" : "POST /api/dataset/query_metadata",
"description" : "Get all of the required query metadata for an ad-hoc query.\n\n You can pass `{:settings {:include-sensitive-fields true}}` in the query to include fields with\n visibility_type :sensitive in the response.",
"parameters" : [ ],
@@ -22536,6 +23301,7 @@
},
"/api/dataset/{export-format}" : {
"post" : {
+ "operationId" : "post-api-dataset-export-format",
"summary" : "POST /api/dataset/{export-format}",
"description" : "Execute a query and download the result data as a file in the specified format.",
"parameters" : [ {
@@ -22596,9 +23362,10 @@
"tags" : [ "/api/dataset" ]
}
},
- "/api/document/" : {
+ "/api/document" : {
"get" : {
- "summary" : "GET /api/document/",
+ "operationId" : "get-api-document",
+ "summary" : "GET /api/document",
"description" : "Gets existing `Documents`.",
"parameters" : [ ],
"responses" : {
@@ -22615,7 +23382,8 @@
"tags" : [ "/api/document" ]
},
"post" : {
- "summary" : "POST /api/document/",
+ "operationId" : "post-api-document",
+ "summary" : "POST /api/document",
"description" : "Create a new `Document`.",
"parameters" : [ ],
"responses" : {
@@ -22762,6 +23530,7 @@
},
"/api/document/public" : {
"get" : {
+ "operationId" : "get-api-document-public",
"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" : [ ],
@@ -22807,6 +23576,7 @@
},
"/api/document/{document-id}" : {
"get" : {
+ "operationId" : "get-api-document-document-id",
"summary" : "GET /api/document/{document-id}",
"description" : "Returns an existing Document by ID.",
"parameters" : [ {
@@ -22833,6 +23603,7 @@
"tags" : [ "/api/document" ]
},
"put" : {
+ "operationId" : "put-api-document-document-id",
"summary" : "PUT /api/document/{document-id}",
"description" : "Updates an existing `Document`.",
"parameters" : [ {
@@ -22993,6 +23764,7 @@
"tags" : [ "/api/document" ]
},
"delete" : {
+ "operationId" : "delete-api-document-document-id",
"summary" : "DELETE /api/document/{document-id}",
"description" : "Permanently deletes an archived Document.",
"parameters" : [ {
@@ -23021,6 +23793,7 @@
},
"/api/document/{document-id}/card/{card-id}/query/{export-format}" : {
"post" : {
+ "operationId" : "post-api-document-document-id-card-card-id-query-export-format",
"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" : [ {
@@ -23102,6 +23875,7 @@
},
"/api/document/{document-id}/public-link" : {
"post" : {
+ "operationId" : "post-api-document-document-id-public-link",
"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" : [ {
@@ -23143,6 +23917,7 @@
"tags" : [ "/api/document" ]
},
"delete" : {
+ "operationId" : "delete-api-document-document-id-public-link",
"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" : [ {
@@ -23171,6 +23946,7 @@
},
"/api/document/{from-document-id}/copy" : {
"post" : {
+ "operationId" : "post-api-document-from-document-id-copy",
"summary" : "POST /api/document/{from-document-id}/copy",
"description" : "Copy a Document.",
"parameters" : [ {
@@ -23243,6 +24019,7 @@
},
"/api/ee/action-v2/execute" : {
"post" : {
+ "operationId" : "post-api-ee-action-v2-execute",
"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" : [ ],
@@ -23288,6 +24065,7 @@
},
"/api/ee/action-v2/execute-bulk" : {
"post" : {
+ "operationId" : "post-api-ee-action-v2-execute-bulk",
"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" : [ ],
@@ -23337,6 +24115,7 @@
},
"/api/ee/action-v2/execute-form" : {
"post" : {
+ "operationId" : "post-api-ee-action-v2-execute-form",
"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" : [ ],
@@ -23356,6 +24135,7 @@
},
"/api/ee/advanced-permissions/application/graph" : {
"get" : {
+ "operationId" : "get-api-ee-advanced-permissions-application-graph",
"summary" : "GET /api/ee/advanced-permissions/application/graph",
"description" : "Fetch a graph of Application Permissions.",
"parameters" : [ ],
@@ -23373,6 +24153,7 @@
"tags" : [ "/api/ee/advanced-permissions/application" ]
},
"put" : {
+ "operationId" : "put-api-ee-advanced-permissions-application-graph",
"summary" : "PUT /api/ee/advanced-permissions/application/graph",
"description" : "Do a batch update of Application Permissions by passing a modified graph.",
"parameters" : [ {
@@ -23424,9 +24205,10 @@
"tags" : [ "/api/ee/advanced-permissions/application" ]
}
},
- "/api/ee/advanced-permissions/impersonation/" : {
+ "/api/ee/advanced-permissions/impersonation" : {
"get" : {
- "summary" : "GET /api/ee/advanced-permissions/impersonation/",
+ "operationId" : "get-api-ee-advanced-permissions-impersonation",
+ "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",
@@ -23471,6 +24253,7 @@
},
"/api/ee/advanced-permissions/impersonation/{id}" : {
"delete" : {
+ "operationId" : "delete-api-ee-advanced-permissions-impersonation-id",
"summary" : "DELETE /api/ee/advanced-permissions/impersonation/{id}",
"description" : "Delete a Connection Impersonation entry.",
"parameters" : [ {
@@ -23499,6 +24282,7 @@
},
"/api/ee/ai-entity-analysis/analyze-chart" : {
"post" : {
+ "operationId" : "post-api-ee-ai-entity-analysis-analyze-chart",
"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" : [ ],
@@ -23573,6 +24357,7 @@
},
"/api/ee/ai-sql-fixer/fix" : {
"post" : {
+ "operationId" : "post-api-ee-ai-sql-fixer-fix",
"summary" : "POST /api/ee/ai-sql-fixer/fix",
"description" : "Suggest fixes for a SQL query.",
"parameters" : [ ],
@@ -23618,6 +24403,7 @@
},
"/api/ee/ai-sql-generation/generate" : {
"post" : {
+ "operationId" : "post-api-ee-ai-sql-generation-generate",
"summary" : "POST /api/ee/ai-sql-generation/generate",
"description" : "Generate a SQL query.",
"parameters" : [ ],
@@ -23658,6 +24444,7 @@
},
"/api/ee/audit-app/analytics-dev/export" : {
"post" : {
+ "operationId" : "post-api-ee-audit-app-analytics-dev-export",
"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" : [ ],
@@ -23688,6 +24475,7 @@
},
"/api/ee/audit-app/user/audit-info" : {
"get" : {
+ "operationId" : "get-api-ee-audit-app-user-audit-info",
"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" : [ ],
@@ -23707,6 +24495,7 @@
},
"/api/ee/audit-app/user/{id}/subscriptions" : {
"delete" : {
+ "operationId" : "delete-api-ee-audit-app-user-id-subscriptions",
"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" : [ {
@@ -23735,6 +24524,7 @@
},
"/api/ee/autodescribe/card/summarize" : {
"post" : {
+ "operationId" : "post-api-ee-autodescribe-card-summarize",
"summary" : "POST /api/ee/autodescribe/card/summarize",
"description" : "Summarize a question.",
"parameters" : [ ],
@@ -23849,6 +24639,7 @@
},
"/api/ee/autodescribe/dashboard/summarize/{id}" : {
"post" : {
+ "operationId" : "post-api-ee-autodescribe-dashboard-summarize-id",
"summary" : "POST /api/ee/autodescribe/dashboard/summarize/{id}",
"description" : "Provide a summary of a dashboard.",
"parameters" : [ {
@@ -23875,9 +24666,10 @@
"tags" : [ "/api/ee/autodescribe" ]
}
},
- "/api/ee/billing/" : {
+ "/api/ee/billing" : {
"get" : {
- "summary" : "GET /api/ee/billing/",
+ "operationId" : "get-api-ee-billing",
+ "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" : {
@@ -23896,6 +24688,7 @@
},
"/api/ee/cloud-add-ons/addons" : {
"get" : {
+ "operationId" : "get-api-ee-cloud-add-ons-addons",
"summary" : "GET /api/ee/cloud-add-ons/addons",
"description" : "Get addons information from the Metabase Store API.",
"parameters" : [ ],
@@ -23915,6 +24708,7 @@
},
"/api/ee/cloud-add-ons/plans" : {
"get" : {
+ "operationId" : "get-api-ee-cloud-add-ons-plans",
"summary" : "GET /api/ee/cloud-add-ons/plans",
"description" : "Get plans information from the Metabase Store API.",
"parameters" : [ ],
@@ -23934,6 +24728,7 @@
},
"/api/ee/cloud-add-ons/{product-type}" : {
"post" : {
+ "operationId" : "post-api-ee-cloud-add-ons-product-type",
"summary" : "POST /api/ee/cloud-add-ons/{product-type}",
"description" : "Purchase an add-on.",
"parameters" : [ {
@@ -23986,6 +24781,7 @@
},
"/api/ee/cloud-proxy/{operation-id}" : {
"post" : {
+ "operationId" : "post-api-ee-cloud-proxy-operation-id",
"summary" : "POST /api/ee/cloud-proxy/{operation-id}",
"description" : "Proxy a call to the Metabase Store API via harbormaster client.\n This endpoint is used only for hosted instances, and calls Harbormaster Store using a OpenAPI client.\n :operation-id is the operation-id of the Harbormaster Store endpoint.\n All parameters for the operation are taken in the POST body.",
"parameters" : [ {
@@ -24027,6 +24823,7 @@
},
"/api/ee/content-translation/csv" : {
"get" : {
+ "operationId" : "get-api-ee-content-translation-csv",
"summary" : "GET /api/ee/content-translation/csv",
"description" : "Provides content translation dictionary in CSV",
"parameters" : [ ],
@@ -24046,6 +24843,7 @@
},
"/api/ee/content-translation/dictionary" : {
"get" : {
+ "operationId" : "get-api-ee-content-translation-dictionary",
"summary" : "GET /api/ee/content-translation/dictionary",
"description" : "Fetch the content translation dictionary for authenticated users (auth-based embedding flows).",
"parameters" : [ {
@@ -24102,6 +24900,7 @@
},
"/api/ee/content-translation/dictionary/{token}" : {
"get" : {
+ "operationId" : "get-api-ee-content-translation-dictionary-token",
"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" : [ {
@@ -24129,6 +24928,7 @@
},
"/api/ee/content-translation/upload-dictionary" : {
"post" : {
+ "operationId" : "post-api-ee-content-translation-upload-dictionary",
"summary" : "POST /api/ee/content-translation/upload-dictionary",
"description" : "Upload a CSV of content translations",
"parameters" : [ ],
@@ -24170,6 +24970,7 @@
},
"/api/ee/data-studio/table/publish-tables" : {
"post" : {
+ "operationId" : "post-api-ee-data-studio-table-publish-tables",
"summary" : "POST /api/ee/data-studio/table/publish-tables",
"description" : "Set collection for each of selected tables and all upstream dependencies recursively.",
"parameters" : [ ],
@@ -24205,6 +25006,7 @@
},
"/api/ee/data-studio/table/unpublish-tables" : {
"post" : {
+ "operationId" : "post-api-ee-data-studio-table-unpublish-tables",
"summary" : "POST /api/ee/data-studio/table/unpublish-tables",
"description" : "Unset collection for each of selected tables and all downstream dependents recursively.",
"parameters" : [ ],
@@ -24240,6 +25042,7 @@
},
"/api/ee/database-replication/connection/{database-id}" : {
"post" : {
+ "operationId" : "post-api-ee-database-replication-connection-database-id",
"summary" : "POST /api/ee/database-replication/connection/{database-id}",
"description" : "Create a new PG replication connection for the specified database.",
"parameters" : [ {
@@ -24290,6 +25093,7 @@
"tags" : [ "/api/ee/database-replication" ]
},
"delete" : {
+ "operationId" : "delete-api-ee-database-replication-connection-database-id",
"summary" : "DELETE /api/ee/database-replication/connection/{database-id}",
"description" : "Delete PG replication connection for the specified database.",
"parameters" : [ {
@@ -24318,6 +25122,7 @@
},
"/api/ee/database-replication/connection/{database-id}/preview" : {
"post" : {
+ "operationId" : "post-api-ee-database-replication-connection-database-id-preview",
"summary" : "POST /api/ee/database-replication/connection/{database-id}/preview",
"description" : "Return info about pg-replication connection that is about to be created.",
"parameters" : [ {
@@ -24370,6 +25175,7 @@
},
"/api/ee/database-routing/destination-database" : {
"post" : {
+ "operationId" : "post-api-ee-database-routing-destination-database",
"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" : [ {
@@ -24431,6 +25237,7 @@
},
"/api/ee/database-routing/router-database/{id}" : {
"put" : {
+ "operationId" : "put-api-ee-database-routing-router-database-id",
"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" : [ {
@@ -24478,6 +25285,7 @@
},
"/api/ee/dependencies/check-card" : {
"post" : {
+ "operationId" : "post-api-ee-dependencies-check-card",
"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" : [ ],
@@ -24513,6 +25321,7 @@
},
"/api/ee/dependencies/check-snippet" : {
"post" : {
+ "operationId" : "post-api-ee-dependencies-check-snippet",
"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" : [ ],
@@ -24560,6 +25369,7 @@
},
"/api/ee/dependencies/check-transform" : {
"post" : {
+ "operationId" : "post-api-ee-dependencies-check-transform",
"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" : [ ],
@@ -24595,6 +25405,7 @@
},
"/api/ee/dependencies/graph" : {
"get" : {
+ "operationId" : "get-api-ee-dependencies-graph",
"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" : [ {
@@ -24644,6 +25455,7 @@
},
"/api/ee/dependencies/graph/breaking" : {
"get" : {
+ "operationId" : "get-api-ee-dependencies-graph-breaking",
"summary" : "GET /api/ee/dependencies/graph/breaking",
"description" : "Returns a list of entities that are breaking other entities (sources of errors).\n These are tables or cards that other entities depend on, where those dependents\n have validation errors traced back to this source entity.\n\n Accepts optional parameters for filtering:\n - `types`: List of source entity types - only `:card` or `:table` (default: both)\n - `card-types`: List of card types to include when filtering cards (e.g., `[:question :model :metric]`)\n - `query`: Search string to filter by name or location\n - `archived`: Controls whether archived entities are included\n - `include-personal-collections`: Controls whether items in personal collections are included (default: false)\n - `sort-column`: Sort column - `:name`, `:location`, `:dependents-errors`, or `:dependents-with-errors` (default: `:name`)\n - `sort-direction`: Sort direction - `:asc` or `:desc` (default: `:asc`)\n - `offset`: Default 0\n - `limit`: Default 50\n\n Returns a map with:\n - `data`: List of breaking source entities\n - `total`: Total count of matched items\n - `offset`: Applied offset\n - `limit`: Applied limit",
"parameters" : [ {
@@ -24759,6 +25571,7 @@
},
"/api/ee/dependencies/graph/broken" : {
"get" : {
+ "operationId" : "get-api-ee-dependencies-graph-broken",
"summary" : "GET /api/ee/dependencies/graph/broken",
"description" : "Returns the broken dependents for a specific source entity.\n These are entities that have validation errors traced back to the specified source.\n\n Required parameters:\n - `id`: The ID of the source entity\n - `type`: The type of the source entity (card, table)\n\n Optional parameters:\n - `dependent-types`: Dependency types to filter by. Can be single value or array.\n - `dependent-card-types`: Card types to filter by when dependent-types includes :card.\n - `include-personal-collections`: Include items in personal collections (default: false)\n - `sort-column`: Column to sort by - name, location, or view-count (default: name)\n - `sort-direction`: Sort direction - asc or desc (default: asc)",
"parameters" : [ {
@@ -24857,6 +25670,7 @@
},
"/api/ee/dependencies/graph/dependents" : {
"get" : {
+ "operationId" : "get-api-ee-dependencies-graph-dependents",
"summary" : "GET /api/ee/dependencies/graph/dependents",
"description" : "Returns a list of dependents for the specified entity.\n\n Required parameters:\n - `id`: The ID of the entity\n - `type`: The type of the entity (card, table, dashboard, etc.)\n\n Optional parameters:\n - `dependent-types`: Dependency types to filter by. Can be single value or array.\n If not provided, returns all types. Example: ?dependent-types=card&dependent-types=dashboard\n - `dependent-card-types`: Card types to filter by when dependent-types includes :card.\n Ignored if dependent-types doesn't include :card. Example: ?dependent-card-types=question&dependent-card-types=model\n - `archived`: Include entities in archived collections (default: false)\n - `broken`: Return only broken entities (default: false)\n - `query`: Search string to filter results by name or location (case-insensitive)\n - `include-personal-collections`: Include items in personal collections (default: false)\n - `sort-column`: Column to sort by - name, location, or view-count (default: name)\n - `sort-direction`: Sort direction - asc or desc (default: asc)",
"parameters" : [ {
@@ -24976,6 +25790,7 @@
},
"/api/ee/dependencies/graph/unreferenced" : {
"get" : {
+ "operationId" : "get-api-ee-dependencies-graph-unreferenced",
"summary" : "GET /api/ee/dependencies/graph/unreferenced",
"description" : "Returns a list of all unreferenced items in the instance.\n An unreferenced item is one that is not a dependency of any other item.\n\n Accepts optional parameters for filtering:\n - `types`: List of entity types to include (e.g., [:card :transform :snippet :dashboard])\n - `card-types`: List of card types to include when filtering cards (e.g., [:question :model :metric])\n - `query`: Search string to filter by name or location\n - `archived`: Controls whether archived entities are included\n - `include-personal-collections`: Controls whether items in personal collections are included (default: false)\n - `sort-column`: Sort column - `:name`, `:location`, `:dependents-errors`, or `:dependents-with-errors` (default: `:name`)\n - `sort-direction`: Sort direction - `:asc` or `:desc` (default: `:asc`)\n - `offset`: Default 0\n - `limit`: Default 50\n\n Returns a map with:\n - `data`: List of unreferenced items, each with `:id`, `:type`, and `:data` fields\n - `total`: Total count of matched items\n - `offset`: Applied offset\n - `limit`: Applied limit",
"parameters" : [ {
@@ -25091,6 +25906,7 @@
},
"/api/ee/email/override" : {
"put" : {
+ "operationId" : "put-api-ee-email-override",
"summary" : "PUT /api/ee/email/override",
"description" : "Update multiple cloud email Settings. You must be a superuser or have `setting` permission to do this.\n Calling this automatically sets `cloud-smtp-enabled` to true if the settings are valid.",
"parameters" : [ ],
@@ -25154,6 +25970,7 @@
"tags" : [ "/api/ee/email" ]
},
"delete" : {
+ "operationId" : "delete-api-ee-email-override",
"summary" : "DELETE /api/ee/email/override",
"description" : "Clear all cloud email related settings. You must be a superuser or have `setting` permission to do this.",
"parameters" : [ ],
@@ -25173,6 +25990,7 @@
},
"/api/ee/embedding-hub/checklist" : {
"get" : {
+ "operationId" : "get-api-ee-embedding-hub-checklist",
"summary" : "GET /api/ee/embedding-hub/checklist",
"description" : "Get the embedding hub checklist status, indicating which setup steps have been completed.",
"parameters" : [ ],
@@ -25192,6 +26010,7 @@
},
"/api/ee/gsheets/connection" : {
"post" : {
+ "operationId" : "post-api-ee-gsheets-connection",
"summary" : "POST /api/ee/gsheets/connection",
"description" : "Hook up a new google drive folder or sheet that will be watched and have its content ETL'd into Metabase.",
"parameters" : [ ],
@@ -25232,6 +26051,7 @@
"tags" : [ "/api/ee/gsheets" ]
},
"get" : {
+ "operationId" : "get-api-ee-gsheets-connection",
"summary" : "GET /api/ee/gsheets/connection",
"description" : "Check the status of a connection. This endpoint gets polled by FE to determine when to\n stop showing the setup widget.\n\n Returns the gsheets shape, with the attached datawarehouse db id at `:db_id`.",
"parameters" : [ ],
@@ -25256,6 +26076,7 @@
"tags" : [ "/api/ee/gsheets" ]
},
"delete" : {
+ "operationId" : "delete-api-ee-gsheets-connection",
"summary" : "DELETE /api/ee/gsheets/connection",
"description" : "Disconnect the google service account. There is only one (or zero) at the time of writing.",
"parameters" : [ ],
@@ -25275,6 +26096,7 @@
},
"/api/ee/gsheets/connection/sync" : {
"post" : {
+ "operationId" : "post-api-ee-gsheets-connection-sync",
"summary" : "POST /api/ee/gsheets/connection/sync",
"description" : "Force a sync of the connection now.\n\n Returns the gsheets shape, with the attached datawarehouse db id at `:db_id`.",
"parameters" : [ ],
@@ -25294,6 +26116,7 @@
},
"/api/ee/gsheets/service-account" : {
"get" : {
+ "operationId" : "get-api-ee-gsheets-service-account",
"summary" : "GET /api/ee/gsheets/service-account",
"description" : "Checks to see if service-account is setup or not, delegates to HM only if we haven't set it from a metabase cluster\n before.",
"parameters" : [ ],
@@ -25328,9 +26151,10 @@
"tags" : [ "/api/ee/gsheets" ]
}
},
- "/api/ee/library/" : {
+ "/api/ee/library" : {
"post" : {
- "summary" : "POST /api/ee/library/",
+ "operationId" : "post-api-ee-library",
+ "summary" : "POST /api/ee/library",
"description" : "Creates the Library if it doesn't exist. Returns the created collection.\n\n Requires data analyst or superuser permissions.",
"parameters" : [ ],
"responses" : {
@@ -25347,7 +26171,8 @@
"tags" : [ "/api/ee/library" ]
},
"get" : {
- "summary" : "GET /api/ee/library/",
+ "operationId" : "get-api-ee-library",
+ "summary" : "GET /api/ee/library",
"description" : "Get the Library. If no library exists, it doesn't fail but returns an empty response",
"parameters" : [ ],
"responses" : {
@@ -25383,6 +26208,7 @@
},
"/api/ee/library/tree" : {
"get" : {
+ "operationId" : "get-api-ee-library-tree",
"summary" : "GET /api/ee/library/tree",
"description" : "This matches /api/collection/tree but only returns the library collection.",
"parameters" : [ ],
@@ -25402,6 +26228,7 @@
},
"/api/ee/logs/query_execution/{yyyy-mm}" : {
"get" : {
+ "operationId" : "get-api-ee-logs-query_execution-yyyy-mm",
"summary" : "GET /api/ee/logs/query_execution/{yyyy-mm}",
"description" : "Fetch rows for the month specified by `:yyyy-mm` from the query_execution logs table.\n Must be a superuser.",
"parameters" : [ {
@@ -25430,6 +26257,7 @@
},
"/api/ee/metabot-tools/answer-sources" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-answer-sources",
"summary" : "POST /api/ee/metabot-tools/answer-sources",
"description" : "Return top level meta information about available information sources.",
"parameters" : [ ],
@@ -25500,6 +26328,7 @@
},
"/api/ee/metabot-tools/check-transform-dependencies" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-check-transform-dependencies",
"summary" : "POST /api/ee/metabot-tools/check-transform-dependencies",
"description" : "Check a proposed edit to a transform and return details of cards or transforms that would be broken by the change.",
"parameters" : [ ],
@@ -25570,6 +26399,7 @@
},
"/api/ee/metabot-tools/create-dashboard-subscription" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-create-dashboard-subscription",
"summary" : "POST /api/ee/metabot-tools/create-dashboard-subscription",
"description" : "Create a dashboard subscription.",
"parameters" : [ ],
@@ -25643,6 +26473,7 @@
},
"/api/ee/metabot-tools/field-values" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-field-values",
"summary" : "POST /api/ee/metabot-tools/field-values",
"description" : "Return statistics and/or values for a given field of a given entity.",
"parameters" : [ ],
@@ -25713,6 +26544,7 @@
},
"/api/ee/metabot-tools/filter-records" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-filter-records",
"summary" : "POST /api/ee/metabot-tools/filter-records",
"description" : "Construct a query from a metric.",
"parameters" : [ ],
@@ -25783,6 +26615,7 @@
},
"/api/ee/metabot-tools/find-outliers" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-find-outliers",
"summary" : "POST /api/ee/metabot-tools/find-outliers",
"description" : "Find outliers in the values provided by a data source for a given column.",
"parameters" : [ ],
@@ -25853,6 +26686,7 @@
},
"/api/ee/metabot-tools/generate-insights" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-generate-insights",
"summary" : "POST /api/ee/metabot-tools/generate-insights",
"description" : "Generate insights.",
"parameters" : [ ],
@@ -25932,6 +26766,7 @@
},
"/api/ee/metabot-tools/get-current-user" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-current-user",
"summary" : "POST /api/ee/metabot-tools/get-current-user",
"description" : "Get information about user that started the conversation.",
"parameters" : [ ],
@@ -25983,6 +26818,7 @@
},
"/api/ee/metabot-tools/get-dashboard-details" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-dashboard-details",
"summary" : "POST /api/ee/metabot-tools/get-dashboard-details",
"description" : "Get information about a given dashboard.",
"parameters" : [ ],
@@ -26053,6 +26889,7 @@
},
"/api/ee/metabot-tools/get-document-details" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-document-details",
"summary" : "POST /api/ee/metabot-tools/get-document-details",
"description" : "Get information about a given document.",
"parameters" : [ ],
@@ -26123,6 +26960,7 @@
},
"/api/ee/metabot-tools/get-metric-details" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-metric-details",
"summary" : "POST /api/ee/metabot-tools/get-metric-details",
"description" : "Get information about a given metric.",
"parameters" : [ ],
@@ -26193,6 +27031,7 @@
},
"/api/ee/metabot-tools/get-query-details" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-query-details",
"summary" : "POST /api/ee/metabot-tools/get-query-details",
"description" : "Get information about a given query.",
"parameters" : [ ],
@@ -26263,6 +27102,7 @@
},
"/api/ee/metabot-tools/get-report-details" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-report-details",
"summary" : "POST /api/ee/metabot-tools/get-report-details",
"description" : "Get information about a given report.",
"parameters" : [ ],
@@ -26333,6 +27173,7 @@
},
"/api/ee/metabot-tools/get-snippet-details" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-snippet-details",
"summary" : "POST /api/ee/metabot-tools/get-snippet-details",
"description" : "Get the content of a single SQL snippet.",
"parameters" : [ ],
@@ -26406,6 +27247,7 @@
},
"/api/ee/metabot-tools/get-snippets" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-snippets",
"summary" : "POST /api/ee/metabot-tools/get-snippets",
"description" : "Get a list of all known SQL snippets.",
"parameters" : [ ],
@@ -26463,6 +27305,7 @@
},
"/api/ee/metabot-tools/get-table-details" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-table-details",
"summary" : "POST /api/ee/metabot-tools/get-table-details",
"description" : "Get information about a given table or model.",
"parameters" : [ ],
@@ -26533,6 +27376,7 @@
},
"/api/ee/metabot-tools/get-tables" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-tables",
"summary" : "POST /api/ee/metabot-tools/get-tables",
"description" : "Get information about the tables in a given database.",
"parameters" : [ ],
@@ -26603,6 +27447,7 @@
},
"/api/ee/metabot-tools/get-transform-details" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-transform-details",
"summary" : "POST /api/ee/metabot-tools/get-transform-details",
"description" : "Get information about a transform.",
"parameters" : [ ],
@@ -26673,6 +27518,7 @@
},
"/api/ee/metabot-tools/get-transform-python-library-details" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-transform-python-library-details",
"summary" : "POST /api/ee/metabot-tools/get-transform-python-library-details",
"description" : "Get information about a Python library by path.",
"parameters" : [ ],
@@ -26743,6 +27589,7 @@
},
"/api/ee/metabot-tools/get-transforms" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-get-transforms",
"summary" : "POST /api/ee/metabot-tools/get-transforms",
"description" : "Get a list of all known transforms.",
"parameters" : [ ],
@@ -26794,6 +27641,7 @@
},
"/api/ee/metabot-tools/query-datasource" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-query-datasource",
"summary" : "POST /api/ee/metabot-tools/query-datasource",
"description" : "Construct a query from a model or table data source.",
"parameters" : [ ],
@@ -26864,6 +27712,7 @@
},
"/api/ee/metabot-tools/query-metric" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-query-metric",
"summary" : "POST /api/ee/metabot-tools/query-metric",
"description" : "Construct a query from a metric.",
"parameters" : [ ],
@@ -26934,6 +27783,7 @@
},
"/api/ee/metabot-tools/query-model" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-query-model",
"summary" : "POST /api/ee/metabot-tools/query-model",
"description" : "Construct a query from a model.",
"parameters" : [ ],
@@ -27004,6 +27854,7 @@
},
"/api/ee/metabot-tools/search" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-search",
"summary" : "POST /api/ee/metabot-tools/search",
"description" : "Enhanced search with term and semantic queries using Reciprocal Rank Fusion.",
"parameters" : [ ],
@@ -27074,6 +27925,7 @@
},
"/api/ee/metabot-tools/search_v2" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-tools-search_v2",
"summary" : "POST /api/ee/metabot-tools/search_v2",
"description" : "Enhanced search with term and semantic queries using Reciprocal Rank Fusion. This is identical to /search, but\n duplicated in order to add a new capability to AI service that indicates that Metabot can search transforms. The\n /search endpoint is kept around for backward compatibility.",
"parameters" : [ ],
@@ -27144,6 +27996,7 @@
},
"/api/ee/metabot-v3/agent-streaming" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-v3-agent-streaming",
"summary" : "POST /api/ee/metabot-v3/agent-streaming",
"description" : "Send a chat message to the LLM via the AI Proxy.",
"parameters" : [ ],
@@ -27204,6 +28057,7 @@
},
"/api/ee/metabot-v3/document/generate-content" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-v3-document-generate-content",
"summary" : "POST /api/ee/metabot-v3/document/generate-content",
"description" : "Create a new piece of content to insert into the document.",
"parameters" : [ ],
@@ -27244,6 +28098,7 @@
},
"/api/ee/metabot-v3/feedback" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-v3-feedback",
"summary" : "POST /api/ee/metabot-v3/feedback",
"description" : "Proxy Metabot feedback to Harbormaster, adding the premium embedding token.",
"parameters" : [ ],
@@ -27271,9 +28126,10 @@
"tags" : [ "/api/ee/metabot-v3" ]
}
},
- "/api/ee/metabot-v3/metabot/" : {
+ "/api/ee/metabot-v3/metabot" : {
"get" : {
- "summary" : "GET /api/ee/metabot-v3/metabot/",
+ "operationId" : "get-api-ee-metabot-v3-metabot",
+ "summary" : "GET /api/ee/metabot-v3/metabot",
"description" : "List configured metabot instances",
"parameters" : [ ],
"responses" : {
@@ -27292,6 +28148,7 @@
},
"/api/ee/metabot-v3/metabot/{id}" : {
"get" : {
+ "operationId" : "get-api-ee-metabot-v3-metabot-id",
"summary" : "GET /api/ee/metabot-v3/metabot/{id}",
"description" : "Retrieve one metabot instance",
"parameters" : [ {
@@ -27317,6 +28174,7 @@
"tags" : [ "/api/ee/metabot-v3/metabot" ]
},
"put" : {
+ "operationId" : "put-api-ee-metabot-v3-metabot-id",
"summary" : "PUT /api/ee/metabot-v3/metabot/{id}",
"description" : "Update a metabot instance",
"parameters" : [ {
@@ -27367,6 +28225,7 @@
},
"/api/ee/metabot-v3/metabot/{id}/prompt-suggestions" : {
"get" : {
+ "operationId" : "get-api-ee-metabot-v3-metabot-id-prompt-suggestions",
"summary" : "GET /api/ee/metabot-v3/metabot/{id}/prompt-suggestions",
"description" : "Return the prompt suggestions for the metabot instance with `id`.",
"parameters" : [ {
@@ -27415,6 +28274,7 @@
"tags" : [ "/api/ee/metabot-v3/metabot" ]
},
"delete" : {
+ "operationId" : "delete-api-ee-metabot-v3-metabot-id-prompt-suggestions",
"summary" : "DELETE /api/ee/metabot-v3/metabot/{id}/prompt-suggestions",
"description" : "Delete all prompt suggestions for the metabot instance with `id`.",
"parameters" : [ {
@@ -27442,6 +28302,7 @@
},
"/api/ee/metabot-v3/metabot/{id}/prompt-suggestions/regenerate" : {
"post" : {
+ "operationId" : "post-api-ee-metabot-v3-metabot-id-prompt-suggestions-regenerate",
"summary" : "POST /api/ee/metabot-v3/metabot/{id}/prompt-suggestions/regenerate",
"description" : "Remove any existing prompt suggestions for the Metabot instance with `id` and generate new ones.",
"parameters" : [ {
@@ -27469,6 +28330,7 @@
},
"/api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}" : {
"delete" : {
+ "operationId" : "delete-api-ee-metabot-v3-metabot-id-prompt-suggestions-prompt-id",
"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" : [ {
@@ -27502,9 +28364,10 @@
"tags" : [ "/api/ee/metabot-v3/metabot" ]
}
},
- "/api/ee/permission_debug/" : {
+ "/api/ee/permission_debug" : {
"get" : {
- "summary" : "GET /api/ee/permission_debug/",
+ "operationId" : "get-api-ee-permission_debug",
+ "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",
@@ -27553,6 +28416,7 @@
},
"/api/ee/remote-sync/branches" : {
"get" : {
+ "operationId" : "get-api-ee-remote-sync-branches",
"summary" : "GET /api/ee/remote-sync/branches",
"description" : "Get list of branches from the configured source.\n\n Returns a JSON object with branch names under the :items key.\n\n Requires superuser permissions.",
"parameters" : [ ],
@@ -27588,6 +28452,7 @@
},
"/api/ee/remote-sync/create-branch" : {
"post" : {
+ "operationId" : "post-api-ee-remote-sync-create-branch",
"summary" : "POST /api/ee/remote-sync/create-branch",
"description" : "Create a new branch from the current remote-sync branch and switches the current remote-sync branch to it.\n Requires superuser permissions.",
"parameters" : [ ],
@@ -27639,6 +28504,7 @@
},
"/api/ee/remote-sync/current-task" : {
"get" : {
+ "operationId" : "get-api-ee-remote-sync-current-task",
"summary" : "GET /api/ee/remote-sync/current-task",
"description" : "Get the current sync task",
"parameters" : [ ],
@@ -27743,6 +28609,7 @@
},
"/api/ee/remote-sync/current-task/cancel" : {
"post" : {
+ "operationId" : "post-api-ee-remote-sync-current-task-cancel",
"summary" : "POST /api/ee/remote-sync/current-task/cancel",
"description" : "Cancels the current task if one is running",
"parameters" : [ ],
@@ -27843,6 +28710,7 @@
},
"/api/ee/remote-sync/dirty" : {
"get" : {
+ "operationId" : "get-api-ee-remote-sync-dirty",
"summary" : "GET /api/ee/remote-sync/dirty",
"description" : "Return all models with changes that have not been pushed to the remote sync source in any\n remote-synced collection.",
"parameters" : [ ],
@@ -27954,6 +28822,7 @@
},
"/api/ee/remote-sync/export" : {
"post" : {
+ "operationId" : "post-api-ee-remote-sync-export",
"summary" : "POST /api/ee/remote-sync/export",
"description" : "Export the current state of the Remote Sync collection to a Source.\n\n This endpoint will:\n - Fetch the latest changes from the source\n - Create a branch or subdirectory (depending on source support)\n If no branch is supplied, use the configured export branch\n - Export the Remote Sync collection via serialization to the branch or subdirectory\n - Commit the changes if possible\n - Sync to the source if possible\n\n Requires superuser permissions.",
"parameters" : [ ],
@@ -27990,6 +28859,7 @@
},
"/api/ee/remote-sync/has-remote-changes" : {
"get" : {
+ "operationId" : "get-api-ee-remote-sync-has-remote-changes",
"summary" : "GET /api/ee/remote-sync/has-remote-changes",
"description" : "Check if there are new changes on the remote branch that can be pulled.\n Uses in-memory caching (configurable TTL via remote-sync-check-changes-cache-ttl-seconds setting).\n\n Returns:\n - has_changes: true if remote version differs from last imported version, or if never imported\n - remote_version: current Git SHA on remote branch\n - local_version: Git SHA of last successful import (nil if never imported)\n - cached: true if result was served from cache",
"parameters" : [ {
@@ -28046,6 +28916,7 @@
},
"/api/ee/remote-sync/import" : {
"post" : {
+ "operationId" : "post-api-ee-remote-sync-import",
"summary" : "POST /api/ee/remote-sync/import",
"description" : "Import Metabase content from configured Remote Sync source.\n\n This endpoint will:\n - Fetch the latest changes from the configured source\n - Load the updated content using the serialization/deserialization system\n\n If `force=false` (default) and there are unsaved changes in the Remote Sync collection,\n the import returns a 400 response.\n\n Requires superuser permissions.",
"parameters" : [ ],
@@ -28111,6 +28982,7 @@
},
"/api/ee/remote-sync/is-dirty" : {
"get" : {
+ "operationId" : "get-api-ee-remote-sync-is-dirty",
"summary" : "GET /api/ee/remote-sync/is-dirty",
"description" : "Check if any remote-synced collection or collection item has local changes that have not been pushed\n to the remote sync source.",
"parameters" : [ ],
@@ -28143,6 +29015,7 @@
},
"/api/ee/remote-sync/settings" : {
"put" : {
+ "operationId" : "put-api-ee-remote-sync-settings",
"summary" : "PUT /api/ee/remote-sync/settings",
"description" : "Update Remote Sync related settings. You must be a superuser to do this.",
"parameters" : [ ],
@@ -28243,6 +29116,7 @@
},
"/api/ee/remote-sync/stash" : {
"post" : {
+ "operationId" : "post-api-ee-remote-sync-stash",
"summary" : "POST /api/ee/remote-sync/stash",
"description" : "Stashes changes to a new branch, and changes the current branch to it.\n Requires superuser permissions.",
"parameters" : [ ],
@@ -28302,6 +29176,7 @@
},
"/api/ee/scim/api_key" : {
"get" : {
+ "operationId" : "get-api-ee-scim-api_key",
"summary" : "GET /api/ee/scim/api_key",
"description" : "Fetch the SCIM API key if one exists. Does *not* return an unmasked key, since we don't have access\n to that after it is created.",
"parameters" : [ ],
@@ -28319,6 +29194,7 @@
"tags" : [ "/api/ee/scim" ]
},
"post" : {
+ "operationId" : "post-api-ee-scim-api_key",
"summary" : "POST /api/ee/scim/api_key",
"description" : "Create a new SCIM API key, or refresh one that already exists. When called for the first time,\n this is equivalent to enabling SCIM.",
"parameters" : [ ],
@@ -28338,6 +29214,7 @@
},
"/api/ee/scim/v2/Groups" : {
"get" : {
+ "operationId" : "get-api-ee-scim-v2-Groups",
"summary" : "GET /api/ee/scim/v2/Groups",
"description" : "Fetch a list of groups.",
"parameters" : [ {
@@ -28393,6 +29270,7 @@
"tags" : [ "/api/ee/scim/v2" ]
},
"post" : {
+ "operationId" : "post-api-ee-scim-v2-Groups",
"summary" : "POST /api/ee/scim/v2/Groups",
"description" : "Create a single group, and populates it if necessary.",
"parameters" : [ ],
@@ -28456,6 +29334,7 @@
},
"/api/ee/scim/v2/Groups/{id}" : {
"get" : {
+ "operationId" : "get-api-ee-scim-v2-Groups-id",
"summary" : "GET /api/ee/scim/v2/Groups/{id}",
"description" : "Fetch a single group.",
"parameters" : [ {
@@ -28481,6 +29360,7 @@
"tags" : [ "/api/ee/scim/v2" ]
},
"put" : {
+ "operationId" : "put-api-ee-scim-v2-Groups-id",
"summary" : "PUT /api/ee/scim/v2/Groups/{id}",
"description" : "Update a group.",
"parameters" : [ ],
@@ -28542,6 +29422,7 @@
"tags" : [ "/api/ee/scim/v2" ]
},
"delete" : {
+ "operationId" : "delete-api-ee-scim-v2-Groups-id",
"summary" : "DELETE /api/ee/scim/v2/Groups/{id}",
"description" : "Delete a group.",
"parameters" : [ {
@@ -28569,6 +29450,7 @@
},
"/api/ee/scim/v2/Users" : {
"get" : {
+ "operationId" : "get-api-ee-scim-v2-Users",
"summary" : "GET /api/ee/scim/v2/Users",
"description" : "Fetch a list of users.",
"parameters" : [ {
@@ -28624,6 +29506,7 @@
"tags" : [ "/api/ee/scim/v2" ]
},
"post" : {
+ "operationId" : "post-api-ee-scim-v2-Users",
"summary" : "POST /api/ee/scim/v2/Users",
"description" : "Create a single user.",
"parameters" : [ ],
@@ -28734,6 +29617,7 @@
},
"/api/ee/scim/v2/Users/{id}" : {
"get" : {
+ "operationId" : "get-api-ee-scim-v2-Users-id",
"summary" : "GET /api/ee/scim/v2/Users/{id}",
"description" : "Fetch a single user.",
"parameters" : [ {
@@ -28759,6 +29643,7 @@
"tags" : [ "/api/ee/scim/v2" ]
},
"put" : {
+ "operationId" : "put-api-ee-scim-v2-Users-id",
"summary" : "PUT /api/ee/scim/v2/Users/{id}",
"description" : "Update a user.",
"parameters" : [ ],
@@ -28867,6 +29752,7 @@
"tags" : [ "/api/ee/scim/v2" ]
},
"patch" : {
+ "operationId" : "patch-api-ee-scim-v2-Users-id",
"summary" : "PATCH /api/ee/scim/v2/Users/{id}",
"description" : "Activate or deactivate a user. Supports specific replace operations, but not arbitrary patches.",
"parameters" : [ {
@@ -28944,6 +29830,7 @@
},
"/api/ee/semantic-search/status" : {
"get" : {
+ "operationId" : "get-api-ee-semantic-search-status",
"summary" : "GET /api/ee/semantic-search/status",
"description" : "Fetch the indexing status of the currently active semantic search index table.\n\n Returns a map with keys:\n :indexed_count <number of indexed items>\n :total_est <estimated total number of items to index>\n\n If no index is active, returns an empty map.",
"parameters" : [ ],
@@ -28963,6 +29850,7 @@
},
"/api/ee/serialization/export" : {
"post" : {
+ "operationId" : "post-api-ee-serialization-export",
"summary" : "POST /api/ee/serialization/export",
"description" : "Serialize and retrieve Metabase instance.\n\n Outputs `.tar.gz` file with serialization results and an `export.log` file.\n On error outputs serialization logs directly.",
"parameters" : [ {
@@ -29075,6 +29963,7 @@
},
"/api/ee/serialization/import" : {
"post" : {
+ "operationId" : "post-api-ee-serialization-import",
"summary" : "POST /api/ee/serialization/import",
"description" : "Deserialize Metabase instance from an archive generated by /export.\n\n Parameters:\n - `file`: archive encoded as `multipart/form-data` (required).\n\n Returns logs of deserialization.",
"parameters" : [ {
@@ -29148,6 +30037,7 @@
},
"/api/ee/stale/{id}" : {
"get" : {
+ "operationId" : "get-api-ee-stale-id",
"summary" : "GET /api/ee/stale/{id}",
"description" : "A flexible endpoint that returns stale entities, in the same shape as collections/items, with the following options:\n - `before_date` - only return entities that were last edited before this date (default: 6 months ago)\n - `is_recursive` - if true, return entities from all children of the collection, not just the direct children (default: false)\n - `sort_column` - the column to sort by (default: name)\n - `sort_direction` - the direction to sort by (default: asc)",
"parameters" : [ {
@@ -29215,9 +30105,10 @@
"tags" : [ "/api/ee/stale" ]
}
},
- "/api/ee/support-access-grant/" : {
+ "/api/ee/support-access-grant" : {
"post" : {
- "summary" : "POST /api/ee/support-access-grant/",
+ "operationId" : "post-api-ee-support-access-grant",
+ "summary" : "POST /api/ee/support-access-grant",
"description" : "Create a new support access grant.\n\n Requires superuser permissions. Only one active grant can exist at a time.",
"parameters" : [ ],
"responses" : {
@@ -29250,7 +30141,8 @@
"tags" : [ "/api/ee/support-access-grant" ]
},
"get" : {
- "summary" : "GET /api/ee/support-access-grant/",
+ "operationId" : "get-api-ee-support-access-grant",
+ "summary" : "GET /api/ee/support-access-grant",
"description" : "List support access grants with optional filtering and pagination.\n\n Requires superuser permissions.\n\n Query parameters:\n - ticket-number: Filter by ticket number\n - user-id: Filter by user who created the grant\n - include-revoked: Include revoked grants (default false)",
"parameters" : [ {
"in" : "query",
@@ -29311,6 +30203,7 @@
},
"/api/ee/support-access-grant/current" : {
"get" : {
+ "operationId" : "get-api-ee-support-access-grant-current",
"summary" : "GET /api/ee/support-access-grant/current",
"description" : "Get the currently active support access grant, if one exists.\n\n Requires superuser permissions.",
"parameters" : [ ],
@@ -29337,6 +30230,7 @@
},
"/api/ee/support-access-grant/{id}/revoke" : {
"put" : {
+ "operationId" : "put-api-ee-support-access-grant-id-revoke",
"summary" : "PUT /api/ee/support-access-grant/{id}/revoke",
"description" : "Revoke an existing support access grant.\n\n Requires superuser permissions. Any admin can revoke any grant.",
"parameters" : [ {
@@ -29370,9 +30264,10 @@
"tags" : [ "/api/ee/support-access-grant" ]
}
},
- "/api/ee/tenant/" : {
+ "/api/ee/tenant" : {
"post" : {
- "summary" : "POST /api/ee/tenant/",
+ "operationId" : "post-api-ee-tenant",
+ "summary" : "POST /api/ee/tenant",
"description" : "Create a new Tenant",
"parameters" : [ ],
"responses" : {
@@ -29466,7 +30361,8 @@
"tags" : [ "/api/ee/tenant" ]
},
"get" : {
- "summary" : "GET /api/ee/tenant/",
+ "operationId" : "get-api-ee-tenant",
+ "summary" : "GET /api/ee/tenant",
"description" : "Get all tenants",
"parameters" : [ {
"in" : "query",
@@ -29551,6 +30447,7 @@
},
"/api/ee/tenant/{id}" : {
"put" : {
+ "operationId" : "put-api-ee-tenant-id",
"summary" : "PUT /api/ee/tenant/{id}",
"description" : "Update a tenant, can set name, attributes, or whether this tenant is active.",
"parameters" : [ {
@@ -29659,6 +30556,7 @@
"tags" : [ "/api/ee/tenant" ]
},
"get" : {
+ "operationId" : "get-api-ee-tenant-id",
"summary" : "GET /api/ee/tenant/{id}",
"description" : "Get info about a tenant",
"parameters" : [ {
@@ -29734,6 +30632,7 @@
},
"/api/ee/transforms-python/library/{path}" : {
"get" : {
+ "operationId" : "get-api-ee-transforms-python-library-path",
"summary" : "GET /api/ee/transforms-python/library/{path}",
"description" : "Get the Python library for user modules.",
"parameters" : [ {
@@ -29759,6 +30658,7 @@
"tags" : [ "/api/ee/transforms-python" ]
},
"put" : {
+ "operationId" : "put-api-ee-transforms-python-library-path",
"summary" : "PUT /api/ee/transforms-python/library/{path}",
"description" : "Update the Python library source code for user modules.",
"parameters" : [ {
@@ -29802,6 +30702,7 @@
},
"/api/ee/transforms-python/test-run" : {
"post" : {
+ "operationId" : "post-api-ee-transforms-python-test-run",
"summary" : "POST /api/ee/transforms-python/test-run",
"description" : "Evaluate an ad-hoc python transform on a sample of input data.\n Intended for short runs for early feedback. Input/output/timeout limits apply.",
"parameters" : [ ],
@@ -29909,6 +30810,7 @@
},
"/api/ee/upload-management/tables" : {
"get" : {
+ "operationId" : "get-api-ee-upload-management-tables",
"summary" : "GET /api/ee/upload-management/tables",
"description" : "Get all `Tables` visible to the current user which were created by uploading a file.",
"parameters" : [ ],
@@ -29928,6 +30830,7 @@
},
"/api/ee/upload-management/tables/{id}" : {
"delete" : {
+ "operationId" : "delete-api-ee-upload-management-tables-id",
"summary" : "DELETE /api/ee/upload-management/tables/{id}",
"description" : "Delete the uploaded table from the database, optionally archiving cards for which it is the primary source.",
"parameters" : [ {
@@ -29966,9 +30869,10 @@
"tags" : [ "/api/ee/upload-management" ]
}
},
- "/api/ee/workspace/" : {
+ "/api/ee/workspace" : {
"get" : {
- "summary" : "GET /api/ee/workspace/",
+ "operationId" : "get-api-ee-workspace",
+ "summary" : "GET /api/ee/workspace",
"description" : "Get a list of all workspaces",
"parameters" : [ ],
"responses" : {
@@ -30036,7 +30940,8 @@
"tags" : [ "/api/ee/workspace" ]
},
"post" : {
- "summary" : "POST /api/ee/workspace/",
+ "operationId" : "post-api-ee-workspace",
+ "summary" : "POST /api/ee/workspace",
"description" : "Create a new workspace\n\n Potential payload:\n {:name \"a\" :database_id 2}}",
"parameters" : [ ],
"responses" : {
@@ -30109,6 +31014,7 @@
},
"/api/ee/workspace/checkout" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-checkout",
"summary" : "GET /api/ee/workspace/checkout",
"description" : "Get checkout status for a global transform.\n\n Returns:\n - checkout_disabled: Why this transform cannot be checked out (nil if allowed)\n - workspaces: All workspaces for this transform's database, with checkout status\n - transforms: (DEPRECATED) Use :workspaces instead",
"parameters" : [ {
@@ -30218,6 +31124,7 @@
},
"/api/ee/workspace/database" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-database",
"summary" : "GET /api/ee/workspace/database",
"description" : "Get a list supported databases, and whether they're enabled and have required permissions.",
"parameters" : [ ],
@@ -30282,6 +31189,7 @@
},
"/api/ee/workspace/enabled" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-enabled",
"summary" : "GET /api/ee/workspace/enabled",
"description" : "Test whether the current user can use Workspaces. Optionally takes a specific database.\n Factors include: driver support, database user privileges, metabase permissions.",
"parameters" : [ {
@@ -30326,6 +31234,7 @@
},
"/api/ee/workspace/{ws-id}" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-ws-id",
"summary" : "GET /api/ee/workspace/{ws-id}",
"description" : "Get a single workspace by ID",
"parameters" : [ {
@@ -30388,6 +31297,7 @@
"tags" : [ "/api/ee/workspace" ]
},
"put" : {
+ "operationId" : "put-api-ee-workspace-ws-id",
"summary" : "PUT /api/ee/workspace/{ws-id}",
"description" : "Update simple workspace properties.\n\n Can set database_id only on uninitialized workspaces.",
"parameters" : [ {
@@ -30469,6 +31379,7 @@
"tags" : [ "/api/ee/workspace" ]
},
"delete" : {
+ "operationId" : "delete-api-ee-workspace-ws-id",
"summary" : "DELETE /api/ee/workspace/{ws-id}",
"description" : "Delete a workspace and all its contents, including mirrored entities.",
"parameters" : [ {
@@ -30510,6 +31421,7 @@
},
"/api/ee/workspace/{ws-id}/archive" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-archive",
"summary" : "POST /api/ee/workspace/{ws-id}/archive",
"description" : "Archive a workspace. Deletes the isolated schema and tables, but preserves mirrored entities.",
"parameters" : [ {
@@ -30574,6 +31486,7 @@
},
"/api/ee/workspace/{ws-id}/external/transform" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-external-transform",
"summary" : "GET /api/ee/workspace/{ws-id}/external/transform",
"description" : "Get transforms that are external to the workspace, i.e. no matching workspace_transform row exists.",
"parameters" : [ {
@@ -30642,6 +31555,7 @@
},
"/api/ee/workspace/{ws-id}/graph" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-graph",
"summary" : "GET /api/ee/workspace/{ws-id}/graph",
"description" : "Display the dependency graph between the Changeset and the (potentially external) entities that they depend on.",
"parameters" : [ {
@@ -30692,6 +31606,7 @@
},
"/api/ee/workspace/{ws-id}/input/grant" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-input-grant",
"summary" : "POST /api/ee/workspace/{ws-id}/input/grant",
"description" : "Grant read access to input tables by table coordinates. Superuser only.\n Idempotent - returns which tables were already granted vs newly granted.",
"parameters" : [ {
@@ -30812,6 +31727,7 @@
},
"/api/ee/workspace/{ws-id}/input/pending" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-input-pending",
"summary" : "GET /api/ee/workspace/{ws-id}/input/pending",
"description" : "List all input tables that haven't been granted access yet, excluding tables shadowed by workspace outputs.",
"parameters" : [ {
@@ -30870,6 +31786,7 @@
},
"/api/ee/workspace/{ws-id}/log" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-log",
"summary" : "GET /api/ee/workspace/{ws-id}/log",
"description" : "Get workspace creation status and recent log entries for polling during async setup",
"parameters" : [ {
@@ -30961,6 +31878,7 @@
},
"/api/ee/workspace/{ws-id}/merge" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-merge",
"summary" : "POST /api/ee/workspace/{ws-id}/merge",
"description" : "This will:\n 1. Update original transforms with workspace versions\n 2. Archive the workspace and clean up isolated resources\n Returns a report of merged entities, or error in errors key.\n\n Request body may include:\n - commit-message: A description of what changes are being merged (optional, will be required in future)",
"parameters" : [ {
@@ -31080,6 +31998,7 @@
},
"/api/ee/workspace/{ws-id}/problem" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-problem",
"summary" : "GET /api/ee/workspace/{ws-id}/problem",
"description" : "Detect problems in the workspace that would affect downstream transforms after merge.\n\n Returns a list of problems, each with:\n - category: the problem category (e.g. 'unused', 'internal-downstream', 'external-downstream')\n - problem: the specific problem (e.g. 'not-run', 'stale', 'removed-field')\n - severity: :error, :warning, or :info\n - block-merge: whether this problem prevents merging\n - data: extra information, shape depends on the problem type\n\n See `metabase-enterprise.workspaces.types/problem-types` for the full list.",
"parameters" : [ {
@@ -31118,6 +32037,7 @@
},
"/api/ee/workspace/{ws-id}/query" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-query",
"summary" : "POST /api/ee/workspace/{ws-id}/query",
"description" : "Execute an arbitrary SQL query in the workspace's isolated database context.\n Table references are remapped to isolated workspace tables.\n Returns the first 2000 rows of query results.",
"parameters" : [ {
@@ -31167,6 +32087,7 @@
},
"/api/ee/workspace/{ws-id}/run" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-run",
"summary" : "POST /api/ee/workspace/{ws-id}/run",
"description" : "Execute all transforms in the workspace in dependency order.\n Returns which transforms succeeded, failed, and were not run.",
"parameters" : [ {
@@ -31235,6 +32156,7 @@
},
"/api/ee/workspace/{ws-id}/table" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-table",
"summary" : "GET /api/ee/workspace/{ws-id}/table",
"description" : "Get workspace tables",
"parameters" : [ {
@@ -31286,6 +32208,7 @@
},
"/api/ee/workspace/{ws-id}/transform" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform",
"summary" : "POST /api/ee/workspace/{ws-id}/transform",
"description" : "Add another transform to the Changeset. This could be a fork of an existing global transform, or something new.",
"parameters" : [ {
@@ -31408,6 +32331,7 @@
"tags" : [ "/api/ee/workspace" ]
},
"get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-transform",
"summary" : "GET /api/ee/workspace/{ws-id}/transform",
"description" : "Get all transforms in a workspace.",
"parameters" : [ {
@@ -31481,6 +32405,7 @@
},
"/api/ee/workspace/{ws-id}/transform/validate/target" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform-validate-target",
"summary" : "POST /api/ee/workspace/{ws-id}/transform/validate/target",
"description" : "Validate the target table for a workspace transform",
"parameters" : [ {
@@ -31571,6 +32496,7 @@
},
"/api/ee/workspace/{ws-id}/transform/{tx-id}" : {
"get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-transform-tx-id",
"summary" : "GET /api/ee/workspace/{ws-id}/transform/{tx-id}",
"description" : "Get a specific transform in a workspace.",
"parameters" : [ {
@@ -31675,6 +32601,7 @@
"tags" : [ "/api/ee/workspace" ]
},
"put" : {
+ "operationId" : "put-api-ee-workspace-ws-id-transform-tx-id",
"summary" : "PUT /api/ee/workspace/{ws-id}/transform/{tx-id}",
"description" : "Update or create a transform in a workspace.\n If the transform exists, updates it. If it doesn't exist, creates a new transform with the provided ref_id.\n For creation, name, source, and target are required.",
"parameters" : [ {
@@ -31806,6 +32733,7 @@
"tags" : [ "/api/ee/workspace" ]
},
"delete" : {
+ "operationId" : "delete-api-ee-workspace-ws-id-transform-tx-id",
"summary" : "DELETE /api/ee/workspace/{ws-id}/transform/{tx-id}",
"description" : "Discard a transform from the changeset.\n Equivalent to resetting a checked-out transform to its global definition, or deleting a provisional transform.",
"parameters" : [ {
@@ -31846,6 +32774,7 @@
},
"/api/ee/workspace/{ws-id}/transform/{tx-id}/archive" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-archive",
"summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/archive",
"description" : "Mark the given transform to be archived when the workspace is merged.\n For provisional transforms we will skip even creating it in the first place.",
"parameters" : [ {
@@ -31886,6 +32815,7 @@
},
"/api/ee/workspace/{ws-id}/transform/{tx-id}/dry-run" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-dry-run",
"summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/dry-run",
"description" : "Dry-run a transform in a workspace without persisting to the target table.\n\n Returns the first 2000 rows of transform output for preview purposes.\n Does not update last_run_at or create any database tables.\n\n When run_stale_ancestors is true, any stale ancestor transforms will be executed first\n in dependency order (these ARE persisted). If any ancestor fails, execution stops and\n the dry-run will not proceed.",
"parameters" : [ {
@@ -31940,6 +32870,7 @@
},
"/api/ee/workspace/{ws-id}/transform/{tx-id}/merge" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-merge",
"summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/merge",
"description" : "Merge single transform from workspace back to the core. If workspace transform is archived\n the corresponding core transform is deleted.\n\n Request body may include:\n - commit-message: A description of what changes are being merged (optional, will be required in future)",
"parameters" : [ {
@@ -32015,6 +32946,7 @@
},
"/api/ee/workspace/{ws-id}/transform/{tx-id}/run" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-run",
"summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/run",
"description" : "Run a transform in a workspace.\n\n App DB changes are rolled back. Warehouse DB changes persist.\n\n When run_stale_ancestors is true, any stale ancestor transforms will be executed first\n in dependency order. If any ancestor fails, execution stops and remaining ancestors\n are marked as not_run. The target transform will not run if any ancestor failed.",
"parameters" : [ {
@@ -32069,6 +33001,7 @@
},
"/api/ee/workspace/{ws-id}/transform/{tx-id}/unarchive" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-unarchive",
"summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/unarchive",
"description" : "Unmark the given transform for archival. This will recall the last definition it had within the workspace.",
"parameters" : [ {
@@ -32109,6 +33042,7 @@
},
"/api/ee/workspace/{ws-id}/unarchive" : {
"post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-unarchive",
"summary" : "POST /api/ee/workspace/{ws-id}/unarchive",
"description" : "Restore an archived workspace. Recreates the isolated schema and tables.",
"parameters" : [ {
@@ -32173,6 +33107,7 @@
},
"/api/eid-translation/translate" : {
"post" : {
+ "operationId" : "post-api-eid-translation-translate",
"summary" : "POST /api/eid-translation/translate",
"description" : "Translate entity IDs to model IDs.",
"parameters" : [ ],
@@ -32206,9 +33141,10 @@
"tags" : [ "/api/eid-translation" ]
}
},
- "/api/email/" : {
+ "/api/email" : {
"put" : {
- "summary" : "PUT /api/email/",
+ "operationId" : "put-api-email",
+ "summary" : "PUT /api/email",
"description" : "Update multiple email Settings. You must be a superuser or have `setting` permission to do this.",
"parameters" : [ ],
"responses" : {
@@ -32271,7 +33207,8 @@
"tags" : [ "/api/email" ]
},
"delete" : {
- "summary" : "DELETE /api/email/",
+ "operationId" : "delete-api-email",
+ "summary" : "DELETE /api/email",
"description" : "Clear all email related settings. You must be a superuser or have `setting` permission to do this.",
"parameters" : [ ],
"responses" : {
@@ -32290,6 +33227,7 @@
},
"/api/email/test" : {
"post" : {
+ "operationId" : "post-api-email-test",
"summary" : "POST /api/email/test",
"description" : "Send a test email using the SMTP Settings. You must be a superuser or have `setting` permission to do this.\n Returns `{:ok true}` if we were able to send the message successfully, otherwise a standard 400 error response.",
"parameters" : [ ],
@@ -32309,6 +33247,7 @@
},
"/api/embed/card/{token}" : {
"get" : {
+ "operationId" : "get-api-embed-card-token",
"summary" : "GET /api/embed/card/{token}",
"description" : "Fetch a Card via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}}",
"parameters" : [ {
@@ -32335,6 +33274,7 @@
},
"/api/embed/card/{token}/params/{param-key}/remapping" : {
"get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-remapping",
"summary" : "GET /api/embed/card/{token}/params/{param-key}/remapping",
"description" : "Embedded version of api.card filter values endpoint.",
"parameters" : [ {
@@ -32376,6 +33316,7 @@
},
"/api/embed/card/{token}/params/{param-key}/search/{prefix}" : {
"get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-search-prefix",
"summary" : "GET /api/embed/card/{token}/params/{param-key}/search/{prefix}",
"description" : "Embedded version of chain filter search endpoint.",
"parameters" : [ {
@@ -32418,6 +33359,7 @@
},
"/api/embed/card/{token}/params/{param-key}/values" : {
"get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-values",
"summary" : "GET /api/embed/card/{token}/params/{param-key}/values",
"description" : "Embedded version of api.card filter values endpoint.",
"parameters" : [ {
@@ -32452,6 +33394,7 @@
},
"/api/embed/card/{token}/query" : {
"get" : {
+ "operationId" : "get-api-embed-card-token-query",
"summary" : "GET /api/embed/card/{token}/query",
"description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
"parameters" : [ {
@@ -32478,6 +33421,7 @@
},
"/api/embed/card/{token}/query/{export-format}" : {
"get" : {
+ "operationId" : "get-api-embed-card-token-query-export-format",
"summary" : "GET /api/embed/card/{token}/query/{export-format}",
"description" : "Like `GET /api/embed/card/query`, but returns the results as a file in the specified format.",
"parameters" : [ {
@@ -32527,6 +33471,7 @@
},
"/api/embed/dashboard/{token}" : {
"get" : {
+ "operationId" : "get-api-embed-dashboard-token",
"summary" : "GET /api/embed/dashboard/{token}",
"description" : "Fetch a Dashboard via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:dashboard <dashboard-id>}}",
"parameters" : [ {
@@ -32553,6 +33498,7 @@
},
"/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
+ "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id",
"summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
"description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
"parameters" : [ {
@@ -32597,6 +33543,7 @@
},
"/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
"get" : {
+ "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id-export-format",
"summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
"description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key` return the data in one of the export formats",
"parameters" : [ {
@@ -32664,6 +33611,7 @@
},
"/api/embed/dashboard/{token}/params/{param-key}/remapping" : {
"get" : {
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-remapping",
"summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/remapping",
"description" : "Embedded version of the remapped dashboard param value endpoint.",
"parameters" : [ {
@@ -32698,6 +33646,7 @@
},
"/api/embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
"get" : {
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-search-prefix",
"summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/search/{prefix}",
"description" : "Embedded version of chain filter search endpoint.",
"parameters" : [ {
@@ -32740,6 +33689,7 @@
},
"/api/embed/dashboard/{token}/params/{param-key}/values" : {
"get" : {
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-values",
"summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/values",
"description" : "Embedded version of chain filter values endpoint.",
"parameters" : [ {
@@ -32774,6 +33724,7 @@
},
"/api/embed/pivot/card/{token}/query" : {
"get" : {
+ "operationId" : "get-api-embed-pivot-card-token-query",
"summary" : "GET /api/embed/pivot/card/{token}/query",
"description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
"parameters" : [ {
@@ -32800,6 +33751,7 @@
},
"/api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
+ "operationId" : "get-api-embed-pivot-dashboard-token-dashcard-dashcard-id-card-card-id",
"summary" : "GET /api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
"description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
"parameters" : [ {
@@ -32844,6 +33796,7 @@
},
"/api/embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
"get" : {
+ "operationId" : "get-api-embed-tiles-card-token-zoom-x-y",
"summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for an embedded Card using the map visualization.",
"parameters" : [ {
@@ -32916,6 +33869,7 @@
},
"/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
+ "operationId" : "get-api-embed-tiles-dashboard-token-dashcard-dashcard-id-card-card-id-zoom-x-y",
"summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
"parameters" : [ {
@@ -33006,6 +33960,7 @@
},
"/api/field/{id}" : {
"get" : {
+ "operationId" : "get-api-field-id",
"summary" : "GET /api/field/{id}",
"description" : "Get `Field` with ID.",
"parameters" : [ {
@@ -33040,6 +33995,7 @@
"tags" : [ "/api/field" ]
},
"put" : {
+ "operationId" : "put-api-field-id",
"summary" : "PUT /api/field/{id}",
"description" : "Update `Field` with ID.",
"parameters" : [ {
@@ -33176,6 +34132,7 @@
},
"/api/field/{id}/dimension" : {
"post" : {
+ "operationId" : "post-api-field-id-dimension",
"summary" : "POST /api/field/{id}/dimension",
"description" : "Sets the dimension for the given field at ID",
"parameters" : [ {
@@ -33231,6 +34188,7 @@
"tags" : [ "/api/field" ]
},
"delete" : {
+ "operationId" : "delete-api-field-id-dimension",
"summary" : "DELETE /api/field/{id}/dimension",
"description" : "Remove the dimension associated to field at ID",
"parameters" : [ {
@@ -33259,6 +34217,7 @@
},
"/api/field/{id}/discard_values" : {
"post" : {
+ "operationId" : "post-api-field-id-discard_values",
"summary" : "POST /api/field/{id}/discard_values",
"description" : "Discard the FieldValues belonging to this Field. Only applies to fields that have FieldValues. If this Field's\n Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.",
"parameters" : [ {
@@ -33287,6 +34246,7 @@
},
"/api/field/{id}/related" : {
"get" : {
+ "operationId" : "get-api-field-id-related",
"summary" : "GET /api/field/{id}/related",
"description" : "Return related entities.",
"parameters" : [ {
@@ -33315,6 +34275,7 @@
},
"/api/field/{id}/remapping/{remapped-id}" : {
"get" : {
+ "operationId" : "get-api-field-id-remapping-remapped-id",
"summary" : "GET /api/field/{id}/remapping/{remapped-id}",
"description" : "Fetch remapped Field values.",
"parameters" : [ {
@@ -33360,6 +34321,7 @@
},
"/api/field/{id}/rescan_values" : {
"post" : {
+ "operationId" : "post-api-field-id-rescan_values",
"summary" : "POST /api/field/{id}/rescan_values",
"description" : "Manually trigger an update for the FieldValues for this Field. Only applies to Fields that are eligible for\n FieldValues.",
"parameters" : [ {
@@ -33388,6 +34350,7 @@
},
"/api/field/{id}/search/{search-id}" : {
"get" : {
+ "operationId" : "get-api-field-id-search-search-id",
"summary" : "GET /api/field/{id}/search/{search-id}",
"description" : "Search for values of a Field with `search-id` that start with `value`. See docstring for\n [[metabase.parameters.field/search-values]] for a more detailed explanation.",
"parameters" : [ {
@@ -33433,6 +34396,7 @@
},
"/api/field/{id}/summary" : {
"get" : {
+ "operationId" : "get-api-field-id-summary",
"summary" : "GET /api/field/{id}/summary",
"description" : "Get the count and distinct count of `Field` with ID.",
"parameters" : [ {
@@ -33461,6 +34425,7 @@
},
"/api/field/{id}/values" : {
"get" : {
+ "operationId" : "get-api-field-id-values",
"summary" : "GET /api/field/{id}/values",
"description" : "If a Field's value of `has_field_values` is `:list`, return a list of all the distinct values of the Field (or\n remapped Field), and (if defined by a User) a map of human-readable remapped values. If `has_field_values` is not\n `:list`, checks whether we should create FieldValues for this Field; if so, creates and returns them.",
"parameters" : [ {
@@ -33487,6 +34452,7 @@
"tags" : [ "/api/field" ]
},
"post" : {
+ "operationId" : "post-api-field-id-values",
"summary" : "POST /api/field/{id}/values",
"description" : "Update the fields values and human-readable values for a `Field` whose semantic type is\n `category`/`city`/`state`/`country` or whose base type is `type/Boolean`. The human-readable values are optional.",
"parameters" : [ {
@@ -33540,9 +34506,10 @@
"tags" : [ "/api/field" ]
}
},
- "/api/geojson/" : {
+ "/api/geojson" : {
"get" : {
- "summary" : "GET /api/geojson/",
+ "operationId" : "get-api-geojson",
+ "summary" : "GET /api/geojson",
"description" : "Load a custom GeoJSON file based on a URL or file path provided as a query parameter.\n This behaves similarly to /api/geojson/:key but doesn't require the custom map to be saved to the DB first.",
"parameters" : [ {
"in" : "query",
@@ -33569,6 +34536,7 @@
},
"/api/geojson/{key}" : {
"get" : {
+ "operationId" : "get-api-geojson-key",
"summary" : "GET /api/geojson/{key}",
"description" : "Fetch a custom GeoJSON file as defined in the [[metabase.geojson.settings/custom-geojson]] setting. (This just acts\n as a simple proxy for the file specified for `key`).",
"parameters" : [ {
@@ -33594,9 +34562,10 @@
"tags" : [ "/api/geojson" ]
}
},
- "/api/glossary/" : {
+ "/api/glossary" : {
"get" : {
- "summary" : "GET /api/glossary/",
+ "operationId" : "get-api-glossary",
+ "summary" : "GET /api/glossary",
"description" : "Fetch all glossary entries, optionally filtered by search term.",
"parameters" : [ ],
"responses" : {
@@ -33613,7 +34582,8 @@
"tags" : [ "/api/glossary" ]
},
"post" : {
- "summary" : "POST /api/glossary/",
+ "operationId" : "post-api-glossary",
+ "summary" : "POST /api/glossary",
"description" : "Create a new glossary entry.",
"parameters" : [ ],
"responses" : {
@@ -33652,6 +34622,7 @@
},
"/api/glossary/{id}" : {
"put" : {
+ "operationId" : "put-api-glossary-id",
"summary" : "PUT /api/glossary/{id}",
"description" : "Update an existing glossary entry.",
"parameters" : [ {
@@ -33698,6 +34669,7 @@
"tags" : [ "/api/glossary" ]
},
"delete" : {
+ "operationId" : "delete-api-glossary-id",
"summary" : "DELETE /api/glossary/{id}",
"description" : "Delete a glossary entry.",
"parameters" : [ {
@@ -33726,6 +34698,7 @@
},
"/api/google/settings" : {
"put" : {
+ "operationId" : "put-api-google-settings",
"summary" : "PUT /api/google/settings",
"description" : "Update Google Sign-In related settings. You must be a superuser to do this.",
"parameters" : [ ],
@@ -33777,6 +34750,7 @@
},
"/api/ldap/settings" : {
"put" : {
+ "operationId" : "put-api-ldap-settings",
"summary" : "PUT /api/ldap/settings",
"description" : "Update LDAP related settings. You must be a superuser to do this.",
"parameters" : [ ],
@@ -33836,6 +34810,7 @@
},
"/api/llm/extract-tables" : {
"post" : {
+ "operationId" : "post-api-llm-extract-tables",
"summary" : "POST /api/llm/extract-tables",
"description" : "Parse SQL and return referenced tables with their columns.\n\n Uses Macaw to parse the SQL, resolves table names to IDs,\n and returns permission-filtered tables with column metadata.\n\n This is a lightweight endpoint that does not trigger fingerprinting\n or field value fetching.",
"parameters" : [ ],
@@ -33970,6 +34945,7 @@
},
"/api/llm/generate-sql" : {
"post" : {
+ "operationId" : "post-api-llm-generate-sql",
"summary" : "POST /api/llm/generate-sql",
"description" : "Generate SQL from a natural language prompt.\n\n Requires:\n - LLM to be configured (Anthropic API key set in admin settings)\n - At least one table reference (explicit @mention or implicit from source_sql)\n - A database_id parameter\n\n Returns generated SQL and the list of tables used for context.",
"parameters" : [ ],
@@ -34129,6 +35105,7 @@
},
"/api/llm/list-models" : {
"get" : {
+ "operationId" : "get-api-llm-list-models",
"summary" : "GET /api/llm/list-models",
"description" : "List available LLM models from the configured provider.\n\n Requires LLM to be configured (Anthropic API key set in admin settings).",
"parameters" : [ ],
@@ -34173,6 +35150,7 @@
},
"/api/logger/adjustment" : {
"post" : {
+ "operationId" : "post-api-logger-adjustment",
"summary" : "POST /api/logger/adjustment",
"description" : "Temporarily adjust the log levels.",
"parameters" : [ ],
@@ -34209,6 +35187,7 @@
"tags" : [ "/api/logger" ]
},
"delete" : {
+ "operationId" : "delete-api-logger-adjustment",
"summary" : "DELETE /api/logger/adjustment",
"description" : "Undo any log level adjustments.",
"parameters" : [ ],
@@ -34228,6 +35207,7 @@
},
"/api/logger/logs" : {
"get" : {
+ "operationId" : "get-api-logger-logs",
"summary" : "GET /api/logger/logs",
"description" : "Logs.",
"parameters" : [ ],
@@ -34247,6 +35227,7 @@
},
"/api/logger/presets" : {
"get" : {
+ "operationId" : "get-api-logger-presets",
"summary" : "GET /api/logger/presets",
"description" : "Get all known presets.",
"parameters" : [ ],
@@ -34300,6 +35281,7 @@
},
"/api/login-history/current" : {
"get" : {
+ "operationId" : "get-api-login-history-current",
"summary" : "GET /api/login-history/current",
"description" : "Fetch recent logins for the current user.",
"parameters" : [ ],
@@ -34317,9 +35299,10 @@
"tags" : [ "/api/login-history" ]
}
},
- "/api/measure/" : {
+ "/api/measure" : {
"post" : {
- "summary" : "POST /api/measure/",
+ "operationId" : "post-api-measure",
+ "summary" : "POST /api/measure",
"description" : "Create a new `Measure`.",
"parameters" : [ ],
"responses" : {
@@ -34376,7 +35359,8 @@
"tags" : [ "/api/measure" ]
},
"get" : {
- "summary" : "GET /api/measure/",
+ "operationId" : "get-api-measure",
+ "summary" : "GET /api/measure",
"description" : "Fetch *all* `Measures`.",
"parameters" : [ ],
"responses" : {
@@ -34405,6 +35389,7 @@
},
"/api/measure/{id}" : {
"get" : {
+ "operationId" : "get-api-measure-id",
"summary" : "GET /api/measure/{id}",
"description" : "Fetch `Measure` with ID.",
"parameters" : [ {
@@ -34438,6 +35423,7 @@
"tags" : [ "/api/measure" ]
},
"put" : {
+ "operationId" : "put-api-measure-id",
"summary" : "PUT /api/measure/{id}",
"description" : "Update a `Measure` with ID.",
"parameters" : [ {
@@ -34517,9 +35503,10 @@
"tags" : [ "/api/measure" ]
}
},
- "/api/model-index/" : {
+ "/api/model-index" : {
"post" : {
- "summary" : "POST /api/model-index/",
+ "operationId" : "post-api-model-index",
+ "summary" : "POST /api/model-index",
"description" : "Create ModelIndex.",
"parameters" : [ ],
"responses" : {
@@ -34555,7 +35542,8 @@
"tags" : [ "/api/model-index" ]
},
"get" : {
- "summary" : "GET /api/model-index/",
+ "operationId" : "get-api-model-index",
+ "summary" : "GET /api/model-index",
"description" : "Retrieve list of ModelIndex.",
"parameters" : [ {
"in" : "query",
@@ -34583,6 +35571,7 @@
},
"/api/model-index/{id}" : {
"get" : {
+ "operationId" : "get-api-model-index-id",
"summary" : "GET /api/model-index/{id}",
"description" : "Retrieve ModelIndex.",
"parameters" : [ {
@@ -34609,6 +35598,7 @@
"tags" : [ "/api/model-index" ]
},
"delete" : {
+ "operationId" : "delete-api-model-index-id",
"summary" : "DELETE /api/model-index/{id}",
"description" : "Delete ModelIndex.",
"parameters" : [ {
@@ -34635,9 +35625,10 @@
"tags" : [ "/api/model-index" ]
}
},
- "/api/moderation-review/" : {
+ "/api/moderation-review" : {
"post" : {
- "summary" : "POST /api/moderation-review/",
+ "operationId" : "post-api-moderation-review",
+ "summary" : "POST /api/moderation-review",
"description" : "Create a new `ModerationReview`.",
"parameters" : [ ],
"responses" : {
@@ -34693,9 +35684,10 @@
"tags" : [ "/api/moderation-review" ]
}
},
- "/api/mt/gtap/" : {
+ "/api/mt/gtap" : {
"get" : {
- "summary" : "GET /api/mt/gtap/",
+ "operationId" : "get-api-mt-gtap",
+ "summary" : "GET /api/mt/gtap",
"description" : "Fetch a list of all GTAPs currently in use, or a single GTAP if both `group_id` and `table_id` are provided.",
"parameters" : [ {
"in" : "query",
@@ -34738,7 +35730,8 @@
"tags" : [ "/api/mt/gtap" ]
},
"post" : {
- "summary" : "POST /api/mt/gtap/",
+ "operationId" : "post-api-mt-gtap",
+ "summary" : "POST /api/mt/gtap",
"description" : "Create a new GTAP.",
"parameters" : [ ],
"responses" : {
@@ -34791,6 +35784,7 @@
},
"/api/mt/gtap/validate" : {
"post" : {
+ "operationId" : "post-api-mt-gtap-validate",
"summary" : "POST /api/mt/gtap/validate",
"description" : "Validate a sandbox which may not have yet been saved. This runs the same validation that is performed when the\n sandbox is saved, but doesn't actually save the sandbox.",
"parameters" : [ ],
@@ -34836,6 +35830,7 @@
},
"/api/mt/gtap/{id}" : {
"get" : {
+ "operationId" : "get-api-mt-gtap-id",
"summary" : "GET /api/mt/gtap/{id}",
"description" : "Fetch GTAP by `id`",
"parameters" : [ {
@@ -34862,6 +35857,7 @@
"tags" : [ "/api/mt/gtap" ]
},
"put" : {
+ "operationId" : "put-api-mt-gtap-id",
"summary" : "PUT /api/mt/gtap/{id}",
"description" : "Update a GTAP entry. The only things you're allowed to update for a GTAP are the Card being used (`card_id`) or the\n parameter mappings; changing `table_id` or `group_id` would effectively be deleting this entry and creating a new\n one. If that's what you want to do, do so explicitly with appropriate calls to the `DELETE` and `POST` endpoints.",
"parameters" : [ {
@@ -34911,6 +35907,7 @@
"tags" : [ "/api/mt/gtap" ]
},
"delete" : {
+ "operationId" : "delete-api-mt-gtap-id",
"summary" : "DELETE /api/mt/gtap/{id}",
"description" : "Delete a GTAP entry.",
"parameters" : [ {
@@ -34939,6 +35936,7 @@
},
"/api/mt/user/attributes" : {
"get" : {
+ "operationId" : "get-api-mt-user-attributes",
"summary" : "GET /api/mt/user/attributes",
"description" : "Fetch a list of possible keys for User `login_attributes`. This includes keys from tenant model\n attributes and keys that have already been set for existing Users.",
"parameters" : [ ],
@@ -34958,6 +35956,7 @@
},
"/api/mt/user/{id}/attributes" : {
"put" : {
+ "operationId" : "put-api-mt-user-id-attributes",
"summary" : "PUT /api/mt/user/{id}/attributes",
"description" : "Update the `login_attributes` for a User.",
"parameters" : [ {
@@ -35004,9 +36003,10 @@
"tags" : [ "/api/mt/user" ]
}
},
- "/api/native-query-snippet/" : {
+ "/api/native-query-snippet" : {
"get" : {
- "summary" : "GET /api/native-query-snippet/",
+ "operationId" : "get-api-native-query-snippet",
+ "summary" : "GET /api/native-query-snippet",
"description" : "Fetch all snippets",
"parameters" : [ {
"in" : "query",
@@ -35035,7 +36035,8 @@
"tags" : [ "/api/native-query-snippet" ]
},
"post" : {
- "summary" : "POST /api/native-query-snippet/",
+ "operationId" : "post-api-native-query-snippet",
+ "summary" : "POST /api/native-query-snippet",
"description" : "Create a new `NativeQuerySnippet`.",
"parameters" : [ ],
"responses" : {
@@ -35088,6 +36089,7 @@
},
"/api/native-query-snippet/{id}" : {
"get" : {
+ "operationId" : "get-api-native-query-snippet-id",
"summary" : "GET /api/native-query-snippet/{id}",
"description" : "Fetch native query snippet with ID.",
"parameters" : [ {
@@ -35114,6 +36116,7 @@
"tags" : [ "/api/native-query-snippet" ]
},
"put" : {
+ "operationId" : "put-api-native-query-snippet-id",
"summary" : "PUT /api/native-query-snippet/{id}",
"description" : "Update an existing `NativeQuerySnippet`.",
"parameters" : [ {
@@ -35188,9 +36191,10 @@
"tags" : [ "/api/native-query-snippet" ]
}
},
- "/api/notification/" : {
+ "/api/notification" : {
"get" : {
- "summary" : "GET /api/notification/",
+ "operationId" : "get-api-notification",
+ "summary" : "GET /api/notification",
"description" : "List notifications.\n - `creator_id`: if provided returns only notifications created by this user\n - `recipient_id`: if provided returns only notification that has recipient_id as a recipient\n - `creator_or_recipient_id`: if provided returns only notification that has user_id as creator or recipient\n - `card_id`: if provided returns only notification that has card_id as payload",
"parameters" : [ {
"in" : "query",
@@ -35262,7 +36266,8 @@
"tags" : [ "/api/notification" ]
},
"post" : {
- "summary" : "POST /api/notification/",
+ "operationId" : "post-api-notification",
+ "summary" : "POST /api/notification",
"description" : "Create a new notification, return the created notification.",
"parameters" : [ ],
"responses" : {
@@ -35290,6 +36295,7 @@
},
"/api/notification/send" : {
"post" : {
+ "operationId" : "post-api-notification-send",
"summary" : "POST /api/notification/send",
"description" : "Send an unsaved notification.",
"parameters" : [ ],
@@ -35316,9 +36322,10 @@
"tags" : [ "/api/notification" ]
}
},
- "/api/notification/unsubscribe/" : {
+ "/api/notification/unsubscribe" : {
"post" : {
- "summary" : "POST /api/notification/unsubscribe/",
+ "operationId" : "post-api-notification-unsubscribe",
+ "summary" : "POST /api/notification/unsubscribe",
"description" : "Allow non-users to unsubscribe from notifications, with the hash given through email.",
"parameters" : [ ],
"responses" : {
@@ -35360,6 +36367,7 @@
},
"/api/notification/unsubscribe/undo" : {
"post" : {
+ "operationId" : "post-api-notification-unsubscribe-undo",
"summary" : "POST /api/notification/unsubscribe/undo",
"description" : "Allow non-users to undo an unsubscribe from notifications, with the hash given through email.",
"parameters" : [ ],
@@ -35402,6 +36410,7 @@
},
"/api/notification/{id}" : {
"get" : {
+ "operationId" : "get-api-notification-id",
"summary" : "GET /api/notification/{id}",
"description" : "Get a notification by id.",
"parameters" : [ {
@@ -35428,6 +36437,7 @@
"tags" : [ "/api/notification" ]
},
"put" : {
+ "operationId" : "put-api-notification-id",
"summary" : "PUT /api/notification/{id}",
"description" : "Update a notification, can also update its subscriptions, handlers.\n Return the updated notification.",
"parameters" : [ {
@@ -35465,6 +36475,7 @@
},
"/api/notification/{id}/send" : {
"post" : {
+ "operationId" : "post-api-notification-id-send",
"summary" : "POST /api/notification/{id}/send",
"description" : "Send a notification by id.",
"parameters" : [ {
@@ -35512,6 +36523,7 @@
},
"/api/notification/{id}/unsubscribe" : {
"post" : {
+ "operationId" : "post-api-notification-id-unsubscribe",
"summary" : "POST /api/notification/{id}/unsubscribe",
"description" : "Unsubscribe current user from a notification.",
"parameters" : [ {
@@ -35540,6 +36552,7 @@
},
"/api/notify/db/attached_datawarehouse" : {
"post" : {
+ "operationId" : "post-api-notify-db-attached_datawarehouse",
"summary" : "POST /api/notify/db/attached_datawarehouse",
"description" : "Sync the attached datawarehouse. Can provide in the body:\n - table_name and schema_name: both strings. Will look for an existing table and sync it, otherwise will try to find a\n new table with that name and sync it. If it cannot find a table it will throw an error. If table_name is empty or\n blank, will sync the entire database.\n - synchronous?: is a boolean value to indicate if this should block on the result.",
"parameters" : [ ],
@@ -35594,6 +36607,7 @@
},
"/api/notify/db/{id}" : {
"post" : {
+ "operationId" : "post-api-notify-db-id",
"summary" : "POST /api/notify/db/{id}",
"description" : "Notification about a potential schema change to one of our `Databases`.\n Caller can optionally specify a `:table_id` or `:table_name` in the body to limit updates to a single\n `Table`. Optional Parameter `:scan` can be `\"full\"` or `\"schema\"` for a full sync or a schema sync, available\n regardless if a `:table_id` or `:table_name` is passed.\n This endpoint is secured by an API key that needs to be passed as a `X-METABASE-APIKEY` header which needs to be defined in\n the `MB_API_KEY` [environment variable](https://www.metabase.com/docs/latest/configuring-metabase/environment-variables.html#mb_api_key)",
"parameters" : [ {
@@ -35658,6 +36672,7 @@
},
"/api/notify/db/{id}/new-table" : {
"post" : {
+ "operationId" : "post-api-notify-db-id-new-table",
"summary" : "POST /api/notify/db/{id}/new-table",
"description" : "Sync a new table without running a full database sync. Requires `schema_name` and `table_name`. Will throw an error\n if the table already exists in Metabase or cannot be found.",
"parameters" : [ {
@@ -35706,6 +36721,7 @@
},
"/api/permissions/graph" : {
"get" : {
+ "operationId" : "get-api-permissions-graph",
"summary" : "GET /api/permissions/graph",
"description" : "Fetch a graph of all Permissions.",
"parameters" : [ ],
@@ -35723,6 +36739,7 @@
"tags" : [ "/api/permissions" ]
},
"put" : {
+ "operationId" : "put-api-permissions-graph",
"summary" : "PUT /api/permissions/graph",
"description" : "Do a batch update of Permissions by passing in a modified graph. This should return the same graph, in the same\n format, that you got from `GET /api/permissions/graph`, with any changes made in the wherever necessary. This\n modified graph must correspond to the `PermissionsGraph` schema. If successful, this endpoint returns the updated\n permissions graph; use this as a base for any further modifications.\n\n Revisions to the permissions graph are tracked. If you fetch the permissions graph and some other third-party\n modifies it before you can submit you revisions, the endpoint will instead make no changes and return a\n 409 (Conflict) response. In this case, you should fetch the updated graph and make desired changes to that.\n\n The optional `sandboxes` key contains a list of sandboxes that should be created or modified in conjunction with\n this permissions graph update. Since data sandboxing is an Enterprise Edition-only feature, a 402 (Payment Required)\n response will be returned if this key is present and the server is not running the Enterprise Edition, and/or the\n `:sandboxes` feature flag is not present.\n\n If the skip-graph query param is truthy, then the graph will not be returned.",
"parameters" : [ {
@@ -35776,6 +36793,7 @@
},
"/api/permissions/graph/db/{db-id}" : {
"get" : {
+ "operationId" : "get-api-permissions-graph-db-db-id",
"summary" : "GET /api/permissions/graph/db/{db-id}",
"description" : "Fetch a graph of all Permissions for db-id `db-id`.",
"parameters" : [ {
@@ -35804,6 +36822,7 @@
},
"/api/permissions/graph/group/{group-id}" : {
"get" : {
+ "operationId" : "get-api-permissions-graph-group-group-id",
"summary" : "GET /api/permissions/graph/group/{group-id}",
"description" : "Fetch a graph of all Permissions for group-id `group-id`.",
"parameters" : [ {
@@ -35832,6 +36851,7 @@
},
"/api/permissions/group" : {
"get" : {
+ "operationId" : "get-api-permissions-group",
"summary" : "GET /api/permissions/group",
"description" : "Fetch all `PermissionsGroups`, including a count of the number of `:members` in that group.\n This API requires superuser or group manager of more than one group.\n Group manager is only available if `advanced-permissions` is enabled and returns only groups that user\n is manager of.\n\n Optional query parameter `tenancy` can be used to filter groups:\n - `tenancy=external`: Returns only tenant groups (where `is_tenant_group = true`)\n - `tenancy=internal`: Returns only non-tenant groups (where `is_tenant_group = false`)\n - No `tenancy` parameter: Returns all groups (default behavior)",
"parameters" : [ {
@@ -35857,6 +36877,7 @@
"tags" : [ "/api/permissions" ]
},
"post" : {
+ "operationId" : "post-api-permissions-group",
"summary" : "POST /api/permissions/group",
"description" : "Create a new `PermissionsGroup`.",
"parameters" : [ ],
@@ -35899,6 +36920,7 @@
},
"/api/permissions/group/{group-id}" : {
"put" : {
+ "operationId" : "put-api-permissions-group-group-id",
"summary" : "PUT /api/permissions/group/{group-id}",
"description" : "Update the name of a `PermissionsGroup`.",
"parameters" : [ {
@@ -35941,6 +36963,7 @@
"tags" : [ "/api/permissions" ]
},
"delete" : {
+ "operationId" : "delete-api-permissions-group-group-id",
"summary" : "DELETE /api/permissions/group/{group-id}",
"description" : "Delete a specific `PermissionsGroup`.",
"parameters" : [ {
@@ -35969,6 +36992,7 @@
},
"/api/permissions/group/{id}" : {
"get" : {
+ "operationId" : "get-api-permissions-group-id",
"summary" : "GET /api/permissions/group/{id}",
"description" : "Fetch the details for a certain permissions group.",
"parameters" : [ {
@@ -35997,6 +37021,7 @@
},
"/api/permissions/membership" : {
"get" : {
+ "operationId" : "get-api-permissions-membership",
"summary" : "GET /api/permissions/membership",
"description" : "Fetch a map describing the group memberships of various users.\n This map's format is:\n\n {<user-id> [{:membership_id <id>\n :group_id <id>\n :is_group_manager boolean}]}",
"parameters" : [ ],
@@ -36014,6 +37039,7 @@
"tags" : [ "/api/permissions" ]
},
"post" : {
+ "operationId" : "post-api-permissions-membership",
"summary" : "POST /api/permissions/membership",
"description" : "Add a `User` to a `PermissionsGroup`. Returns updated list of members belonging to the group.",
"parameters" : [ ],
@@ -36063,6 +37089,7 @@
},
"/api/permissions/membership/{group-id}/clear" : {
"put" : {
+ "operationId" : "put-api-permissions-membership-group-id-clear",
"summary" : "PUT /api/permissions/membership/{group-id}/clear",
"description" : "Remove all members from a `PermissionsGroup`. Returns a 400 (Bad Request) if the group ID is for the admin group.",
"parameters" : [ {
@@ -36091,6 +37118,7 @@
},
"/api/permissions/membership/{id}" : {
"put" : {
+ "operationId" : "put-api-permissions-membership-id",
"summary" : "PUT /api/permissions/membership/{id}",
"description" : "Update a Permission Group membership. Returns the updated record.",
"parameters" : [ {
@@ -36132,6 +37160,7 @@
"tags" : [ "/api/permissions" ]
},
"delete" : {
+ "operationId" : "delete-api-permissions-membership-id",
"summary" : "DELETE /api/permissions/membership/{id}",
"description" : "Remove a User from a PermissionsGroup (delete their membership).",
"parameters" : [ {
@@ -36158,9 +37187,10 @@
"tags" : [ "/api/permissions" ]
}
},
- "/api/persist/" : {
+ "/api/persist" : {
"get" : {
- "summary" : "GET /api/persist/",
+ "operationId" : "get-api-persist",
+ "summary" : "GET /api/persist",
"description" : "List the entries of [[PersistedInfo]] in order to show a status page.",
"parameters" : [ ],
"responses" : {
@@ -36179,6 +37209,7 @@
},
"/api/persist/card/{card-id}" : {
"get" : {
+ "operationId" : "get-api-persist-card-card-id",
"summary" : "GET /api/persist/card/{card-id}",
"description" : "Fetch a particular [[PersistedInfo]] by card-id.",
"parameters" : [ {
@@ -36207,6 +37238,7 @@
},
"/api/persist/card/{card-id}/persist" : {
"post" : {
+ "operationId" : "post-api-persist-card-card-id-persist",
"summary" : "POST /api/persist/card/{card-id}/persist",
"description" : "Mark the model (card) as persisted. Runs the query and saves it to the database backing the card and hot swaps this\n query in place of the model's query.",
"parameters" : [ {
@@ -36235,6 +37267,7 @@
},
"/api/persist/card/{card-id}/refresh" : {
"post" : {
+ "operationId" : "post-api-persist-card-card-id-refresh",
"summary" : "POST /api/persist/card/{card-id}/refresh",
"description" : "Refresh the persisted model caching `card-id`.",
"parameters" : [ {
@@ -36263,6 +37296,7 @@
},
"/api/persist/card/{card-id}/unpersist" : {
"post" : {
+ "operationId" : "post-api-persist-card-card-id-unpersist",
"summary" : "POST /api/persist/card/{card-id}/unpersist",
"description" : "Unpersist this model. Deletes the persisted table backing the model and all queries after this will use the card's\n query rather than the saved version of the query.",
"parameters" : [ {
@@ -36291,6 +37325,7 @@
},
"/api/persist/database/{id}/persist" : {
"post" : {
+ "operationId" : "post-api-persist-database-id-persist",
"summary" : "POST /api/persist/database/{id}/persist",
"description" : "Attempt to enable model persistence for a database. If already enabled returns a generic 204.",
"parameters" : [ {
@@ -36319,6 +37354,7 @@
},
"/api/persist/database/{id}/unpersist" : {
"post" : {
+ "operationId" : "post-api-persist-database-id-unpersist",
"summary" : "POST /api/persist/database/{id}/unpersist",
"description" : "Attempt to disable model persistence for a database. If already not enabled, just returns a generic 204.",
"parameters" : [ {
@@ -36347,6 +37383,7 @@
},
"/api/persist/disable" : {
"post" : {
+ "operationId" : "post-api-persist-disable",
"summary" : "POST /api/persist/disable",
"description" : "Disable global setting to allow databases to persist models. This will remove all tasks to refresh tables, remove\n that option from databases which might have it enabled, and delete all cached tables.",
"parameters" : [ ],
@@ -36366,6 +37403,7 @@
},
"/api/persist/enable" : {
"post" : {
+ "operationId" : "post-api-persist-enable",
"summary" : "POST /api/persist/enable",
"description" : "Enable global setting to allow databases to persist models.",
"parameters" : [ ],
@@ -36385,6 +37423,7 @@
},
"/api/persist/set-refresh-schedule" : {
"post" : {
+ "operationId" : "post-api-persist-set-refresh-schedule",
"summary" : "POST /api/persist/set-refresh-schedule",
"description" : "Set the cron schedule to refresh persisted models.\n Shape should be JSON like {cron: \"0 30 1/8 * * ? *\"}.",
"parameters" : [ ],
@@ -36421,6 +37460,7 @@
},
"/api/persist/{persisted-info-id}" : {
"get" : {
+ "operationId" : "get-api-persist-persisted-info-id",
"summary" : "GET /api/persist/{persisted-info-id}",
"description" : "Fetch a particular [[PersistedInfo]] by id.",
"parameters" : [ {
@@ -36449,6 +37489,7 @@
},
"/api/premium-features/token/refresh" : {
"post" : {
+ "operationId" : "post-api-premium-features-token-refresh",
"summary" : "POST /api/premium-features/token/refresh",
"description" : "Clear all token caches and re-check the premium features token against the MetaStore.\n Returns the fresh token status. Useful for the frontend after a purchase so that new features\n are recognized without waiting for the cache TTL.",
"parameters" : [ ],
@@ -36468,6 +37509,7 @@
},
"/api/premium-features/token/status" : {
"get" : {
+ "operationId" : "get-api-premium-features-token-status",
"summary" : "GET /api/premium-features/token/status",
"description" : "Fetch info about the current Premium-Features premium features token including whether it is `valid`, a `trial` token, its\n `features`, when it is `valid-thru`, and the `status` of the account.",
"parameters" : [ ],
@@ -36487,6 +37529,7 @@
},
"/api/preview_embed/card/{token}" : {
"get" : {
+ "operationId" : "get-api-preview_embed-card-token",
"summary" : "GET /api/preview_embed/card/{token}",
"description" : "Fetch a Card you're considering embedding by passing a JWT `token`.",
"parameters" : [ {
@@ -36513,6 +37556,7 @@
},
"/api/preview_embed/card/{token}/params/{param-key}/remapping" : {
"get" : {
+ "operationId" : "get-api-preview_embed-card-token-params-param-key-remapping",
"summary" : "GET /api/preview_embed/card/{token}/params/{param-key}/remapping",
"description" : "Embedded version of api.card filter values endpoint.",
"parameters" : [ {
@@ -36554,6 +37598,7 @@
},
"/api/preview_embed/card/{token}/params/{param-key}/values" : {
"get" : {
+ "operationId" : "get-api-preview_embed-card-token-params-param-key-values",
"summary" : "GET /api/preview_embed/card/{token}/params/{param-key}/values",
"description" : "Embedded version of api.card filter values endpoint.",
"parameters" : [ {
@@ -36614,6 +37659,7 @@
},
"/api/preview_embed/card/{token}/query" : {
"get" : {
+ "operationId" : "get-api-preview_embed-card-token-query",
"summary" : "GET /api/preview_embed/card/{token}/query",
"description" : "Fetch the query results for a Card you're considering embedding by passing a JWT `token`.",
"parameters" : [ {
@@ -36640,6 +37686,7 @@
},
"/api/preview_embed/dashboard/{token}" : {
"get" : {
+ "operationId" : "get-api-preview_embed-dashboard-token",
"summary" : "GET /api/preview_embed/dashboard/{token}",
"description" : "Fetch a Dashboard you're considering embedding by passing a JWT `token`. ",
"parameters" : [ {
@@ -36666,6 +37713,7 @@
},
"/api/preview_embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
+ "operationId" : "get-api-preview_embed-dashboard-token-dashcard-dashcard-id-card-card-id",
"summary" : "GET /api/preview_embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
"description" : "Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT `token`.",
"parameters" : [ {
@@ -36710,6 +37758,7 @@
},
"/api/preview_embed/dashboard/{token}/params/{param-key}/remapping" : {
"get" : {
+ "operationId" : "get-api-preview_embed-dashboard-token-params-param-key-remapping",
"summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/remapping",
"description" : "Embedded version of the remapped dashboard param value endpoint.",
"parameters" : [ {
@@ -36744,6 +37793,7 @@
},
"/api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
"get" : {
+ "operationId" : "get-api-preview_embed-dashboard-token-params-param-key-search-prefix",
"summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}",
"description" : "Embedded version of chain filter search endpoint.",
"parameters" : [ {
@@ -36786,6 +37836,7 @@
},
"/api/preview_embed/dashboard/{token}/params/{param-key}/values" : {
"get" : {
+ "operationId" : "get-api-preview_embed-dashboard-token-params-param-key-values",
"summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/values",
"description" : "Embedded version of chain filter values endpoint.",
"parameters" : [ {
@@ -36820,6 +37871,7 @@
},
"/api/preview_embed/pivot/card/{token}/query" : {
"get" : {
+ "operationId" : "get-api-preview_embed-pivot-card-token-query",
"summary" : "GET /api/preview_embed/pivot/card/{token}/query",
"description" : "Fetch the query results for a Card you're considering embedding by passing a JWT `token`.",
"parameters" : [ {
@@ -36846,6 +37898,7 @@
},
"/api/preview_embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
+ "operationId" : "get-api-preview_embed-pivot-dashboard-token-dashcard-dashcard-id-card-card-id",
"summary" : "GET /api/preview_embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
"description" : "Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT `token`.",
"parameters" : [ {
@@ -36890,6 +37943,7 @@
},
"/api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
"get" : {
+ "operationId" : "get-api-preview_embed-tiles-card-token-zoom-x-y",
"summary" : "GET /api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for an embedded Card using the map visualization.",
"parameters" : [ {
@@ -36962,6 +38016,7 @@
},
"/api/preview_embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
+ "operationId" : "get-api-preview_embed-tiles-dashboard-token-dashcard-dashcard-id-card-card-id-zoom-x-y",
"summary" : "GET /api/preview_embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
"parameters" : [ {
@@ -37050,9 +38105,10 @@
"tags" : [ "/api/preview_embed" ]
}
},
- "/api/product-feedback/" : {
+ "/api/product-feedback" : {
"post" : {
- "summary" : "POST /api/product-feedback/",
+ "operationId" : "post-api-product-feedback",
+ "summary" : "POST /api/product-feedback",
"description" : "Endpoint to provide feedback from the product",
"parameters" : [ ],
"responses" : {
@@ -37103,6 +38159,7 @@
},
"/api/public/action/{uuid}" : {
"get" : {
+ "operationId" : "get-api-public-action-uuid",
"summary" : "GET /api/public/action/{uuid}",
"description" : "Fetch a publicly-accessible Action. Does not require auth credentials. Public sharing must be enabled.",
"parameters" : [ {
@@ -37131,6 +38188,7 @@
},
"/api/public/action/{uuid}/execute" : {
"post" : {
+ "operationId" : "post-api-public-action-uuid-execute",
"summary" : "POST /api/public/action/{uuid}/execute",
"description" : "Execute the Action.\n\n `parameters` should be the mapped dashboard parameters with values.",
"parameters" : [ {
@@ -37178,6 +38236,7 @@
},
"/api/public/card/{uuid}" : {
"get" : {
+ "operationId" : "get-api-public-card-uuid",
"summary" : "GET /api/public/card/{uuid}",
"description" : "Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth\n credentials. Public sharing must be enabled.",
"parameters" : [ {
@@ -37206,6 +38265,7 @@
},
"/api/public/card/{uuid}/params/{param-key}/remapping" : {
"get" : {
+ "operationId" : "get-api-public-card-uuid-params-param-key-remapping",
"summary" : "GET /api/public/card/{uuid}/params/{param-key}/remapping",
"description" : "Fetch the remapped value for the given `value` of parameter with ID `:param-key` of card with UUID `uuid`.",
"parameters" : [ {
@@ -37247,6 +38307,7 @@
},
"/api/public/card/{uuid}/params/{param-key}/search/{query}" : {
"get" : {
+ "operationId" : "get-api-public-card-uuid-params-param-key-search-query",
"summary" : "GET /api/public/card/{uuid}/params/{param-key}/search/{query}",
"description" : "Fetch values for a parameter on a public card containing `query`.",
"parameters" : [ {
@@ -37291,6 +38352,7 @@
},
"/api/public/card/{uuid}/params/{param-key}/values" : {
"get" : {
+ "operationId" : "get-api-public-card-uuid-params-param-key-values",
"summary" : "GET /api/public/card/{uuid}/params/{param-key}/values",
"description" : "Fetch values for a parameter on a public card.",
"parameters" : [ {
@@ -37327,6 +38389,7 @@
},
"/api/public/card/{uuid}/query" : {
"get" : {
+ "operationId" : "get-api-public-card-uuid-query",
"summary" : "GET /api/public/card/{uuid}/query",
"description" : "Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth\n credentials. Public sharing must be enabled.",
"parameters" : [ {
@@ -37367,6 +38430,7 @@
},
"/api/public/card/{uuid}/query/{export-format}" : {
"get" : {
+ "operationId" : "get-api-public-card-uuid-query-export-format",
"summary" : "GET /api/public/card/{uuid}/query/{export-format}",
"description" : "Fetch a publicly-accessible Card and return query results in the specified format. Does not require auth\n credentials. Public sharing must be enabled.",
"parameters" : [ {
@@ -37430,6 +38494,7 @@
},
"/api/public/dashboard/{uuid}" : {
"get" : {
+ "operationId" : "get-api-public-dashboard-uuid",
"summary" : "GET /api/public/dashboard/{uuid}",
"description" : "Fetch a publicly-accessible Dashboard. Does not require auth credentials. Public sharing must be enabled.",
"parameters" : [ {
@@ -37458,6 +38523,7 @@
},
"/api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
+ "operationId" : "get-api-public-dashboard-uuid-dashcard-dashcard-id-card-card-id",
"summary" : "GET /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}",
"description" : "Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Public\n sharing must be enabled.",
"parameters" : [ {
@@ -37516,6 +38582,7 @@
},
"/api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
"post" : {
+ "operationId" : "post-api-public-dashboard-uuid-dashcard-dashcard-id-card-card-id-export-format",
"summary" : "POST /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
"description" : "Fetch the results of running a publicly-accessible Card belonging to a Dashboard and return the data in one of the\n export formats. Does not require auth credentials. Public sharing must be enabled.",
"parameters" : [ {
@@ -37600,6 +38667,7 @@
},
"/api/public/dashboard/{uuid}/dashcard/{dashcard-id}/execute" : {
"get" : {
+ "operationId" : "get-api-public-dashboard-uuid-dashcard-dashcard-id-execute",
"summary" : "GET /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/execute",
"description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",
"parameters" : [ {
@@ -37643,6 +38711,7 @@
"tags" : [ "/api/public" ]
},
"post" : {
+ "operationId" : "post-api-public-dashboard-uuid-dashcard-dashcard-id-execute",
"summary" : "POST /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/execute",
"description" : "Execute the associated Action in the context of a `Dashboard` and `DashboardCard` that includes it.\n\n `parameters` should be the mapped dashboard parameters with values.",
"parameters" : [ {
@@ -37699,6 +38768,7 @@
},
"/api/public/dashboard/{uuid}/params/{param-key}/remapping" : {
"get" : {
+ "operationId" : "get-api-public-dashboard-uuid-params-param-key-remapping",
"summary" : "GET /api/public/dashboard/{uuid}/params/{param-key}/remapping",
"description" : "Fetch the remapped value for the given `value` of parameter with ID `:param-key` of dashboard with UUID `uuid`.",
"parameters" : [ {
@@ -37740,6 +38810,7 @@
},
"/api/public/dashboard/{uuid}/params/{param-key}/search/{query}" : {
"get" : {
+ "operationId" : "get-api-public-dashboard-uuid-params-param-key-search-query",
"summary" : "GET /api/public/dashboard/{uuid}/params/{param-key}/search/{query}",
"description" : "Fetch filter values for dashboard parameter `param-key`, containing specified `query`.",
"parameters" : [ {
@@ -37784,6 +38855,7 @@
},
"/api/public/dashboard/{uuid}/params/{param-key}/values" : {
"get" : {
+ "operationId" : "get-api-public-dashboard-uuid-params-param-key-values",
"summary" : "GET /api/public/dashboard/{uuid}/params/{param-key}/values",
"description" : "Fetch filter values for dashboard parameter `param-key`.",
"parameters" : [ {
@@ -37820,6 +38892,7 @@
},
"/api/public/document/{uuid}" : {
"get" : {
+ "operationId" : "get-api-public-document-uuid",
"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" : [ {
@@ -37848,6 +38921,7 @@
},
"/api/public/document/{uuid}/card/{card-id}" : {
"get" : {
+ "operationId" : "get-api-public-document-uuid-card-card-id",
"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" : [ {
@@ -37897,6 +38971,7 @@
},
"/api/public/document/{uuid}/card/{card-id}/{export-format}" : {
"post" : {
+ "operationId" : "post-api-public-document-uuid-card-card-id-export-format",
"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" : [ {
@@ -37978,6 +39053,7 @@
},
"/api/public/oembed" : {
"get" : {
+ "operationId" : "get-api-public-oembed",
"summary" : "GET /api/public/oembed",
"description" : "oEmbed endpoint used to retrieve embed code and metadata for a (public) Metabase URL.",
"parameters" : [ {
@@ -38036,6 +39112,7 @@
},
"/api/public/pivot/card/{uuid}/query" : {
"get" : {
+ "operationId" : "get-api-public-pivot-card-uuid-query",
"summary" : "GET /api/public/pivot/card/{uuid}/query",
"description" : "Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth\n credentials. Public sharing must be enabled.",
"parameters" : [ {
@@ -38076,6 +39153,7 @@
},
"/api/public/pivot/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
+ "operationId" : "get-api-public-pivot-dashboard-uuid-dashcard-dashcard-id-card-card-id",
"summary" : "GET /api/public/pivot/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}",
"description" : "Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Public\n sharing must be enabled.",
"parameters" : [ {
@@ -38134,6 +39212,7 @@
},
"/api/public/tiles/card/{uuid}/{zoom}/{x}/{y}" : {
"get" : {
+ "operationId" : "get-api-public-tiles-card-uuid-zoom-x-y",
"summary" : "GET /api/public/tiles/card/{uuid}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a publicly-accessible Card using the map visualization. Does not require auth\n credentials. Public sharing must be enabled.",
"parameters" : [ {
@@ -38208,6 +39287,7 @@
},
"/api/public/tiles/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
+ "operationId" : "get-api-public-tiles-dashboard-uuid-dashcard-dashcard-id-card-card-id-zoom-x-y",
"summary" : "GET /api/public/tiles/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a Card using the map visualization in a publicly-accessible Dashboard. Does not\n require auth credentials. Public sharing must be enabled.",
"parameters" : [ {
@@ -38298,9 +39378,10 @@
"tags" : [ "/api/public" ]
}
},
- "/api/pulse/" : {
+ "/api/pulse" : {
"get" : {
- "summary" : "GET /api/pulse/",
+ "operationId" : "get-api-pulse",
+ "summary" : "GET /api/pulse",
"description" : "Fetch all dashboard subscriptions. By default, returns only subscriptions for which the current user has write\n permissions. For admins, this is all subscriptions; for non-admins, it is only subscriptions that they created.\n\n If `dashboard_id` is specified, restricts results to subscriptions for that dashboard.\n\n If `created_or_receive` is `true`, it specifically returns all subscriptions for which the current user\n created *or* is a known recipient of. Note that this is a superset of the default items returned for non-admins,\n and a subset of the default items returned for admins. This is used to power the /account/notifications page.\n This may include subscriptions which the current user does not have collection permissions for, in which case\n some sensitive metadata (the list of cards and recipients) is stripped out.",
"parameters" : [ {
"in" : "query",
@@ -38354,7 +39435,8 @@
"tags" : [ "/api/pulse" ]
},
"post" : {
- "summary" : "POST /api/pulse/",
+ "operationId" : "post-api-pulse",
+ "summary" : "POST /api/pulse",
"description" : "Create a new `Pulse`.",
"parameters" : [ ],
"responses" : {
@@ -38437,6 +39519,7 @@
},
"/api/pulse/form_input" : {
"get" : {
+ "operationId" : "get-api-pulse-form_input",
"summary" : "GET /api/pulse/form_input",
"description" : "Provides relevant configuration information and user choices for creating/updating Pulses.",
"parameters" : [ ],
@@ -38456,6 +39539,7 @@
},
"/api/pulse/preview_card/{id}" : {
"get" : {
+ "operationId" : "get-api-pulse-preview_card-id",
"summary" : "GET /api/pulse/preview_card/{id}",
"description" : "Get HTML rendering of a Card with `id`.",
"parameters" : [ {
@@ -38484,6 +39568,7 @@
},
"/api/pulse/preview_card_info/{id}" : {
"get" : {
+ "operationId" : "get-api-pulse-preview_card_info-id",
"summary" : "GET /api/pulse/preview_card_info/{id}",
"description" : "Get JSON object containing HTML rendering of a Card with `id` and other information.",
"parameters" : [ {
@@ -38512,6 +39597,7 @@
},
"/api/pulse/preview_card_png/{id}" : {
"get" : {
+ "operationId" : "get-api-pulse-preview_card_png-id",
"summary" : "GET /api/pulse/preview_card_png/{id}",
"description" : "Get PNG rendering of a Card with `id`. Optionally specify `width` as a query parameter.",
"parameters" : [ {
@@ -38553,6 +39639,7 @@
},
"/api/pulse/preview_dashboard/{id}" : {
"get" : {
+ "operationId" : "get-api-pulse-preview_dashboard-id",
"summary" : "GET /api/pulse/preview_dashboard/{id}",
"description" : "Get HTML rendering of a Dashboard with `id`.\n\n This endpoint relies on a custom middleware defined in `metabase.channel.render.core/style-tag-nonce-middleware` to\n allow the style tag to render properly, given our Content Security Policy setup. This middleware is attached to these\n routes at the bottom of this namespace using `metabase.api.common/define-routes`.",
"parameters" : [ {
@@ -38581,6 +39668,7 @@
},
"/api/pulse/test" : {
"post" : {
+ "operationId" : "post-api-pulse-test",
"summary" : "POST /api/pulse/test",
"description" : "Test send an unsaved pulse.",
"parameters" : [ ],
@@ -38659,9 +39747,10 @@
"tags" : [ "/api/pulse" ]
}
},
- "/api/pulse/unsubscribe/" : {
+ "/api/pulse/unsubscribe" : {
"post" : {
- "summary" : "POST /api/pulse/unsubscribe/",
+ "operationId" : "post-api-pulse-unsubscribe",
+ "summary" : "POST /api/pulse/unsubscribe",
"description" : "Allow non-users to unsubscribe from pulses/subscriptions, with the hash given through email.",
"parameters" : [ ],
"responses" : {
@@ -38703,6 +39792,7 @@
},
"/api/pulse/unsubscribe/undo" : {
"post" : {
+ "operationId" : "post-api-pulse-unsubscribe-undo",
"summary" : "POST /api/pulse/unsubscribe/undo",
"description" : "Allow non-users to undo an unsubscribe from pulses/subscriptions, with the hash given through email.",
"parameters" : [ ],
@@ -38745,6 +39835,7 @@
},
"/api/pulse/{id}" : {
"get" : {
+ "operationId" : "get-api-pulse-id",
"summary" : "GET /api/pulse/{id}",
"description" : "Fetch `Pulse` with ID. If the user is a recipient of the Pulse but does not have read permissions for its collection,\n we still return it but with some sensitive metadata removed.",
"parameters" : [ {
@@ -38771,6 +39862,7 @@
"tags" : [ "/api/pulse" ]
},
"put" : {
+ "operationId" : "put-api-pulse-id",
"summary" : "PUT /api/pulse/{id}",
"description" : "Update a Pulse with `id`.",
"parameters" : [ {
@@ -38866,6 +39958,7 @@
},
"/api/pulse/{id}/subscription" : {
"delete" : {
+ "operationId" : "delete-api-pulse-id-subscription",
"summary" : "DELETE /api/pulse/{id}/subscription",
"description" : "For users to unsubscribe themselves from a pulse subscription.",
"parameters" : [ {
@@ -38892,9 +39985,10 @@
"tags" : [ "/api/pulse" ]
}
},
- "/api/revision/" : {
+ "/api/revision" : {
"get" : {
- "summary" : "GET /api/revision/",
+ "operationId" : "get-api-revision",
+ "summary" : "GET /api/revision",
"description" : "Get revisions of an object.",
"parameters" : [ {
"in" : "query",
@@ -38930,6 +40024,7 @@
},
"/api/revision/revert" : {
"post" : {
+ "operationId" : "post-api-revision-revert",
"summary" : "POST /api/revision/revert",
"description" : "Revert an object to a prior revision.",
"parameters" : [ ],
@@ -38975,6 +40070,7 @@
},
"/api/revision/{entity}/{id}" : {
"get" : {
+ "operationId" : "get-api-revision-entity-id",
"summary" : "GET /api/revision/{entity}/{id}",
"description" : "Fetch `Revisions` for an object with ID.",
"parameters" : [ {
@@ -39009,9 +40105,10 @@
"tags" : [ "/api/revision" ]
}
},
- "/api/search/" : {
+ "/api/search" : {
"get" : {
- "summary" : "GET /api/search/",
+ "operationId" : "get-api-search",
+ "summary" : "GET /api/search",
"description" : "Search for items in Metabase.\n For the list of supported models, check [[metabase.search.config/all-models]].\n\n Filters:\n - `archived`: set to true to search archived items only, default is false\n - `table_db_id`: search for tables, cards, and models of a certain DB\n - `models`: only search for items of specific models. If not provided, search for all models\n - `filters_items_in_personal_collection`: only search for items in personal collections\n - `created_at`: search for items created at a specific timestamp\n - `created_by`: search for items created by a specific user\n - `last_edited_at`: search for items last edited at a specific timestamp\n - `last_edited_by`: search for items last edited by a specific user\n - `search_native_query`: set to true to search the content of native queries\n - `verified`: set to true to search for verified items only (requires Content Management or Official Collections premium feature)\n - `ids`: search for items with those ids, works iff single value passed to `models`\n - `display_type`: search for cards/models with specific display types\n - `non_temporal_dim_ids`: search for cards/metrics/datasets with this exact set of non temporal dimension field IDs (requires appdb engine)\n - `has_temporal_dim`: set to true for cards/metrics/datasets with 1 or more temporal dimensions (requires appdb engine)\n\n Note that not all item types support all filters, and the results will include only models that support the provided\n filters. For example:\n\n - The `created-by` filter supports dashboards, models, actions, and cards.\n - The `verified` filter supports models and cards.\n\n A search query that has both filters applied will only return models and cards.",
"parameters" : [ {
"in" : "query",
@@ -39307,6 +40404,7 @@
},
"/api/search/force-reindex" : {
"post" : {
+ "operationId" : "post-api-search-force-reindex",
"summary" : "POST /api/search/force-reindex",
"description" : "This will trigger an immediate reindexing, if we are using search index.",
"parameters" : [ ],
@@ -39326,6 +40424,7 @@
},
"/api/search/re-init" : {
"post" : {
+ "operationId" : "post-api-search-re-init",
"summary" : "POST /api/search/re-init",
"description" : "This will blow away any search indexes, re-create, and re-populate them.",
"parameters" : [ ],
@@ -39345,6 +40444,7 @@
},
"/api/search/weights" : {
"get" : {
+ "operationId" : "get-api-search-weights",
"summary" : "GET /api/search/weights",
"description" : "Return the current weights being used to rank the search results",
"parameters" : [ {
@@ -39370,6 +40470,7 @@
"tags" : [ "/api/search" ]
},
"put" : {
+ "operationId" : "put-api-search-weights",
"summary" : "PUT /api/search/weights",
"description" : "Update the current weights being used to rank the search results",
"parameters" : [ {
@@ -39400,9 +40501,10 @@
"tags" : [ "/api/search" ]
}
},
- "/api/segment/" : {
+ "/api/segment" : {
"post" : {
- "summary" : "POST /api/segment/",
+ "operationId" : "post-api-segment",
+ "summary" : "POST /api/segment",
"description" : "Create a new `Segment`.",
"parameters" : [ ],
"responses" : {
@@ -39452,7 +40554,8 @@
"tags" : [ "/api/segment" ]
},
"get" : {
- "summary" : "GET /api/segment/",
+ "operationId" : "get-api-segment",
+ "summary" : "GET /api/segment",
"description" : "Fetch *all* `Segments`.",
"parameters" : [ ],
"responses" : {
@@ -39471,6 +40574,7 @@
},
"/api/segment/{id}" : {
"get" : {
+ "operationId" : "get-api-segment-id",
"summary" : "GET /api/segment/{id}",
"description" : "Fetch `Segment` with ID.",
"parameters" : [ {
@@ -39497,6 +40601,7 @@
"tags" : [ "/api/segment" ]
},
"put" : {
+ "operationId" : "put-api-segment-id",
"summary" : "PUT /api/segment/{id}",
"description" : "Update a `Segment` with ID.",
"parameters" : [ {
@@ -39590,6 +40695,7 @@
"tags" : [ "/api/segment" ]
},
"delete" : {
+ "operationId" : "delete-api-segment-id",
"summary" : "DELETE /api/segment/{id}",
"description" : "Archive a Segment. (DEPRECATED -- Just pass updated value of `:archived` to the `PUT` endpoint instead.)",
"parameters" : [ {
@@ -39626,6 +40732,7 @@
},
"/api/segment/{id}/related" : {
"get" : {
+ "operationId" : "get-api-segment-id-related",
"summary" : "GET /api/segment/{id}/related",
"description" : "Return related entities.",
"parameters" : [ {
@@ -39652,9 +40759,10 @@
"tags" : [ "/api/segment" ]
}
},
- "/api/session/" : {
+ "/api/session" : {
"post" : {
- "summary" : "POST /api/session/",
+ "operationId" : "post-api-session",
+ "summary" : "POST /api/session",
"description" : "Login.",
"parameters" : [ ],
"responses" : {
@@ -39691,7 +40799,8 @@
"tags" : [ "/api/session" ]
},
"delete" : {
- "summary" : "DELETE /api/session/",
+ "operationId" : "delete-api-session",
+ "summary" : "DELETE /api/session",
"description" : "Logout.",
"parameters" : [ ],
"responses" : {
@@ -39710,6 +40819,7 @@
},
"/api/session/forgot_password" : {
"post" : {
+ "operationId" : "post-api-session-forgot_password",
"summary" : "POST /api/session/forgot_password",
"description" : "Send a reset email when user has forgotten their password.",
"parameters" : [ ],
@@ -39745,6 +40855,7 @@
},
"/api/session/google_auth" : {
"post" : {
+ "operationId" : "post-api-session-google_auth",
"summary" : "POST /api/session/google_auth",
"description" : "Login with Google Auth.",
"parameters" : [ ],
@@ -39780,6 +40891,7 @@
},
"/api/session/password-check" : {
"post" : {
+ "operationId" : "post-api-session-password-check",
"summary" : "POST /api/session/password-check",
"description" : "Endpoint that checks if the supplied password meets the currently configured password complexity rules.",
"parameters" : [ ],
@@ -39815,6 +40927,7 @@
},
"/api/session/password_reset_token_valid" : {
"get" : {
+ "operationId" : "get-api-session-password_reset_token_valid",
"summary" : "GET /api/session/password_reset_token_valid",
"description" : "Check if a password reset token is valid and isn't expired.",
"parameters" : [ {
@@ -39842,6 +40955,7 @@
},
"/api/session/properties" : {
"get" : {
+ "operationId" : "get-api-session-properties",
"summary" : "GET /api/session/properties",
"description" : "Get all properties and their values. These are the specific `Settings` that are readable by the current user, or are\n public if no user is logged in.",
"parameters" : [ ],
@@ -39861,6 +40975,7 @@
},
"/api/session/reset_password" : {
"post" : {
+ "operationId" : "post-api-session-reset_password",
"summary" : "POST /api/session/reset_password",
"description" : "Reset password with a reset token.",
"parameters" : [ ],
@@ -39898,9 +41013,10 @@
"tags" : [ "/api/session" ]
}
},
- "/api/setting/" : {
+ "/api/setting" : {
"get" : {
- "summary" : "GET /api/setting/",
+ "operationId" : "get-api-setting",
+ "summary" : "GET /api/setting",
"description" : "Get all `Settings` and their values. You must be a superuser or have `setting` permission to do this.\n For non-superusers, a list of visible settings and values can be retrieved using the /api/session/properties endpoint.",
"parameters" : [ ],
"responses" : {
@@ -39917,7 +41033,8 @@
"tags" : [ "/api/setting" ]
},
"put" : {
- "summary" : "PUT /api/setting/",
+ "operationId" : "put-api-setting",
+ "summary" : "PUT /api/setting",
"description" : "Update multiple `Settings` values. If called by a non-superuser, only user-local settings can be updated.",
"parameters" : [ ],
"responses" : {
@@ -39946,6 +41063,7 @@
},
"/api/setting/{key}" : {
"get" : {
+ "operationId" : "get-api-setting-key",
"summary" : "GET /api/setting/{key}",
"description" : "Fetch a single `Setting`.",
"parameters" : [ {
@@ -39970,6 +41088,7 @@
"tags" : [ "/api/setting" ]
},
"put" : {
+ "operationId" : "put-api-setting-key",
"summary" : "PUT /api/setting/{key}",
"description" : "Create/update a `Setting`. If called by a non-admin, only user-local settings can be updated.\n This endpoint can also be used to delete Settings by passing `nil` for `:value`.",
"parameters" : [ {
@@ -40007,9 +41126,10 @@
"tags" : [ "/api/setting" ]
}
},
- "/api/setup/" : {
+ "/api/setup" : {
"post" : {
- "summary" : "POST /api/setup/",
+ "operationId" : "post-api-setup",
+ "summary" : "POST /api/setup",
"description" : "Special endpoint for creating the first user during setup. This endpoint both creates the user AND logs them in and\n returns a session ID. This endpoint can also be used to set specific settings from the setup flow.",
"parameters" : [ ],
"responses" : {
@@ -40094,6 +41214,7 @@
},
"/api/slack/bug-report" : {
"post" : {
+ "operationId" : "post-api-slack-bug-report",
"summary" : "POST /api/slack/bug-report",
"description" : "Send diagnostic information to the configured Slack channels.",
"parameters" : [ ],
@@ -40128,6 +41249,7 @@
},
"/api/slack/manifest" : {
"get" : {
+ "operationId" : "get-api-slack-manifest",
"summary" : "GET /api/slack/manifest",
"description" : "Returns the YAML manifest file that should be used to bootstrap new Slack apps",
"parameters" : [ ],
@@ -40147,6 +41269,7 @@
},
"/api/slack/settings" : {
"put" : {
+ "operationId" : "put-api-slack-settings",
"summary" : "PUT /api/slack/settings",
"description" : "Update Slack related settings. You must be a superuser to do this. Also updates the slack-cache.\n There are 3 cases where we alter the slack channel/user cache:\n 1. falsy token -> clear\n 2. invalid token -> clear\n 3. truthy, valid token -> refresh ",
"parameters" : [ ],
@@ -40190,9 +41313,10 @@
"tags" : [ "/api/slack" ]
}
},
- "/api/table/" : {
+ "/api/table" : {
"get" : {
- "summary" : "GET /api/table/",
+ "operationId" : "get-api-table",
+ "summary" : "GET /api/table",
"description" : "Get all `Tables`.\n\n Optional filters:\n - `can-query=true` - filter to only tables the user can execute queries against\n - `can-write=true` - filter to only tables the user can edit metadata for",
"parameters" : [ {
"in" : "query",
@@ -40299,7 +41423,8 @@
"tags" : [ "/api/table" ]
},
"put" : {
- "summary" : "PUT /api/table/",
+ "operationId" : "put-api-table",
+ "summary" : "PUT /api/table",
"description" : "Update all `Table` in `ids`.\n\n Deprecated, should use PUT /table/edit from now on.",
"parameters" : [ ],
"responses" : {
@@ -40424,6 +41549,7 @@
},
"/api/table/card__:id/fks" : {
"get" : {
+ "operationId" : "get-api-table-card__:id-fks",
"summary" : "GET /api/table/card__:id/fks",
"description" : "Return FK info for the 'virtual' table for a Card. This is always empty, so this endpoint\n serves mainly as a placeholder to avoid having to change anything on the frontend.",
"parameters" : [ {
@@ -40452,6 +41578,7 @@
},
"/api/table/card__:id/query_metadata" : {
"get" : {
+ "operationId" : "get-api-table-card__:id-query_metadata",
"summary" : "GET /api/table/card__:id/query_metadata",
"description" : "Return metadata for the 'virtual' table for a Card.",
"parameters" : [ {
@@ -40480,6 +41607,7 @@
},
"/api/table/{id}" : {
"get" : {
+ "operationId" : "get-api-table-id",
"summary" : "GET /api/table/{id}",
"description" : "Get `Table` with ID.",
"parameters" : [ {
@@ -40517,6 +41645,7 @@
"tags" : [ "/api/table" ]
},
"put" : {
+ "operationId" : "put-api-table-id",
"summary" : "PUT /api/table/{id}",
"description" : "Update `Table` with ID.",
"parameters" : [ {
@@ -40650,6 +41779,7 @@
},
"/api/table/{id}/append-csv" : {
"post" : {
+ "operationId" : "post-api-table-id-append-csv",
"summary" : "POST /api/table/{id}/append-csv",
"description" : "Inserts the rows of an uploaded CSV file into the table identified by `:id`. The table must have been created by\n uploading a CSV file.",
"parameters" : [ {
@@ -40700,6 +41830,7 @@
},
"/api/table/{id}/discard_values" : {
"post" : {
+ "operationId" : "post-api-table-id-discard_values",
"summary" : "POST /api/table/{id}/discard_values",
"description" : "Discard the FieldValues belonging to the Fields in this Table. Only applies to fields that have FieldValues. If\n this Table's Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.",
"parameters" : [ {
@@ -40728,6 +41859,7 @@
},
"/api/table/{id}/fields/order" : {
"put" : {
+ "operationId" : "put-api-table-id-fields-order",
"summary" : "PUT /api/table/{id}/fields/order",
"description" : "Reorder fields",
"parameters" : [ {
@@ -40783,6 +41915,7 @@
},
"/api/table/{id}/fks" : {
"get" : {
+ "operationId" : "get-api-table-id-fks",
"summary" : "GET /api/table/{id}/fks",
"description" : "Get all foreign keys whose destination is a `Field` that belongs to this `Table`.",
"parameters" : [ {
@@ -40811,6 +41944,7 @@
},
"/api/table/{id}/query_metadata" : {
"get" : {
+ "operationId" : "get-api-table-id-query_metadata",
"summary" : "GET /api/table/{id}/query_metadata",
"description" : "Get metadata about a `Table` useful for running queries.\n Returns DB, fields, field FKs, and field values.\n\n Passing `include_hidden_fields=true` will include any hidden `Fields` in the response. Defaults to `false`\n Passing `include_sensitive_fields=true` will include any sensitive `Fields` in the response. Defaults to `false`.\n\n Passing `include_editable_data_model=true` will check that the current user has write permissions for the table's\n data model, while `false` checks that they have data access perms for the table. Defaults to `false`.\n\n These options are provided for use in the Admin Edit Metadata page.",
"parameters" : [ {
@@ -40875,6 +42009,7 @@
},
"/api/table/{id}/related" : {
"get" : {
+ "operationId" : "get-api-table-id-related",
"summary" : "GET /api/table/{id}/related",
"description" : "Return related entities.",
"parameters" : [ {
@@ -40903,6 +42038,7 @@
},
"/api/table/{id}/replace-csv" : {
"post" : {
+ "operationId" : "post-api-table-id-replace-csv",
"summary" : "POST /api/table/{id}/replace-csv",
"description" : "Replaces the contents of the table identified by `:id` with the rows of an uploaded CSV file. The table must have\n been created by uploading a CSV file.",
"parameters" : [ {
@@ -40953,6 +42089,7 @@
},
"/api/table/{id}/rescan_values" : {
"post" : {
+ "operationId" : "post-api-table-id-rescan_values",
"summary" : "POST /api/table/{id}/rescan_values",
"description" : "Manually trigger an update for the FieldValues for the Fields belonging to this Table. Only applies to Fields that\n are eligible for FieldValues.",
"parameters" : [ {
@@ -40981,6 +42118,7 @@
},
"/api/table/{id}/sync_schema" : {
"post" : {
+ "operationId" : "post-api-table-id-sync_schema",
"summary" : "POST /api/table/{id}/sync_schema",
"description" : "Trigger a manual update of the schema metadata for this `Table`.",
"parameters" : [ {
@@ -41009,6 +42147,7 @@
},
"/api/table/{table-id}/data" : {
"get" : {
+ "operationId" : "get-api-table-table-id-data",
"summary" : "GET /api/table/{table-id}/data",
"description" : "Get the data for the given table",
"parameters" : [ {
@@ -41035,9 +42174,10 @@
"tags" : [ "/api/table" ]
}
},
- "/api/task/" : {
+ "/api/task" : {
"get" : {
- "summary" : "GET /api/task/",
+ "operationId" : "get-api-task",
+ "summary" : "GET /api/task",
"description" : "Fetch a list of recent tasks stored as Task History",
"parameters" : [ ],
"responses" : {
@@ -41056,6 +42196,7 @@
},
"/api/task/info" : {
"get" : {
+ "operationId" : "get-api-task-info",
"summary" : "GET /api/task/info",
"description" : "Return raw data about all scheduled tasks (i.e., Quartz Jobs and Triggers).",
"parameters" : [ ],
@@ -41075,6 +42216,7 @@
},
"/api/task/runs" : {
"get" : {
+ "operationId" : "get-api-task-runs",
"summary" : "GET /api/task/runs",
"description" : "List task runs with optional filters. Returns runs with hydrated entity names and task counts.",
"parameters" : [ ],
@@ -41101,6 +42243,7 @@
},
"/api/task/runs/entities" : {
"get" : {
+ "operationId" : "get-api-task-runs-entities",
"summary" : "GET /api/task/runs/entities",
"description" : "Get distinct entities that have task runs for a given run type. Used for populating entity filter picker.",
"parameters" : [ {
@@ -41146,6 +42289,7 @@
},
"/api/task/runs/{id}" : {
"get" : {
+ "operationId" : "get-api-task-runs-id",
"summary" : "GET /api/task/runs/{id}",
"description" : "Get a single task run with all its child tasks.",
"parameters" : [ {
@@ -41181,6 +42325,7 @@
},
"/api/task/unique-tasks" : {
"get" : {
+ "operationId" : "get-api-task-unique-tasks",
"summary" : "GET /api/task/unique-tasks",
"description" : "Returns possibly empty vector of unique task names in alphabetical order. It is expected that number of unique\n tasks is small, hence no need for pagination. If that changes this endpoint and function that powers it should\n reflect that.",
"parameters" : [ ],
@@ -41200,6 +42345,7 @@
},
"/api/task/{id}" : {
"get" : {
+ "operationId" : "get-api-task-id",
"summary" : "GET /api/task/{id}",
"description" : "Get `TaskHistory` entry with ID.",
"parameters" : [ {
@@ -41228,6 +42374,7 @@
},
"/api/tiles/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
+ "operationId" : "get-api-tiles-card-id-zoom-x-y",
"summary" : "GET /api/tiles/{card-id}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a saved Card.",
"parameters" : [ {
@@ -41299,6 +42446,7 @@
},
"/api/tiles/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
+ "operationId" : "get-api-tiles-dashboard-id-dashcard-dashcard-id-card-card-id-zoom-x-y",
"summary" : "GET /api/tiles/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a dashcard.",
"parameters" : [ {
@@ -41384,6 +42532,7 @@
},
"/api/tiles/{zoom}/{x}/{y}" : {
"get" : {
+ "operationId" : "get-api-tiles-zoom-x-y",
"summary" : "GET /api/tiles/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for an ad-hoc query.",
"parameters" : [ {
@@ -41446,9 +42595,134 @@
"tags" : [ "/api/tiles" ]
}
},
- "/api/timeline-event/" : {
+ "/api/timeline" : {
"post" : {
- "summary" : "POST /api/timeline-event/",
+ "operationId" : "post-api-timeline",
+ "summary" : "POST /api/timeline",
+ "description" : "Create a new [[Timeline]].",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.timeline.api.timeline.Timeline"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "default" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "icon" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "star", "cake", "mail", "warning", "bell", "cloud" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "name" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/timeline" ]
+ },
+ "get" : {
+ "operationId" : "get-api-timeline",
+ "summary" : "GET /api/timeline",
+ "description" : "Fetch a list of `Timeline`s. Can include `archived=true` to return archived timelines.",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "include",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.timeline.api.timeline.include"
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.timeline.api.timeline.Timeline"
+ }
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/timeline" ]
+ }
+ },
+ "/api/timeline-event" : {
+ "post" : {
+ "operationId" : "post-api-timeline-event",
+ "summary" : "POST /api/timeline-event",
"description" : "Create a new [[TimelineEvent]].",
"parameters" : [ ],
"responses" : {
@@ -41541,6 +42815,7 @@
},
"/api/timeline-event/{id}" : {
"get" : {
+ "operationId" : "get-api-timeline-event-id",
"summary" : "GET /api/timeline-event/{id}",
"description" : "Fetch the [[TimelineEvent]] with `id`.",
"parameters" : [ {
@@ -41567,6 +42842,7 @@
"tags" : [ "/api/timeline-event" ]
},
"put" : {
+ "operationId" : "put-api-timeline-event-id",
"summary" : "PUT /api/timeline-event/{id}",
"description" : "Update a [[TimelineEvent]].",
"parameters" : [ {
@@ -41665,6 +42941,7 @@
"tags" : [ "/api/timeline-event" ]
},
"delete" : {
+ "operationId" : "delete-api-timeline-event-id",
"summary" : "DELETE /api/timeline-event/{id}",
"description" : "Delete a [[TimelineEvent]].",
"parameters" : [ {
@@ -41691,11 +42968,147 @@
"tags" : [ "/api/timeline-event" ]
}
},
- "/api/timeline/" : {
- "post" : {
- "summary" : "POST /api/timeline/",
- "description" : "Create a new [[Timeline]].",
- "parameters" : [ ],
+ "/api/timeline/collection/root" : {
+ "get" : {
+ "operationId" : "get-api-timeline-collection-root",
+ "summary" : "GET /api/timeline/collection/root",
+ "description" : "Fetch the root Collection's timelines.",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "include",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "const" : "events"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/timeline" ]
+ }
+ },
+ "/api/timeline/collection/{id}" : {
+ "get" : {
+ "operationId" : "get-api-timeline-collection-id",
+ "summary" : "GET /api/timeline/collection/{id}",
+ "description" : "Fetch a specific Collection's timelines.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "include",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "const" : "events"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/timeline" ]
+ }
+ },
+ "/api/timeline/{id}" : {
+ "get" : {
+ "operationId" : "get-api-timeline-id",
+ "summary" : "GET /api/timeline/{id}",
+ "description" : "Fetch the `Timeline` with `id`. Include `include=events` to unarchived events included on the timeline. Add\n `archived=true` to return all events on the timeline, both archived and unarchived.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "include",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.timeline.api.timeline.include"
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
+ "required" : true,
+ "schema" : {
+ "default" : "false",
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "start",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ },
+ "description" : "value must be a valid date string"
+ }, {
+ "in" : "query",
+ "name" : "end",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ },
+ "description" : "value must be a valid date string"
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response",
@@ -41706,287 +43119,33 @@
}
}
}
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "default" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "icon" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "star", "cake", "mail", "warning", "bell", "cloud" ]
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "name" ]
- }
- }
- }
- },
- "tags" : [ "/api/timeline" ]
- },
- "get" : {
- "summary" : "GET /api/timeline/",
- "description" : "Fetch a list of `Timeline`s. Can include `archived=true` to return archived timelines.",
- "parameters" : [ {
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.timeline.api.timeline.include"
- }
- }, {
- "in" : "query",
- "name" : "archived",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.timeline.api.timeline.Timeline"
- }
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/timeline" ]
- }
- },
- "/api/timeline/collection/root" : {
- "get" : {
- "summary" : "GET /api/timeline/collection/root",
- "description" : "Fetch the root Collection's timelines.",
- "parameters" : [ {
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "const" : "events"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "archived",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/timeline" ]
- }
- },
- "/api/timeline/collection/{id}" : {
- "get" : {
- "summary" : "GET /api/timeline/collection/{id}",
- "description" : "Fetch a specific Collection's timelines.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "const" : "events"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "archived",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/timeline" ]
- }
- },
- "/api/timeline/{id}" : {
- "get" : {
- "summary" : "GET /api/timeline/{id}",
- "description" : "Fetch the `Timeline` with `id`. Include `include=events` to unarchived events included on the timeline. Add\n `archived=true` to return all events on the timeline, both archived and unarchived.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.timeline.api.timeline.include"
- }
- }, {
- "in" : "query",
- "name" : "archived",
- "required" : true,
- "schema" : {
- "default" : "false",
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "start",
- "required" : false,
- "schema" : {
- "type" : "string"
- },
- "description" : "value must be a valid date string"
- }, {
- "in" : "query",
- "name" : "end",
- "required" : false,
- "schema" : {
- "type" : "string"
- },
- "description" : "value must be a valid date string"
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.timeline.api.timeline.Timeline"
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/timeline" ]
- },
- "put" : {
- "summary" : "PUT /api/timeline/{id}",
- "description" : "Update the [[Timeline]] with `id`. Returns the timeline without events. Archiving a timeline will archive all of the\n events in that timeline.",
- "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"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/timeline" ]
+ },
+ "put" : {
+ "operationId" : "put-api-timeline-id",
+ "summary" : "PUT /api/timeline/{id}",
+ "description" : "Update the [[Timeline]] with `id`. Returns the timeline without events. Archiving a timeline will archive all of the\n events in that timeline.",
+ "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"
},
"4XX" : {
"description" : "Client error response"
@@ -42055,6 +43214,7 @@
"tags" : [ "/api/timeline" ]
},
"delete" : {
+ "operationId" : "delete-api-timeline-id",
"summary" : "DELETE /api/timeline/{id}",
"description" : "Delete a [[Timeline]]. Will cascade delete its events as well.",
"parameters" : [ {
@@ -42081,191 +43241,11 @@
"tags" : [ "/api/timeline" ]
}
},
- "/api/transform-job/" : {
- "post" : {
- "summary" : "POST /api/transform-job/",
- "description" : "Create a new transform job.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "built_in_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "entity_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "last_run" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "is_active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "run_method" : {
- "type" : "string"
- },
- "updated_at" : { },
- "status" : {
- "type" : "string",
- "enum" : [ "started", "succeeded", "failed", "timeout" ]
- },
- "job_id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "end_time" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "created_at" : { },
- "start_time" : { }
- },
- "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "ui_display_type" : {
- "type" : "string",
- "enum" : [ "cron/raw", "cron/builder" ]
- },
- "next_run" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "start_time" : { }
- },
- "required" : [ "start_time" ],
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "anyOf" : [ { }, { } ]
- } ]
- },
- "schedule" : {
- "type" : "string"
- },
- "updated_at" : { },
- "tag_ids" : {
- "type" : "array",
- "items" : {
- "type" : "integer",
- "minimum" : 1
- }
- },
- "created_at" : { },
- "description" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "anyOf" : [ { }, { } ]
- } ]
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "name", "description", "schedule", "ui_display_type", "entity_id", "created_at", "updated_at" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "schedule" : {
- "type" : "string",
- "minLength" : 1
- },
- "tag_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "ui_display_type" : {
- "default" : "cron/raw",
- "type" : "string",
- "enum" : [ "cron/raw", "cron/builder" ]
- }
- },
- "required" : [ "name", "schedule", "ui_display_type" ]
- }
- }
- }
- },
- "tags" : [ "/api/transform-job" ]
- },
+ "/api/transform" : {
"get" : {
- "summary" : "GET /api/transform-job/",
- "description" : "Get all transform jobs.",
+ "operationId" : "get-api-transform",
+ "summary" : "GET /api/transform",
+ "description" : "Get a list of transforms.",
"parameters" : [ {
"in" : "query",
"name" : "last-run-start-time",
@@ -42278,18 +43258,6 @@
"type" : "null"
} ]
}
- }, {
- "in" : "query",
- "name" : "next-run-start-time",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- }
}, {
"in" : "query",
"name" : "last-run-statuses",
@@ -42321,6 +43289,19 @@
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "database-id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -42332,13 +43313,56 @@
"items" : {
"type" : "object",
"properties" : {
- "built_in_type" : {
+ "table" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "email" ],
+ "additionalProperties" : false
}, {
"type" : "null"
} ]
},
+ "source_type" : {
+ "type" : "string"
+ },
"entity_id" : {
"oneOf" : [ {
"type" : "string"
@@ -42357,6 +43381,14 @@
"type" : "null"
} ]
},
+ "user_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
"is_active" : {
"oneOf" : [ {
"type" : "boolean"
@@ -42364,6 +43396,10 @@
"type" : "null"
} ]
},
+ "transform_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
"id" : {
"type" : "integer",
"minimum" : 1
@@ -42371,41 +43407,41 @@
"run_method" : {
"type" : "string"
},
- "updated_at" : { },
"status" : {
"type" : "string",
- "enum" : [ "started", "succeeded", "failed", "timeout" ]
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ]
},
- "job_id" : {
- "type" : "integer",
- "minimum" : 1
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"end_time" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
- "created_at" : { },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"start_time" : { }
},
- "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
+ "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
- "ui_display_type" : {
- "type" : "string",
- "enum" : [ "cron/raw", "cron/builder" ]
- },
- "next_run" : {
+ "source_database_id" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : {
- "start_time" : { }
- },
- "required" : [ "start_time" ],
- "additionalProperties" : false
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
@@ -42414,17 +43450,98 @@
"type" : "integer",
"minimum" : 1
},
- "name" : {
- "anyOf" : [ {
+ "owner_email" : {
+ "oneOf" : [ {
"type" : "string"
}, {
- "anyOf" : [ { }, { } ]
+ "type" : "null"
} ]
},
- "schedule" : {
+ "target_db_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator" : {
+ "type" : "object",
+ "properties" : {
+ "is_qbnewb" : {
+ "type" : "boolean"
+ },
+ "last_login" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "is_data_analyst" : {
+ "type" : "boolean"
+ },
+ "is_superuser" : {
+ "type" : "boolean"
+ },
+ "tenant_id" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : { },
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email", "first_name", "last_name" ],
+ "additionalProperties" : false
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
"type" : "string"
},
"updated_at" : { },
+ "dependency_analysis_version" : {
+ "type" : "integer"
+ },
+ "source_readable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"tag_ids" : {
"type" : "array",
"items" : {
@@ -42432,20 +43549,37 @@
"minimum" : 1
}
},
+ "collection_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : { },
+ "target" : { },
"created_at" : { },
+ "creator_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"description" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "anyOf" : [ { }, { } ]
- } ]
+ "type" : "string"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "id", "name", "description", "schedule", "ui_display_type", "entity_id", "created_at", "updated_at" ],
+ "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ],
"additionalProperties" : false
}
}
@@ -42459,23 +43593,13 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/transform-job" ]
- }
- },
- "/api/transform-job/{job-id}" : {
- "put" : {
- "summary" : "PUT /api/transform-job/{job-id}",
- "description" : "Update a transform job.",
- "parameters" : [ {
- "in" : "path",
- "name" : "job-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "tags" : [ "/api/transform" ]
+ },
+ "post" : {
+ "operationId" : "post-api-transform",
+ "summary" : "POST /api/transform",
+ "description" : "Create a new transform.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response",
@@ -42484,13 +43608,56 @@
"schema" : {
"type" : "object",
"properties" : {
- "built_in_type" : {
+ "table" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "object",
+ "properties" : { }
}, {
"type" : "null"
} ]
},
+ "owner" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "email" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_type" : {
+ "type" : "string"
+ },
"entity_id" : {
"oneOf" : [ {
"type" : "string"
@@ -42509,6 +43676,14 @@
"type" : "null"
} ]
},
+ "user_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
"is_active" : {
"oneOf" : [ {
"type" : "boolean"
@@ -42516,6 +43691,10 @@
"type" : "null"
} ]
},
+ "transform_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
"id" : {
"type" : "integer",
"minimum" : 1
@@ -42523,60 +43702,141 @@
"run_method" : {
"type" : "string"
},
- "updated_at" : { },
"status" : {
"type" : "string",
- "enum" : [ "started", "succeeded", "failed", "timeout" ]
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ]
},
- "job_id" : {
- "type" : "integer",
- "minimum" : 1
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"end_time" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
- "created_at" : { },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"start_time" : { }
},
- "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
+ "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
- "ui_display_type" : {
- "type" : "string",
- "enum" : [ "cron/raw", "cron/builder" ]
+ "source_database_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_db_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator" : {
+ "type" : "object",
+ "properties" : {
+ "is_qbnewb" : {
+ "type" : "boolean"
+ },
+ "last_login" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "is_data_analyst" : {
+ "type" : "boolean"
+ },
+ "is_superuser" : {
+ "type" : "boolean"
+ },
+ "tenant_id" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : { },
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email", "first_name", "last_name" ],
+ "additionalProperties" : false
},
- "next_run" : {
+ "owner_user_id" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : {
- "start_time" : { }
- },
- "required" : [ "start_time" ],
- "additionalProperties" : false
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
"name" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "anyOf" : [ { }, { } ]
- } ]
- },
- "schedule" : {
"type" : "string"
},
"updated_at" : { },
+ "dependency_analysis_version" : {
+ "type" : "integer"
+ },
+ "source_readable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"tag_ids" : {
"type" : "array",
"items" : {
@@ -42584,20 +43844,37 @@
"minimum" : 1
}
},
+ "collection_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : { },
+ "target" : { },
"created_at" : { },
+ "creator_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"description" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "anyOf" : [ { }, { } ]
- } ]
+ "type" : "string"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "id", "name", "description", "schedule", "ui_display_type", "entity_id", "created_at", "updated_at" ],
+ "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ],
"additionalProperties" : false
}
}
@@ -42616,21 +43893,24 @@
"schema" : {
"type" : "object",
"properties" : {
- "description" : {
+ "owner_email" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "name" : {
- "type" : "string",
- "minLength" : 1
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "schedule" : {
- "type" : "string",
- "minLength" : 1
+ "name" : {
+ "type" : "string"
},
"tag_ids" : {
"type" : "array",
@@ -42640,56 +43920,46 @@
"minimum" : 1
}
},
- "ui_display_type" : {
- "type" : "string",
- "enum" : [ "cron/raw", "cron/builder" ]
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-source"
+ },
+ "target" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
+ },
+ "run_trigger" : {
+ "$ref" : "#/components/schemas/metabase.transforms-rest.api.transform.run-trigger"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
- }
+ },
+ "required" : [ "name", "source", "target" ]
}
}
}
},
- "tags" : [ "/api/transform-job" ]
- },
- "delete" : {
- "summary" : "DELETE /api/transform-job/{job-id}",
- "description" : "Delete a transform job.",
- "parameters" : [ {
- "in" : "path",
- "name" : "job-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/transform-job" ]
- },
- "get" : {
- "summary" : "GET /api/transform-job/{job-id}",
- "description" : "Get a transform job by ID.",
- "parameters" : [ {
- "in" : "path",
- "name" : "job-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "tags" : [ "/api/transform" ]
+ }
+ },
+ "/api/transform-job" : {
+ "post" : {
+ "operationId" : "post-api-transform-job",
+ "summary" : "POST /api/transform-job",
+ "description" : "Create a new transform job.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response",
@@ -42824,67 +44094,108 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/transform-job" ]
- }
- },
- "/api/transform-job/{job-id}/run" : {
- "post" : {
- "summary" : "POST /api/transform-job/{job-id}/run",
- "description" : "Run a transform job manually.",
- "parameters" : [ {
- "in" : "path",
- "name" : "job-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "job_run_id" : {
- "type" : "string"
- },
- "message" : {
- "type" : "string"
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "schedule" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "tag_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}
},
- "required" : [ "message", "job_run_id" ],
- "additionalProperties" : false
- }
+ "ui_display_type" : {
+ "default" : "cron/raw",
+ "type" : "string",
+ "enum" : [ "cron/raw", "cron/builder" ]
+ }
+ },
+ "required" : [ "name", "schedule", "ui_display_type" ]
}
}
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
}
},
"tags" : [ "/api/transform-job" ]
- }
- },
- "/api/transform-job/{job-id}/transforms" : {
+ },
"get" : {
- "summary" : "GET /api/transform-job/{job-id}/transforms",
- "description" : "Get the transforms of job specified by the job's ID.",
+ "operationId" : "get-api-transform-job",
+ "summary" : "GET /api/transform-job",
+ "description" : "Get all transform jobs.",
"parameters" : [ {
- "in" : "path",
- "name" : "job-id",
- "required" : true,
+ "in" : "query",
+ "name" : "last-run-start-time",
+ "required" : false,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "next-run-start-time",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "last-run-statuses",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "started", "succeeded", "failed", "timeout" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "tag-ids",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -42896,8 +44207,12 @@
"items" : {
"type" : "object",
"properties" : {
- "source_type" : {
- "type" : "string"
+ "built_in_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"entity_id" : {
"oneOf" : [ {
@@ -42906,105 +44221,107 @@
"type" : "null"
} ]
},
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "creator" : {
- "type" : "object",
- "properties" : {
- "is_qbnewb" : {
- "type" : "boolean"
- },
- "last_login" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "email" : {
- "type" : "string"
- },
- "is_data_analyst" : {
- "type" : "boolean"
- },
- "is_superuser" : {
- "type" : "boolean"
- },
- "tenant_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "first_name" : {
- "oneOf" : [ {
+ "last_run" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "run_method" : {
"type" : "string"
- }, {
- "type" : "null"
- } ]
+ },
+ "updated_at" : { },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "started", "succeeded", "failed", "timeout" ]
+ },
+ "job_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "start_time" : { }
},
- "date_joined" : { },
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "email", "first_name", "last_name" ],
- "additionalProperties" : false
- },
- "name" : {
- "type" : "string"
+ "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
},
- "updated_at" : { },
- "dependency_analysis_version" : {
- "type" : "integer"
+ "ui_display_type" : {
+ "type" : "string",
+ "enum" : [ "cron/raw", "cron/builder" ]
},
- "collection_id" : {
+ "next_run" : {
"oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
+ "type" : "object",
+ "properties" : {
+ "start_time" : { }
+ },
+ "required" : [ "start_time" ],
+ "additionalProperties" : false
}, {
"type" : "null"
} ]
},
- "source" : { },
- "target" : { },
- "created_at" : { },
- "creator_id" : {
+ "id" : {
"type" : "integer",
"minimum" : 1
},
- "run_trigger" : {
- "oneOf" : [ {
+ "name" : {
+ "anyOf" : [ {
"type" : "string"
}, {
- "type" : "null"
+ "anyOf" : [ { }, { } ]
} ]
},
+ "schedule" : {
+ "type" : "string"
+ },
+ "updated_at" : { },
+ "tag_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "created_at" : { },
"description" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
}, {
"type" : "null"
} ]
}
},
- "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ]
+ "required" : [ "id", "name", "description", "schedule", "ui_display_type", "entity_id", "created_at", "updated_at" ],
+ "additionalProperties" : false
}
}
}
@@ -43020,11 +44337,21 @@
"tags" : [ "/api/transform-job" ]
}
},
- "/api/transform-tag/" : {
- "post" : {
- "summary" : "POST /api/transform-tag/",
- "description" : "Create a new transform tag.",
- "parameters" : [ ],
+ "/api/transform-job/{job-id}" : {
+ "put" : {
+ "operationId" : "put-api-transform-job-job-id",
+ "summary" : "PUT /api/transform-job/{job-id}",
+ "description" : "Update a transform job.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "job-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response",
@@ -43040,13 +44367,73 @@
"type" : "null"
} ]
},
- "can_run" : {
- "type" : "boolean"
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "updated_at" : { },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "started", "succeeded", "failed", "timeout" ]
+ },
+ "job_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "start_time" : { }
+ },
+ "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ui_display_type" : {
+ "type" : "string",
+ "enum" : [ "cron/raw", "cron/builder" ]
},
- "created_at" : { },
- "entity_id" : {
+ "next_run" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "object",
+ "properties" : {
+ "start_time" : { }
+ },
+ "required" : [ "start_time" ],
+ "additionalProperties" : false
}, {
"type" : "null"
} ]
@@ -43062,9 +44449,31 @@
"anyOf" : [ { }, { } ]
} ]
},
- "updated_at" : { }
+ "schedule" : {
+ "type" : "string"
+ },
+ "updated_at" : { },
+ "tag_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "created_at" : { },
+ "description" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "required" : [ "id", "name", "entity_id", "created_at", "updated_at" ],
+ "required" : [ "id", "name", "description", "schedule", "ui_display_type", "entity_id", "created_at", "updated_at" ],
"additionalProperties" : false
}
}
@@ -43083,69 +44492,58 @@
"schema" : {
"type" : "object",
"properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
"name" : {
"type" : "string",
"minLength" : 1
+ },
+ "schedule" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "tag_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "ui_display_type" : {
+ "type" : "string",
+ "enum" : [ "cron/raw", "cron/builder" ]
}
- },
- "required" : [ "name" ]
+ }
}
}
}
},
- "tags" : [ "/api/transform-tag" ]
+ "tags" : [ "/api/transform-job" ]
},
- "get" : {
- "summary" : "GET /api/transform-tag/",
- "description" : "Get a list of all transform tags.",
- "parameters" : [ ],
+ "delete" : {
+ "operationId" : "delete-api-transform-job-job-id",
+ "summary" : "DELETE /api/transform-job/{job-id}",
+ "description" : "Delete a transform job.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "job-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "built_in_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "can_run" : {
- "type" : "boolean"
- },
- "created_at" : { },
- "entity_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "anyOf" : [ { }, { } ]
- } ]
- },
- "updated_at" : { }
- },
- "required" : [ "id", "name", "entity_id", "created_at", "updated_at" ],
- "additionalProperties" : false
- }
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -43154,16 +44552,15 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/transform-tag" ]
- }
- },
- "/api/transform-tag/{tag-id}" : {
- "put" : {
- "summary" : "PUT /api/transform-tag/{tag-id}",
- "description" : "Update a transform tag.",
+ "tags" : [ "/api/transform-job" ]
+ },
+ "get" : {
+ "operationId" : "get-api-transform-job-job-id",
+ "summary" : "GET /api/transform-job/{job-id}",
+ "description" : "Get a transform job by ID.",
"parameters" : [ {
"in" : "path",
- "name" : "tag-id",
+ "name" : "job-id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -43186,10 +44583,6 @@
"type" : "null"
} ]
},
- "can_run" : {
- "type" : "boolean"
- },
- "created_at" : { },
"entity_id" : {
"oneOf" : [ {
"type" : "string"
@@ -43197,6 +44590,70 @@
"type" : "null"
} ]
},
+ "last_run" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "updated_at" : { },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "started", "succeeded", "failed", "timeout" ]
+ },
+ "job_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "start_time" : { }
+ },
+ "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ui_display_type" : {
+ "type" : "string",
+ "enum" : [ "cron/raw", "cron/builder" ]
+ },
+ "next_run" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "start_time" : { }
+ },
+ "required" : [ "start_time" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
"id" : {
"type" : "integer",
"minimum" : 1
@@ -43208,9 +44665,31 @@
"anyOf" : [ { }, { } ]
} ]
},
- "updated_at" : { }
+ "schedule" : {
+ "type" : "string"
+ },
+ "updated_at" : { },
+ "tag_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "created_at" : { },
+ "description" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "required" : [ "id", "name", "entity_id", "created_at", "updated_at" ],
+ "required" : [ "id", "name", "description", "schedule", "ui_display_type", "entity_id", "created_at", "updated_at" ],
"additionalProperties" : false
}
}
@@ -43223,30 +44702,17 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "name" ]
- }
- }
- }
- },
- "tags" : [ "/api/transform-tag" ]
- },
- "delete" : {
- "summary" : "DELETE /api/transform-tag/{tag-id}",
- "description" : "Delete a transform tag. Removes it from all transforms and jobs.",
+ "tags" : [ "/api/transform-job" ]
+ }
+ },
+ "/api/transform-job/{job-id}/run" : {
+ "post" : {
+ "operationId" : "post-api-transform-job-job-id-run",
+ "summary" : "POST /api/transform-job/{job-id}/run",
+ "description" : "Run a transform job manually.",
"parameters" : [ {
"in" : "path",
- "name" : "tag-id",
+ "name" : "job-id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -43260,7 +44726,17 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "null"
+ "type" : "object",
+ "properties" : {
+ "job_run_id" : {
+ "type" : "string"
+ },
+ "message" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "message", "job_run_id" ],
+ "additionalProperties" : false
}
}
}
@@ -43272,209 +44748,40 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/transform-tag" ]
+ "tags" : [ "/api/transform-job" ]
}
},
- "/api/transform/" : {
+ "/api/transform-job/{job-id}/transforms" : {
"get" : {
- "summary" : "GET /api/transform/",
- "description" : "Get a list of transforms.",
+ "operationId" : "get-api-transform-job-job-id-transforms",
+ "summary" : "GET /api/transform-job/{job-id}/transforms",
+ "description" : "Get the transforms of job specified by the job's ID.",
"parameters" : [ {
- "in" : "query",
- "name" : "last-run-start-time",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "last-run-statuses",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string",
- "enum" : [ "started", "succeeded", "failed", "timeout" ]
- }
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "tag-ids",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
- }
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "database-id",
- "required" : false,
+ "in" : "path",
+ "name" : "job-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "table" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "owner" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email" : {
- "type" : "string"
- },
- "first_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "email" ],
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "source_type" : {
- "type" : "string"
- },
- "entity_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "last_run" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "user_id" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "is_active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "transform_id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "run_method" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ]
- },
- "transform_entity_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "end_time" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "transform_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "start_time" : { }
- },
- "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "source_type" : {
+ "type" : "string"
},
- "source_database_id" : {
+ "entity_id" : {
"oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
@@ -43483,21 +44790,6 @@
"type" : "integer",
"minimum" : 1
},
- "owner_email" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "target_db_id" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
"creator" : {
"type" : "object",
"properties" : {
@@ -43523,7 +44815,9 @@
"type" : "boolean"
},
"tenant_id" : {
- "oneOf" : [ { }, {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
"type" : "null"
} ]
},
@@ -43553,14 +44847,6 @@
"required" : [ "id", "email", "first_name", "last_name" ],
"additionalProperties" : false
},
- "owner_user_id" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
"name" : {
"type" : "string"
},
@@ -43568,20 +44854,6 @@
"dependency_analysis_version" : {
"type" : "integer"
},
- "source_readable" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "tag_ids" : {
- "type" : "array",
- "items" : {
- "type" : "integer",
- "minimum" : 1
- }
- },
"collection_id" : {
"oneOf" : [ {
"type" : "integer",
@@ -43612,8 +44884,7 @@
} ]
}
},
- "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ],
- "additionalProperties" : false
+ "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ]
}
}
}
@@ -43626,11 +44897,14 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/transform" ]
- },
+ "tags" : [ "/api/transform-job" ]
+ }
+ },
+ "/api/transform-tag" : {
"post" : {
- "summary" : "POST /api/transform/",
- "description" : "Create a new transform.",
+ "operationId" : "post-api-transform-tag",
+ "summary" : "POST /api/transform-tag",
+ "description" : "Create a new transform tag.",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -43640,56 +44914,17 @@
"schema" : {
"type" : "object",
"properties" : {
- "table" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "owner" : {
+ "built_in_type" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : {
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email" : {
- "type" : "string"
- },
- "first_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "email" ],
- "additionalProperties" : false
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "source_type" : {
- "type" : "string"
+ "can_run" : {
+ "type" : "boolean"
},
+ "created_at" : { },
"entity_id" : {
"oneOf" : [ {
"type" : "string"
@@ -43697,216 +44932,168 @@
"type" : "null"
} ]
},
- "last_run" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "user_id" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "is_active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "transform_id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "run_method" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ]
- },
- "transform_entity_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "end_time" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "transform_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "start_time" : { }
- },
- "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "source_database_id" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
"id" : {
"type" : "integer",
"minimum" : 1
},
- "owner_email" : {
- "oneOf" : [ {
+ "name" : {
+ "anyOf" : [ {
"type" : "string"
}, {
- "type" : "null"
- } ]
- },
- "target_db_id" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
+ "anyOf" : [ { }, { } ]
} ]
},
- "creator" : {
- "type" : "object",
- "properties" : {
- "is_qbnewb" : {
- "type" : "boolean"
- },
- "last_login" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "email" : {
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "entity_id", "created_at", "updated_at" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "name" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/transform-tag" ]
+ },
+ "get" : {
+ "operationId" : "get-api-transform-tag",
+ "summary" : "GET /api/transform-tag",
+ "description" : "Get a list of all transform tags.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "built_in_type" : {
+ "oneOf" : [ {
"type" : "string"
- },
- "is_data_analyst" : {
- "type" : "boolean"
- },
- "is_superuser" : {
- "type" : "boolean"
- },
- "tenant_id" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "first_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "date_joined" : { },
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "id", "email", "first_name", "last_name" ],
- "additionalProperties" : false
- },
- "owner_user_id" : {
- "oneOf" : [ {
+ "can_run" : {
+ "type" : "boolean"
+ },
+ "created_at" : { },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
"type" : "integer",
"minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "updated_at" : { },
- "dependency_analysis_version" : {
- "type" : "integer"
+ },
+ "name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ },
+ "updated_at" : { }
},
- "source_readable" : {
+ "required" : [ "id", "name", "entity_id", "created_at", "updated_at" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/transform-tag" ]
+ }
+ },
+ "/api/transform-tag/{tag-id}" : {
+ "put" : {
+ "operationId" : "put-api-transform-tag-tag-id",
+ "summary" : "PUT /api/transform-tag/{tag-id}",
+ "description" : "Update a transform tag.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "tag-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "built_in_type" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "tag_ids" : {
- "type" : "array",
- "items" : {
- "type" : "integer",
- "minimum" : 1
- }
+ "can_run" : {
+ "type" : "boolean"
},
- "collection_id" : {
+ "created_at" : { },
+ "entity_id" : {
"oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "source" : { },
- "target" : { },
- "created_at" : { },
- "creator_id" : {
+ "id" : {
"type" : "integer",
"minimum" : 1
},
- "run_trigger" : {
- "oneOf" : [ {
+ "name" : {
+ "anyOf" : [ {
"type" : "string"
}, {
- "type" : "null"
+ "anyOf" : [ { }, { } ]
} ]
},
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
+ "updated_at" : { }
},
- "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ],
+ "required" : [ "id", "name", "entity_id", "created_at", "updated_at" ],
"additionalProperties" : false
}
}
@@ -43925,69 +45112,56 @@
"schema" : {
"type" : "object",
"properties" : {
- "owner_email" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "owner_user_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
"name" : {
- "type" : "string"
- },
- "tag_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "source" : {
- "$ref" : "#/components/schemas/metabase.transforms.schema.transform-source"
- },
- "target" : {
- "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
- },
- "run_trigger" : {
- "$ref" : "#/components/schemas/metabase.transforms-rest.api.transform.run-trigger"
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "type" : "string",
+ "minLength" : 1
}
},
- "required" : [ "name", "source", "target" ]
+ "required" : [ "name" ]
}
}
}
},
- "tags" : [ "/api/transform" ]
+ "tags" : [ "/api/transform-tag" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-transform-tag-tag-id",
+ "summary" : "DELETE /api/transform-tag/{tag-id}",
+ "description" : "Delete a transform tag. Removes it from all transforms and jobs.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "tag-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/transform-tag" ]
}
},
"/api/transform/extract-columns" : {
"post" : {
+ "operationId" : "post-api-transform-extract-columns",
"summary" : "POST /api/transform/extract-columns",
"description" : "Extract column names suitable for incremental transform checkpoint filtering.\n\n This endpoint is specifically for populating the checkpoint column dropdown in\n incremental transforms. It only returns columns with types supported for checkpoint\n filtering: temporal (timestamp/tz) and numeric (int/float) types.\n\n Text, boolean, and other unsupported column types are filtered out.\n\n The query is compiled to native SQL using [[qp.compile/compile-with-inline-parameters]],\n which handles parameterized queries with template tags. Then extracts column names\n and types using PreparedStatement metadata.\n\n Returns a map with a :columns key containing a vector of column names (strings).\n If extraction fails, returns nil for :columns.",
"parameters" : [ ],
@@ -44042,6 +45216,7 @@
},
"/api/transform/is-simple-query" : {
"post" : {
+ "operationId" : "post-api-transform-is-simple-query",
"summary" : "POST /api/transform/is-simple-query",
"description" : "Checks if a native SQL query string is simple enough for automatic checkpoint insertion",
"parameters" : [ ],
@@ -44092,6 +45267,7 @@
},
"/api/transform/run" : {
"get" : {
+ "operationId" : "get-api-transform-run",
"summary" : "GET /api/transform/run",
"description" : "Get transform runs based on a set of filter params.",
"parameters" : [ {
@@ -44348,6 +45524,7 @@
},
"/api/transform/run/{run-id}" : {
"get" : {
+ "operationId" : "get-api-transform-run-run-id",
"summary" : "GET /api/transform/run/{run-id}",
"description" : "Get a transform run by ID.",
"parameters" : [ {
@@ -44491,6 +45668,7 @@
},
"/api/transform/{id}" : {
"get" : {
+ "operationId" : "get-api-transform-id",
"summary" : "GET /api/transform/{id}",
"description" : "Get a specific transform.",
"parameters" : [ {
@@ -44793,6 +45971,7 @@
"tags" : [ "/api/transform" ]
},
"put" : {
+ "operationId" : "put-api-transform-id",
"summary" : "PUT /api/transform/{id}",
"description" : "Update a transform.",
"parameters" : [ {
@@ -45158,6 +46337,7 @@
"tags" : [ "/api/transform" ]
},
"delete" : {
+ "operationId" : "delete-api-transform-id",
"summary" : "DELETE /api/transform/{id}",
"description" : "Delete a transform.",
"parameters" : [ {
@@ -45193,6 +46373,7 @@
},
"/api/transform/{id}/cancel" : {
"post" : {
+ "operationId" : "post-api-transform-id-cancel",
"summary" : "POST /api/transform/{id}/cancel",
"description" : "Cancel the current run for a given transform.",
"parameters" : [ {
@@ -45228,6 +46409,7 @@
},
"/api/transform/{id}/dependencies" : {
"get" : {
+ "operationId" : "get-api-transform-id-dependencies",
"summary" : "GET /api/transform/{id}/dependencies",
"description" : "Get the dependencies of a specific transform.",
"parameters" : [ {
@@ -45533,8 +46715,165 @@
"tags" : [ "/api/transform" ]
}
},
+ "/api/transform/{id}/inspect" : {
+ "get" : {
+ "operationId" : "get-api-transform-id-inspect",
+ "summary" : "GET /api/transform/{id}/inspect",
+ "description" : "Phase 1: Discover available lenses for a transform.\n Returns structural metadata and available lens types.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.discovery-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/transform" ]
+ }
+ },
+ "/api/transform/{id}/inspect/{lens-id}" : {
+ "get" : {
+ "operationId" : "get-api-transform-id-inspect-lens-id",
+ "summary" : "GET /api/transform/{id}/inspect/{lens-id}",
+ "description" : "Phase 2: Get full lens contents for a transform.\n Returns sections, cards with dataset_query, and trigger definitions.\n Accepts optional params for drill lenses as query params.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "lens-id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.lens"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/transform" ]
+ }
+ },
+ "/api/transform/{id}/inspect/{lens-id}/query" : {
+ "post" : {
+ "operationId" : "post-api-transform-id-inspect-lens-id-query",
+ "summary" : "POST /api/transform/{id}/inspect/{lens-id}/query",
+ "description" : "Execute a query in the context of a transform inspector lens.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "lens-id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "lens_params" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "query" : {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ },
+ "required" : [ "query" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/transform" ]
+ }
+ },
"/api/transform/{id}/merge-history" : {
"get" : {
+ "operationId" : "get-api-transform-id-merge-history",
"summary" : "GET /api/transform/{id}/merge-history",
"description" : "Get merge history for a transform. Returns all merge events that affected this transform,\n ordered by created_at descending (newest first).",
"parameters" : [ {
@@ -45607,6 +46946,7 @@
},
"/api/transform/{id}/run" : {
"post" : {
+ "operationId" : "post-api-transform-id-run",
"summary" : "POST /api/transform/{id}/run",
"description" : "Run a transform.",
"parameters" : [ {
@@ -45664,6 +47004,7 @@
},
"/api/transform/{id}/table" : {
"delete" : {
+ "operationId" : "delete-api-transform-id-table",
"summary" : "DELETE /api/transform/{id}/table",
"description" : "Delete a transform's output table.",
"parameters" : [ {
@@ -45699,6 +47040,7 @@
},
"/api/upload/csv" : {
"post" : {
+ "operationId" : "post-api-upload-csv",
"summary" : "POST /api/upload/csv",
"description" : "Create a table and model populated with the values from the attached CSV. Returns the model ID if successful.",
"parameters" : [ ],
@@ -45746,156 +47088,10 @@
"tags" : [ "/api/upload" ]
}
},
- "/api/user-key-value/namespace/{namespace}" : {
+ "/api/user" : {
"get" : {
- "summary" : "GET /api/user-key-value/namespace/{namespace}",
- "description" : "Returns all KV pairs in a given namespace for the current user",
- "parameters" : [ {
- "in" : "path",
- "name" : "namespace",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/user-key-value" ]
- }
- },
- "/api/user-key-value/namespace/{namespace}/key/{key}" : {
- "put" : {
- "summary" : "PUT /api/user-key-value/namespace/{namespace}/key/{key}",
- "description" : "Upsert a KV-pair for the user",
- "parameters" : [ {
- "in" : "path",
- "name" : "key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- }, {
- "in" : "path",
- "name" : "namespace",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "expires_at" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.datetime"
- }, {
- "type" : "null"
- } ]
- },
- "value" : { }
- }
- }
- }
- }
- },
- "tags" : [ "/api/user-key-value" ]
- },
- "get" : {
- "summary" : "GET /api/user-key-value/namespace/{namespace}/key/{key}",
- "description" : "Get a value for the user",
- "parameters" : [ {
- "in" : "path",
- "name" : "key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- }, {
- "in" : "path",
- "name" : "namespace",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/user-key-value" ]
- },
- "delete" : {
- "summary" : "DELETE /api/user-key-value/namespace/{namespace}/key/{key}",
- "description" : "Deletes a KV-pair for the user",
- "parameters" : [ {
- "in" : "path",
- "name" : "key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- }, {
- "in" : "path",
- "name" : "namespace",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/user-key-value" ]
- }
- },
- "/api/user/" : {
- "get" : {
- "summary" : "GET /api/user/",
+ "operationId" : "get-api-user",
+ "summary" : "GET /api/user",
"description" : "Fetch a list of `Users` for admins or group managers.\n By default returns only active users for admins/data-analysts and only active users within groups that the group manager is\n managing for group managers.\n\n - If `status` is `deactivated`, include deactivated users only.\n\n - If `status` is `all`, include all users (active and inactive).\n\n - Also supports `include_deactivated`, which if true, is equivalent to `status=all`; If is false, is equivalent to\n `status=active`. `status` and `include_deactivated` requires superuser permissions.\n\n - `include_deactivated` is a legacy alias for `status` and will be removed in a future release, users are advised\n to use `status` for better support and flexibility.\n\n If both params are passed, `status` takes precedence.\n - if a `tenant_id` is passed, only users with that tenant_id will be returned.\n\n For users with segmented permissions, return only themselves.\n\n Takes `limit`, `offset` for pagination.\n\n Takes `query` for filtering on first name, last name, email.\n\n Also takes `group_id`, which filters on group id.\n\n If the user is a sandboxed user, only return themselves regardless of the query parameters.",
"parameters" : [ {
"in" : "query",
@@ -46006,7 +47202,8 @@
"tags" : [ "/api/user" ]
},
"post" : {
- "summary" : "POST /api/user/",
+ "operationId" : "post-api-user",
+ "summary" : "POST /api/user",
"description" : "Create a new `User`, return a 400 if the email address is already taken",
"parameters" : [ ],
"responses" : {
@@ -46090,8 +47287,160 @@
"tags" : [ "/api/user" ]
}
},
+ "/api/user-key-value/namespace/{namespace}" : {
+ "get" : {
+ "operationId" : "get-api-user-key-value-namespace-namespace",
+ "summary" : "GET /api/user-key-value/namespace/{namespace}",
+ "description" : "Returns all KV pairs in a given namespace for the current user",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/user-key-value" ]
+ }
+ },
+ "/api/user-key-value/namespace/{namespace}/key/{key}" : {
+ "put" : {
+ "operationId" : "put-api-user-key-value-namespace-namespace-key-key",
+ "summary" : "PUT /api/user-key-value/namespace/{namespace}/key/{key}",
+ "description" : "Upsert a KV-pair for the user",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "path",
+ "name" : "namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "expires_at" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.datetime"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "value" : { }
+ }
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/user-key-value" ]
+ },
+ "get" : {
+ "operationId" : "get-api-user-key-value-namespace-namespace-key-key",
+ "summary" : "GET /api/user-key-value/namespace/{namespace}/key/{key}",
+ "description" : "Get a value for the user",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "path",
+ "name" : "namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/user-key-value" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-user-key-value-namespace-namespace-key-key",
+ "summary" : "DELETE /api/user-key-value/namespace/{namespace}/key/{key}",
+ "description" : "Deletes a KV-pair for the user",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "path",
+ "name" : "namespace",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/user-key-value" ]
+ }
+ },
"/api/user/current" : {
"get" : {
+ "operationId" : "get-api-user-current",
"summary" : "GET /api/user/current",
"description" : "Fetch the current `User`.",
"parameters" : [ ],
@@ -46111,6 +47460,7 @@
},
"/api/user/recipients" : {
"get" : {
+ "operationId" : "get-api-user-recipients",
"summary" : "GET /api/user/recipients",
"description" : "Fetch a list of `Users`. Returns only active users. Meant for non-admins unlike GET /api/user.\n\n - If user-visibility is :all or the user is an admin, include all users.\n - If user-visibility is :group, include only users in the same group (excluding the all users group).\n - If user-visibility is :none or the user is sandboxed, include only themselves.",
"parameters" : [ ],
@@ -46130,6 +47480,7 @@
},
"/api/user/{id}" : {
"get" : {
+ "operationId" : "get-api-user-id",
"summary" : "GET /api/user/{id}",
"description" : "Fetch a `User`. You must be fetching yourself *or* be a superuser *or* a Group Manager.",
"parameters" : [ {
@@ -46156,6 +47507,7 @@
"tags" : [ "/api/user" ]
},
"put" : {
+ "operationId" : "put-api-user-id",
"summary" : "PUT /api/user/{id}",
"description" : "Update an existing, active `User`.\n Self or superusers can update user info and groups.\n Group Managers can only add/remove users from groups they are manager of.",
"parameters" : [ {
@@ -46274,6 +47626,7 @@
"tags" : [ "/api/user" ]
},
"delete" : {
+ "operationId" : "delete-api-user-id",
"summary" : "DELETE /api/user/{id}",
"description" : "Disable a `User`. This does not remove the `User` from the DB, but instead disables their account.",
"parameters" : [ {
@@ -46302,6 +47655,7 @@
},
"/api/user/{id}/modal/{modal}" : {
"put" : {
+ "operationId" : "put-api-user-id-modal-modal",
"summary" : "PUT /api/user/{id}/modal/{modal}",
"description" : "Indicate that a user has been informed about the vast intricacies of 'the' Query Builder.",
"parameters" : [ {
@@ -46338,6 +47692,7 @@
},
"/api/user/{id}/password" : {
"put" : {
+ "operationId" : "put-api-user-id-password",
"summary" : "PUT /api/user/{id}/password",
"description" : "Update a user's password.",
"parameters" : [ {
@@ -46382,6 +47737,7 @@
},
"/api/user/{id}/reactivate" : {
"put" : {
+ "operationId" : "put-api-user-id-reactivate",
"summary" : "PUT /api/user/{id}/reactivate",
"description" : "Reactivate user at `:id`",
"parameters" : [ {
@@ -46410,6 +47766,7 @@
},
"/api/util/random_token" : {
"get" : {
+ "operationId" : "get-api-util-random_token",
"summary" : "GET /api/util/random_token",
"description" : "Return a cryptographically secure random 32-byte token, encoded as a hexadecimal string.\n Intended for use when creating a value for `embedding-secret-key`.",
"parameters" : [ ],
@@ -46428,6 +47785,9 @@
}
}
},
+ "security" : [ {
+ "ApiKeyAuth" : [ ]
+ } ],
"servers" : [ {
"url" : "http://localhost:3000",
"description" : "Localhost"