The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
{
"components" : {
"schemas" : {
"gsheets.response" : {
"anyOf" : [ {
"type" : "object",
"properties" : {
"error" : {
"type" : "boolean"
},
"message" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "error", "message" ]
}, {
"oneOf" : [ {
"type" : "object",
"properties" : { }
}, {
"type" : "object",
"properties" : {
"created_at" : {
"type" : "integer",
"minimum" : 1
},
"created_by_id" : {
"type" : "integer",
"minimum" : 1
},
"db_id" : {
"type" : "integer",
"minimum" : 1
},
"sync_started_at" : {
"type" : "integer",
"minimum" : 1
},
"url" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "url", "created_at", "sync_started_at", "created_by_id", "db_id" ]
}, {
"type" : "object",
"properties" : {
"created_at" : {
"type" : "integer",
"minimum" : 1
},
"created_by_id" : {
"type" : "integer",
"minimum" : 1
},
"db_id" : {
"type" : "integer",
"minimum" : 1
},
"sync_started_at" : {
"type" : "integer",
"minimum" : 1
},
"url" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "url", "created_at", "sync_started_at", "created_by_id", "db_id" ]
}, {
"type" : "object",
"properties" : {
"created_at" : {
"type" : "integer",
"minimum" : 1
},
"created_by_id" : {
"type" : "integer",
"minimum" : 1
},
"db_id" : {
"type" : "integer",
"minimum" : 1
},
"last_sync_at" : {
"type" : "integer",
"minimum" : 1
},
"next_sync_at" : {
"type" : "integer",
"minimum" : 1
},
"url" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "url", "created_at", "last_sync_at", "next_sync_at", "created_by_id", "db_id" ]
}, {
"type" : "object",
"properties" : {
"created_at" : {
"type" : "integer",
"minimum" : 1
},
"created_by_id" : {
"type" : "integer",
"minimum" : 1
},
"db_id" : {
"type" : "integer",
"minimum" : 1
},
"error_message" : {
"type" : "string",
"minLength" : 1
},
"url" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "url", "created_at", "error_message", "created_by_id", "db_id" ]
} ]
} ]
},
"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"
}, {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-numeric-schema"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.temporal-difference-schema"
} ]
} ]
},
"mbql.clause._BANG__EQ_" : { },
"mbql.clause._EQ_" : { },
"mbql.clause._GT_" : {
"type" : "array",
"prefixItems" : [ {
"const" : ">"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
"mbql.clause._GT__EQ_" : {
"type" : "array",
"prefixItems" : [ {
"const" : ">="
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
"mbql.clause._LT_" : {
"type" : "array",
"prefixItems" : [ {
"const" : "<"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
"mbql.clause._LT__EQ_" : {
"type" : "array",
"prefixItems" : [ {
"const" : "<="
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$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" : [ {
"const" : "abs"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.absolute-datetime" : { },
"mbql.clause.aggregation" : {
"type" : "array",
"prefixItems" : [ {
"const" : "aggregation"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.ref.aggregation-options"
}, {
"type" : "string"
} ]
},
"mbql.clause.and" : { },
"mbql.clause.asc" : {
"type" : "array",
"prefixItems" : [ {
"const" : "asc"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
"mbql.clause.avg" : {
"type" : "array",
"prefixItems" : [ {
"const" : "avg"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.between" : {
"type" : "array",
"prefixItems" : [ {
"const" : "between"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
"mbql.clause.case" : { },
"mbql.clause.ceil" : {
"type" : "array",
"prefixItems" : [ {
"const" : "ceil"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.coalesce" : { },
"mbql.clause.collate" : {
"type" : "array",
"prefixItems" : [ {
"const" : "collate"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
}, {
"type" : "string"
} ]
},
"mbql.clause.concat" : { },
"mbql.clause.contains" : { },
"mbql.clause.convert-timezone" : { },
"mbql.clause.count" : { },
"mbql.clause.count-where" : {
"type" : "array",
"prefixItems" : [ {
"const" : "count-where"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
} ]
},
"mbql.clause.cum-count" : { },
"mbql.clause.cum-sum" : {
"type" : "array",
"prefixItems" : [ {
"const" : "cum-sum"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.date" : {
"type" : "array",
"prefixItems" : [ {
"const" : "date"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
} ]
} ]
},
"mbql.clause.datetime" : { },
"mbql.clause.datetime-add" : {
"type" : "array",
"prefixItems" : [ {
"const" : "datetime-add"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
}, {
"type" : "integer"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.date-time.interval"
} ]
},
"mbql.clause.datetime-diff" : {
"type" : "array",
"prefixItems" : [ {
"const" : "datetime-diff"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal.datetime-diff-unit"
} ]
},
"mbql.clause.datetime-subtract" : {
"type" : "array",
"prefixItems" : [ {
"const" : "datetime-subtract"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
}, {
"type" : "integer"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.date-time.interval"
} ]
},
"mbql.clause.day-name" : {
"type" : "array",
"prefixItems" : [ {
"const" : "day-name"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.integer"
} ]
},
"mbql.clause.desc" : {
"type" : "array",
"prefixItems" : [ {
"const" : "desc"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
"mbql.clause.distinct" : {
"type" : "array",
"prefixItems" : [ {
"const" : "distinct"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.aggregation..distinct.arg"
} ]
},
"mbql.clause.distinct-where" : {
"type" : "array",
"prefixItems" : [ {
"const" : "distinct-where"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.aggregation..distinct.arg"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
} ]
},
"mbql.clause.does-not-contain" : { },
"mbql.clause.domain" : {
"type" : "array",
"prefixItems" : [ {
"const" : "domain"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.during" : {
"type" : "array",
"prefixItems" : [ {
"const" : "during"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
}, {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.literal..string.date"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal..string.datetime"
} ]
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.date-time.interval"
} ]
},
"mbql.clause.ends-with" : { },
"mbql.clause.exp" : {
"type" : "array",
"prefixItems" : [ {
"const" : "exp"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.expression" : {
"type" : "array",
"prefixItems" : [ {
"const" : "expression"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.ref..expression.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
} ]
},
"mbql.clause.field" : {
"allOf" : [ {
"type" : "array",
"prefixItems" : [ {
"const" : "field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.ref..field.options"
}, {
"anyOf" : [ {
"type" : "string"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
} ]
} ]
}, {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.ref..field.id"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.ref..field.literal"
} ]
} ]
},
"mbql.clause.float" : {
"type" : "array",
"prefixItems" : [ {
"const" : "float"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.floor" : {
"type" : "array",
"prefixItems" : [ {
"const" : "floor"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.get-day" : {
"type" : "array",
"prefixItems" : [ {
"const" : "get-day"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
} ]
},
"mbql.clause.get-day-of-week" : { },
"mbql.clause.get-hour" : {
"type" : "array",
"prefixItems" : [ {
"const" : "get-hour"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
} ]
},
"mbql.clause.get-minute" : {
"type" : "array",
"prefixItems" : [ {
"const" : "get-minute"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
} ]
},
"mbql.clause.get-month" : {
"type" : "array",
"prefixItems" : [ {
"const" : "get-month"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
} ]
},
"mbql.clause.get-quarter" : {
"type" : "array",
"prefixItems" : [ {
"const" : "get-quarter"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
} ]
},
"mbql.clause.get-second" : {
"type" : "array",
"prefixItems" : [ {
"const" : "get-second"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
} ]
},
"mbql.clause.get-week" : { },
"mbql.clause.get-year" : {
"type" : "array",
"prefixItems" : [ {
"const" : "get-year"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
} ]
},
"mbql.clause.host" : {
"type" : "array",
"prefixItems" : [ {
"const" : "host"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.if" : { },
"mbql.clause.in" : { },
"mbql.clause.inside" : {
"type" : "array",
"prefixItems" : [ {
"const" : "inside"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
"mbql.clause.integer" : {
"type" : "array",
"prefixItems" : [ {
"const" : "integer"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
} ]
},
"mbql.clause.interval" : {
"type" : "array",
"prefixItems" : [ {
"const" : "interval"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"type" : "integer"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.date-time.interval"
} ]
},
"mbql.clause.is-empty" : {
"type" : "array",
"prefixItems" : [ {
"const" : "is-empty"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
} ]
},
"mbql.clause.is-null" : {
"type" : "array",
"prefixItems" : [ {
"const" : "is-null"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
} ]
},
"mbql.clause.length" : {
"type" : "array",
"prefixItems" : [ {
"const" : "length"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.log" : {
"type" : "array",
"prefixItems" : [ {
"const" : "log"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.lower" : {
"type" : "array",
"prefixItems" : [ {
"const" : "lower"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.ltrim" : {
"type" : "array",
"prefixItems" : [ {
"const" : "ltrim"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.max" : {
"type" : "array",
"prefixItems" : [ {
"const" : "max"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
"mbql.clause.measure" : {
"type" : "array",
"prefixItems" : [ {
"const" : "measure"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.measure"
} ]
},
"mbql.clause.median" : {
"type" : "array",
"prefixItems" : [ {
"const" : "median"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.metric" : {
"type" : "array",
"prefixItems" : [ {
"const" : "metric"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
} ]
},
"mbql.clause.min" : {
"type" : "array",
"prefixItems" : [ {
"const" : "min"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.orderable"
} ]
},
"mbql.clause.month-name" : {
"type" : "array",
"prefixItems" : [ {
"const" : "month-name"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.integer"
} ]
},
"mbql.clause.not" : {
"type" : "array",
"prefixItems" : [ {
"const" : "not"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
} ]
},
"mbql.clause.not-empty" : {
"type" : "array",
"prefixItems" : [ {
"const" : "not-empty"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
} ]
},
"mbql.clause.not-in" : { },
"mbql.clause.not-null" : {
"type" : "array",
"prefixItems" : [ {
"const" : "not-null"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
} ]
},
"mbql.clause.now" : {
"type" : "array",
"prefixItems" : [ {
"const" : "now"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
} ]
},
"mbql.clause.offset" : {
"type" : "array",
"prefixItems" : [ {
"const" : "offset"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.window..offset.n"
} ]
},
"mbql.clause.or" : { },
"mbql.clause.path" : {
"type" : "array",
"prefixItems" : [ {
"const" : "path"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.percentile" : {
"type" : "array",
"prefixItems" : [ {
"const" : "percentile"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.aggregation..percentile.percentile"
} ]
},
"mbql.clause.power" : {
"type" : "array",
"prefixItems" : [ {
"const" : "power"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.quarter-name" : {
"type" : "array",
"prefixItems" : [ {
"const" : "quarter-name"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.integer"
} ]
},
"mbql.clause.regex-match-first" : {
"type" : "array",
"prefixItems" : [ {
"const" : "regex-match-first"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.relative-datetime" : { },
"mbql.clause.relative-time-interval" : {
"type" : "array",
"prefixItems" : [ {
"const" : "relative-time-interval"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
}, {
"type" : "integer"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.date-time.interval"
}, {
"type" : "integer"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.date-time.interval"
} ]
},
"mbql.clause.replace" : {
"type" : "array",
"prefixItems" : [ {
"const" : "replace"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
}, {
"type" : "string"
}, {
"type" : "string"
} ]
},
"mbql.clause.round" : {
"type" : "array",
"prefixItems" : [ {
"const" : "round"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.rtrim" : {
"type" : "array",
"prefixItems" : [ {
"const" : "rtrim"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.segment" : {
"type" : "array",
"prefixItems" : [ {
"const" : "segment"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.segment"
} ]
} ]
},
"mbql.clause.share" : {
"type" : "array",
"prefixItems" : [ {
"const" : "share"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
} ]
},
"mbql.clause.split-part" : {
"type" : "array",
"prefixItems" : [ {
"const" : "split-part"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
}, {
"type" : "string",
"minLength" : 1
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.positive-integer-or-numeric-expression"
} ]
},
"mbql.clause.sqrt" : {
"type" : "array",
"prefixItems" : [ {
"const" : "sqrt"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.starts-with" : { },
"mbql.clause.stddev" : {
"type" : "array",
"prefixItems" : [ {
"const" : "stddev"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.subdomain" : {
"type" : "array",
"prefixItems" : [ {
"const" : "subdomain"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.substring" : { },
"mbql.clause.sum" : {
"type" : "array",
"prefixItems" : [ {
"const" : "sum"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"mbql.clause.sum-where" : {
"type" : "array",
"prefixItems" : [ {
"const" : "sum-where"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
} ]
},
"mbql.clause.temporal-extract" : { },
"mbql.clause.text" : {
"type" : "array",
"prefixItems" : [ {
"const" : "text"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
} ]
},
"mbql.clause.time" : {
"type" : "array",
"prefixItems" : [ {
"const" : "time"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.time"
}, {
"anyOf" : [ {
"const" : "default"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.time.interval"
} ]
} ]
},
"mbql.clause.time-interval" : {
"type" : "array",
"prefixItems" : [ {
"const" : "time-interval"
}, {
"default" : { },
"allOf" : [ {
"description" : "Options for `:time-interval` operator. Note that `:relative-time-interval` does not support these options.",
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"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"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"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/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"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/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"required" : [ "lib/uuid" ],
"additionalProperties" : false
}, { } ]
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal"
}, {
"oneOf" : [ {
"type" : "string",
"enum" : [ "current", "last", "next" ]
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.integer"
} ]
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.date-time.interval"
} ]
},
"mbql.clause.today" : {
"type" : "array",
"prefixItems" : [ {
"const" : "today"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
} ]
},
"mbql.clause.trim" : {
"type" : "array",
"prefixItems" : [ {
"const" : "trim"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.upper" : {
"type" : "array",
"prefixItems" : [ {
"const" : "upper"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
} ]
},
"mbql.clause.value" : {
"type" : "array",
"prefixItems" : [ {
"const" : "value"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal..value.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal..value.value"
} ]
},
"mbql.clause.var" : {
"type" : "array",
"prefixItems" : [ {
"const" : "var"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
"metabase-enterprise.action-v2.api.action-value-map" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ]
},
"metabase-enterprise.action-v2.api.api-action-expression" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ]
},
"metabase-enterprise.action-v2.api.api-action-id" : {
"description" : "Primitive actions, saved actions, and packed encodings from the picker.",
"anyOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "string"
} ]
},
"metabase-enterprise.action-v2.api.api-action-id-or-expression" : {
"description" : "All the various ways of referring to an action with the v2 APIs.",
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-expression"
} ]
},
"metabase-enterprise.action-v2.execute-form.action-description" : {
"type" : "object",
"properties" : {
"parameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.execute-form.describe-param"
}
},
"title" : {
"type" : "string"
}
},
"required" : [ "title", "parameters" ],
"additionalProperties" : false
},
"metabase-enterprise.action-v2.execute-form.describe-param" : {
"type" : "object",
"properties" : {
"readonly" : {
"type" : "boolean"
},
"database_default" : { },
"optional" : {
"type" : "boolean"
},
"id" : {
"type" : "string"
},
"value_options" : {
"type" : "array",
"items" : { }
},
"input_type" : {
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.execute-form.input-type"
},
"value" : { },
"semantic_type" : {
"type" : "string"
},
"human_readable_field_id" : {
"type" : "integer",
"minimum" : 1
},
"display_name" : {
"type" : "string"
},
"nullable" : {
"type" : "boolean"
},
"field_id" : {
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "id", "display_name", "input_type", "optional", "readonly" ]
},
"metabase-enterprise.action-v2.execute-form.input-type" : {
"type" : "string",
"enum" : [ "boolean", "date", "datetime", "dropdown", "float", "integer", "text", "textarea", "time" ]
},
"metabase-enterprise.data-complexity-score.api.node" : {
"anyOf" : [ {
"type" : "object",
"properties" : {
"error" : {
"type" : "string"
}
},
"required" : [ "error" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"measurement" : {
"type" : "number"
},
"rating" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "low", "medium", "high" ]
}, {
"type" : "null"
} ]
},
"rating_label" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"score" : {
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "measurement", "score", "rating", "rating_label" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"components" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase-enterprise.data-complexity-score.api.node"
}
},
"rating" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "low", "medium", "high" ]
}, {
"type" : "null"
} ]
},
"rating_label" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"score" : {
"oneOf" : [ {
"type" : "integer",
"minimum" : 0
}, {
"type" : "null"
} ]
}
},
"required" : [ "score", "rating", "rating_label", "components" ],
"additionalProperties" : false
} ]
},
"metabase-enterprise.data-studio.api.table.publish-table-selectors" : {
"type" : "object",
"properties" : {
"collection_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"database_ids" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"schema_ids" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"table_ids" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
}
},
"required" : [ "collection_id" ],
"additionalProperties" : false
},
"metabase-enterprise.data-studio.api.table.publish-tables-response" : {
"description" : "Schema for /publish-tables endpoint response. Matches frontend PublishTablesResponse type.",
"type" : "object",
"properties" : {
"target_collection" : {
"oneOf" : [ {
"description" : "value must be an instance of :model/Collection"
}, {
"type" : "null"
} ]
}
},
"required" : [ "target_collection" ]
},
"metabase-enterprise.data-studio.api.table.table-selectors" : {
"type" : "object",
"properties" : {
"database_ids" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"schema_ids" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"table_ids" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
}
},
"additionalProperties" : false
},
"metabase-enterprise.dependencies.api.action-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"collection" : { },
"creator" : { },
"name" : { },
"collection_id" : { },
"type" : { },
"created_at" : { },
"model_id" : { },
"parameters" : { },
"creator_id" : { },
"description" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "action"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.base-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : { }
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.broken-dependent-entity" : {
"description" : "Entity returned by /graph/broken endpoint - includes errors but no dependents_count.",
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : { }
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string"
}
},
"required" : [ "id", "type", "data" ]
},
"metabase-enterprise.dependencies.api.card-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"dashboard" : { },
"last-edit-info" : { },
"view_count" : { },
"collection" : { },
"document" : { },
"creator" : { },
"name" : { },
"database_id" : { },
"document_id" : { },
"result_metadata" : { },
"query_type" : { },
"collection_id" : { },
"type" : { },
"created_at" : { },
"display" : { },
"creator_id" : { },
"description" : { },
"dashboard_id" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "card"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.dashboard-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"last-edit-info" : { },
"view_count" : { },
"collection" : { },
"moderation_reviews" : { },
"creator" : { },
"name" : { },
"collection_id" : { },
"created_at" : { },
"creator_id" : { },
"description" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "dashboard"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.data-app-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"created_at" : { },
"description" : { },
"display_name" : { },
"name" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "data-app"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.dependent-error" : {
"description" : "One entry of `::base-entity`'s `:dependents_errors`: either the slim `{:type :detail}` shape\n [[normalize-finding-error]] produces for an entity's own errors (`node-errors`), or the raw AnalysisFindingError row\n `node-downstream-errors` keeps so callers can tell which downstream entity each error belongs to.",
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.normalized-finding-error"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
} ]
},
"metabase-enterprise.dependencies.api.document-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"collection" : { },
"collection_id" : { },
"created_at" : { },
"creator" : { },
"description" : { },
"name" : { },
"view_count" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "document"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.entity" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.table-entity"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-entity"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.snippet-entity"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-entity"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dashboard-entity"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.document-entity"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.sandbox-entity"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.segment-entity"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.measure-entity"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.action-entity"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.data-app-entity"
} ]
},
"metabase-enterprise.dependencies.api.graph-response" : {
"type" : "object",
"properties" : {
"edges" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"from_entity_id" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
},
"from_entity_type" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
},
"to_entity_id" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
},
"to_entity_type" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
}
},
"required" : [ "from_entity_type", "from_entity_id", "to_entity_type", "to_entity_id" ]
}
},
"nodes" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
}
}
},
"required" : [ "nodes", "edges" ]
},
"metabase-enterprise.dependencies.api.measure-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"created_at" : { },
"creator" : { },
"creator_id" : { },
"description" : { },
"name" : { },
"table" : { },
"table_id" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "measure"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.normalized-finding-error" : {
"description" : "The slim `{:type :detail}` shape [[normalize-finding-error]] produces from an AnalysisFindingError.",
"type" : "object",
"properties" : {
"detail" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.validate.validate-error-type"
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase-enterprise.dependencies.api.sandbox-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"table" : { },
"table_id" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "sandbox"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.segment-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"dashboard" : { },
"last-edit-info" : { },
"view_count" : { },
"collection" : { },
"document" : { },
"creator" : { },
"name" : { },
"database_id" : { },
"document_id" : { },
"result_metadata" : { },
"query_type" : { },
"collection_id" : { },
"type" : { },
"created_at" : { },
"display" : { },
"creator_id" : { },
"description" : { },
"dashboard_id" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "segment"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.snippet-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"collection" : { },
"collection_id" : { },
"created_at" : { },
"creator" : { },
"creator_id" : { },
"description" : { },
"name" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "snippet"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.table-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"owner" : { },
"schema" : { },
"transform" : { },
"owner_email" : { },
"owner_user_id" : { },
"name" : { },
"display_name" : { },
"fields" : { },
"db" : { },
"db_id" : { },
"description" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "table"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.transform-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"creator" : { },
"description" : { },
"last_run" : { },
"name" : { },
"owner" : { },
"owner_email" : { },
"owner_user_id" : { },
"table" : { }
}
},
"dependents_count" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
"dependents_errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "transform"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
"metabase-enterprise.dependencies.api.usages" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
}
},
"metabase-enterprise.dependencies.dependency-types.dependency-types" : {
"type" : "string",
"enum" : [ "transform", "table", "snippet", "dashboard", "sandbox", "measure", "card", "document", "segment", "action", "data-app" ]
},
"metabase-enterprise.dependencies.dependency-types.entity-id" : {
"type" : "integer",
"minimum" : 1
},
"metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error" : {
"description" : "Schema for an AnalysisFindingError record.",
"type" : "object",
"properties" : {
"analyzed_entity_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"analyzed_entity_type" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
},
"error_detail" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"error_type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.validate.validate-error-type"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"source_entity_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"source_entity_type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.validate.source-entity-type"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "analyzed_entity_type", "analyzed_entity_id", "error_type" ],
"additionalProperties" : false
},
"metabase-enterprise.erd.impl.erd-edge" : {
"type" : "object",
"properties" : {
"relationship" : {
"type" : "string",
"enum" : [ "one-to-one", "many-to-one" ]
},
"source_field_id" : {
"type" : "integer"
},
"source_table_id" : {
"type" : "integer"
},
"target_field_id" : {
"type" : "integer"
},
"target_table_id" : {
"type" : "integer"
}
},
"required" : [ "source_table_id", "source_field_id", "target_table_id", "target_field_id", "relationship" ]
},
"metabase-enterprise.erd.impl.erd-field" : {
"type" : "object",
"properties" : {
"base_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"semantic_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"fk_target_table_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"display_name" : {
"type" : "string"
},
"effective_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"database_type" : {
"type" : "string"
},
"fk_target_field_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "display_name", "database_type" ]
},
"metabase-enterprise.erd.impl.erd-node" : {
"type" : "object",
"properties" : {
"owner" : {
"$ref" : "#/components/schemas/metabase-enterprise.erd.impl.erd-owner"
},
"visibility_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"table_id" : {
"type" : "integer"
},
"display_name" : {
"type" : "string"
},
"fields" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.erd.impl.erd-field"
}
},
"db_id" : {
"type" : "integer"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "table_id", "name", "display_name", "db_id", "fields" ]
},
"metabase-enterprise.erd.impl.erd-owner" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"email" : {
"type" : "string"
},
"first_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"type" : "integer"
},
"last_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "email" ]
}, {
"type" : "null"
} ]
},
"metabase-enterprise.erd.impl.erd-request" : {
"type" : "object",
"properties" : {
"database-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"table-ids" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
}, {
"type" : "null"
} ]
}
},
"required" : [ "database-id" ],
"additionalProperties" : false
},
"metabase-enterprise.erd.impl.erd-response" : {
"type" : "object",
"properties" : {
"edges" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.erd.impl.erd-edge"
}
},
"nodes" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.erd.impl.erd-node"
}
}
},
"required" : [ "nodes", "edges" ]
},
"metabase-enterprise.permission-debug.impl.group-id" : {
"type" : "integer"
},
"metabase-enterprise.permission-debug.impl.perm-debug-info" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"blocked-tables" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
},
"download-limited-tables" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
},
"download-no-tables" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}
},
"additionalProperties" : false
},
"decision" : {
"type" : "string",
"enum" : [ "allow", "denied", "limited" ]
},
"message" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"model-id" : {
"type" : "string"
},
"model-type" : {
"type" : "string",
"enum" : [ "card", "invalid" ]
},
"segment" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "sandboxed", "impersonated", "routed" ]
},
"uniqueItems" : true
},
"suggestions" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"required" : [ "model-type", "model-id", "decision", "segment", "message", "data", "suggestions" ],
"additionalProperties" : false
},
"metabase-enterprise.replacement.schema.check-replace-source-response" : {
"type" : "object",
"properties" : {
"column_mappings" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column-mapping"
}
},
"errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.error-type"
}
},
"success" : {
"type" : "boolean"
}
},
"required" : [ "success" ]
},
"metabase-enterprise.replacement.schema.column" : {
"type" : "object",
"properties" : {
"base_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display_name" : {
"type" : "string"
},
"effective_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"semantic_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "display_name", "base_type", "effective_type", "semantic_type" ]
},
"metabase-enterprise.replacement.schema.column-mapping" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.source-swap.schema.column-error"
}
},
"source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column"
}, {
"type" : "null"
} ]
},
"target" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column"
}, {
"type" : "null"
} ]
}
}
},
"metabase-enterprise.replacement.schema.error-type" : {
"type" : "string",
"enum" : [ "cycle-detected", "database-mismatch", "incompatible-implicit-joins", "affects-gtap-policies" ]
},
"metabase-enterprise.replacement.schema.run" : {
"type" : "object",
"properties" : {
"message" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"target_entity_id" : {
"$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
},
"user_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"progress" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"target_entity_type" : {
"$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
},
"is_active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
},
"source_entity_type" : {
"$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-status"
},
"source_entity_id" : {
"$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
},
"end_time" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"start_time" : {
"type" : "string",
"format" : "date-time"
}
},
"required" : [ "id", "status", "is_active", "source_entity_type", "source_entity_id", "target_entity_type", "target_entity_id", "progress", "message", "user_id", "start_time", "end_time" ]
},
"metabase-enterprise.replacement.schema.run-id" : {
"type" : "integer",
"minimum" : 1
},
"metabase-enterprise.replacement.schema.run-status" : {
"type" : "string",
"enum" : [ "pending", "started", "succeeded", "failed", "canceled", "timeout" ]
},
"metabase-enterprise.replacement.schema.source-entity-id" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
} ]
},
"metabase-enterprise.replacement.schema.source-entity-type" : {
"type" : "string",
"enum" : [ "card", "table", "transform" ]
},
"metabase-enterprise.sandbox.schema.attribute-remappings" : {
"description" : "value must be a valid attribute remappings map (attribute name -> remapped name)",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"anyOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
} ]
}
}, {
"type" : "null"
} ]
},
"metabase-enterprise.scim.v2.api.patch-value" : {
"description" : "A single attribute value in a PATCH operation. The strings clients send for booleans are parsed by the handler.",
"anyOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "boolean"
} ]
},
"metabase-enterprise.session-management.api.EndedOnlyCriterion" : { },
"metabase-enterprise.session-management.api.FilterParams" : {
"description" : "The criteria the list and the revoke share: every one of them can match a live session.",
"type" : "object",
"properties" : {
"last-active-before" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"provider" : {
"allOf" : [ {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "password", "ldap", "google", "slack-connect", "custom-oidc", "jwt", "saml", "support-access-grant", "unknown" ]
}
}, {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "password", "ldap", "google", "slack-connect", "custom-oidc", "jwt", "saml", "support-access-grant", "unknown" ]
},
"maxItems" : 9
} ]
},
"ids" : {
"allOf" : [ {
"type" : "array",
"items" : {
"type" : "string"
}
}, {
"type" : "array",
"items" : {
"type" : "string"
},
"maxItems" : 1000
} ]
},
"tenancy" : {
"default" : "all",
"type" : "string",
"enum" : [ "all", "internal", "external" ]
},
"user-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"last-active-after" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"type" : {
"$ref" : "#/components/schemas/metabase-enterprise.session-management.schema.session-type"
},
"created-after" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"created-before" : {
"description" : "value must be a valid date string",
"type" : "string"
}
},
"required" : [ ],
"additionalProperties" : false
},
"metabase-enterprise.session-management.api.ListParams" : {
"description" : "The criteria the list and the revoke share: every one of them can match a live session.",
"type" : "object",
"properties" : {
"last-active-before" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"query" : {
"type" : "string",
"minLength" : 1
},
"ended-after" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"provider" : {
"allOf" : [ {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "password", "ldap", "google", "slack-connect", "custom-oidc", "jwt", "saml", "support-access-grant", "unknown" ]
}
}, {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "password", "ldap", "google", "slack-connect", "custom-oidc", "jwt", "saml", "support-access-grant", "unknown" ]
},
"maxItems" : 9
} ]
},
"ids" : {
"allOf" : [ {
"type" : "array",
"items" : {
"type" : "string"
}
}, {
"type" : "array",
"items" : {
"type" : "string"
},
"maxItems" : 1000
} ]
},
"tenancy" : {
"default" : "all",
"type" : "string",
"enum" : [ "all", "internal", "external" ]
},
"sort-direction" : {
"default" : "desc",
"type" : "string",
"enum" : [ "asc", "desc" ]
},
"status" : {
"default" : "live",
"$ref" : "#/components/schemas/metabase-enterprise.session-management.schema.session-status"
},
"user-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"last-active-after" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"type" : {
"$ref" : "#/components/schemas/metabase-enterprise.session-management.schema.session-type"
},
"reason" : {
"$ref" : "#/components/schemas/metabase.session.schema.end-reason"
},
"ended-before" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"created-after" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"sort-column" : {
"default" : "created_at",
"$ref" : "#/components/schemas/metabase-enterprise.session-management.schema.session-sort-column"
},
"created-before" : {
"description" : "value must be a valid date string",
"type" : "string"
}
},
"required" : [ ],
"additionalProperties" : false
},
"metabase-enterprise.session-management.api.RevokeByCriteriaParams" : {
"description" : "The criteria the list and the revoke share: every one of them can match a live session.",
"type" : "object",
"properties" : {
"last-active-before" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"query" : { },
"ended-after" : {
"$ref" : "#/components/schemas/metabase-enterprise.session-management.api.EndedOnlyCriterion"
},
"provider" : {
"allOf" : [ {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "password", "ldap", "google", "slack-connect", "custom-oidc", "jwt", "saml", "support-access-grant", "unknown" ]
}
}, {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "password", "ldap", "google", "slack-connect", "custom-oidc", "jwt", "saml", "support-access-grant", "unknown" ]
},
"maxItems" : 9
} ]
},
"ids" : {
"type" : "array",
"items" : {
"type" : "string"
},
"maxItems" : 1000
},
"tenancy" : {
"default" : "all",
"type" : "string",
"enum" : [ "all", "internal", "external" ]
},
"status" : {
"type" : "string",
"enum" : [ "live" ]
},
"user-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"last-active-after" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"type" : {
"$ref" : "#/components/schemas/metabase-enterprise.session-management.schema.session-type"
},
"reason" : {
"$ref" : "#/components/schemas/metabase-enterprise.session-management.api.EndedOnlyCriterion"
},
"exclude-current" : {
"default" : true,
"type" : "boolean"
},
"ended-before" : {
"$ref" : "#/components/schemas/metabase-enterprise.session-management.api.EndedOnlyCriterion"
},
"created-after" : {
"description" : "value must be a valid date string",
"type" : "string"
},
"created-before" : {
"description" : "value must be a valid date string",
"type" : "string"
}
},
"required" : [ ],
"additionalProperties" : false
},
"metabase-enterprise.session-management.api.RevokeByCriteriaResult" : {
"type" : "object",
"properties" : {
"remaining" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
},
"revoked" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
},
"user_ids" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
}
},
"required" : [ "revoked", "remaining", "user_ids" ],
"additionalProperties" : false
},
"metabase-enterprise.session-management.api.Session" : {
"type" : "object",
"properties" : {
"end_reason" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.session.schema.end-reason"
}, {
"type" : "null"
} ]
},
"last_active_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"user" : {
"type" : "object",
"properties" : {
"common_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"email" : {
"type" : "string"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "id", "email", "common_name" ],
"additionalProperties" : false
},
"device_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"type" : "string"
},
"expires_at" : {
"type" : "string",
"format" : "date-time"
},
"provider" : {
"type" : "string"
},
"ended_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"status" : {
"type" : "string",
"enum" : [ "live", "ended" ]
},
"ended_by" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"current" : {
"type" : "boolean"
},
"type" : {
"$ref" : "#/components/schemas/metabase-enterprise.session-management.schema.session-type"
},
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"device_description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"ip_address" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"user_agent" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "user", "type", "provider", "created_at", "last_active_at", "expires_at", "user_agent", "device_description", "ip_address", "device_id", "current", "status", "ended_at", "end_reason", "ended_by" ],
"additionalProperties" : false
},
"metabase-enterprise.session-management.api.SessionsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.session-management.api.Session"
}
},
"limit" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"offset" : {
"oneOf" : [ {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}, {
"type" : "null"
} ]
},
"total" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "total", "limit", "offset", "data" ],
"additionalProperties" : false
},
"metabase-enterprise.session-management.api.SortParams" : {
"type" : "object",
"properties" : {
"sort-column" : {
"default" : "created_at",
"$ref" : "#/components/schemas/metabase-enterprise.session-management.schema.session-sort-column"
},
"sort-direction" : {
"default" : "desc",
"type" : "string",
"enum" : [ "asc", "desc" ]
}
},
"required" : [ ],
"additionalProperties" : false
},
"metabase-enterprise.session-management.schema.session-sort-column" : {
"description" : "Columns the session list can be sorted by. `:last_active_at` sorts on the same\n `COALESCE(last_active_at, created_at)` the idle-timeout predicate uses, so a session that has never been touched\n sorts by when it was created rather than last. `:ended_at` is null for a live session, and for an ended one whose\n ending the nightly sweep has not recorded yet.",
"type" : "string",
"enum" : [ "created_at", "last_active_at", "user_email", "provider", "ended_at" ]
},
"metabase-enterprise.session-management.schema.session-status" : {
"description" : "Which sessions a query is about: the `live` ones (the default), the `ended` ones, or `all` of them.",
"type" : "string",
"enum" : [ "live", "ended", "all" ]
},
"metabase-enterprise.session-management.schema.session-type" : {
"description" : "How a session was created: an ordinary login, or a full-app embedding one. Derived from whether the `core_session`\n row carries an anti-CSRF token, which only full-app-embed sessions do.",
"type" : "string",
"enum" : [ "normal", "full-app-embed" ]
},
"metabase-enterprise.support-access-grants.schema.create-grant-request" : {
"description" : "Schema for POST /api/ee/support-access-grants request body.",
"type" : "object",
"properties" : {
"grant_duration_minutes" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 10080
},
"notes" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1,
"maxLength" : 255
}, {
"type" : "null"
} ]
},
"ticket_number" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1,
"maxLength" : 100
}, {
"type" : "null"
} ]
}
},
"required" : [ "grant_duration_minutes" ],
"additionalProperties" : false
},
"metabase-enterprise.support-access-grants.schema.current-grant-response" : {
"description" : "Schema for GET /api/ee/support-access-grants/current response.",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
}, {
"type" : "null"
} ]
},
"metabase-enterprise.support-access-grants.schema.grant-response" : {
"description" : "Schema for a support access grant object in API responses.",
"type" : "object",
"properties" : {
"user_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"token" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"user_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"user_email" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"grant_end_timestamp" : {
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
},
"revoked_at" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
}, {
"type" : "null"
} ]
},
"revoked_by_user_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"ticket_number" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"updated_at" : {
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
},
"created_at" : {
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
},
"notes" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"grant_start_timestamp" : {
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
}
},
"required" : [ "id", "user_id", "user_name", "user_email", "ticket_number", "notes", "grant_start_timestamp", "grant_end_timestamp", "revoked_at", "revoked_by_user_id", "created_at", "updated_at" ],
"additionalProperties" : false
},
"metabase-enterprise.support-access-grants.schema.list-grants-response" : {
"description" : "Schema for GET /api/ee/support-access-grants response (paginated list).",
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
}
},
"limit" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"offset" : {
"type" : "integer",
"minimum" : 0
},
"total" : {
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "data", "total", "limit", "offset" ]
},
"metabase-enterprise.support-access-grants.schema.timestamp" : {
"anyOf" : [ { }, { } ]
},
"metabase-enterprise.transform-testing.expectations.empty.result" : {
"description" : "What an `empty` expectation found.\n\n A pass carries nothing beyond the shared keys. A failure adds the rows the query returned as\n `:sample`, with `:columns` describing them; the sample is capped, and `:truncated` is how many\n rows that cap dropped.",
"oneOf" : [ {
"description" : "What every expectation result carries: which expectation this is, and how it came out.\n\n A `:status` of `error` means this one expectation could not be evaluated while the rest of the\n run still reported; `:error` then says why, and nothing else is reported for it.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
}
},
"error" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "message" ],
"additionalProperties" : false
},
"name" : {
"type" : "string"
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
},
"type" : {
"const" : "empty"
}
},
"required" : [ "name", "type", "status" ],
"additionalProperties" : false
}, {
"description" : "What every expectation result carries: which expectation this is, and how it came out.\n\n A `:status` of `error` means this one expectation could not be evaluated while the rest of the\n run still reported; `:error` then says why, and nothing else is reported for it.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
}
},
"error" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "message" ],
"additionalProperties" : false
},
"name" : {
"type" : "string"
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
},
"type" : {
"const" : "empty"
}
},
"required" : [ "name", "type", "status" ],
"additionalProperties" : false
}, {
"description" : "The rows the query returned, and the columns describing them.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
}
},
"error" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "message" ],
"additionalProperties" : false
},
"name" : {
"type" : "string"
},
"sample" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
}
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
},
"truncated" : {
"type" : "integer"
},
"type" : {
"const" : "empty"
}
},
"required" : [ "name", "type", "status", "columns", "sample", "truncated" ],
"additionalProperties" : false
} ]
},
"metabase-enterprise.transform-testing.expectations.equals.result" : {
"description" : "What an `equals` expectation found.\n\n Unless `:status` is `error`, every key is present on a pass as well as a failure:\n `:extra-rows`, `:missing-rows` and `:cell-mismatches` come back empty rather than missing.\n `:row-counts` sets the output's row count against the number of rows the expectation declared.\n `:cell-mismatches` is filled only when exactly one row is missing and exactly one is extra.\n `:extra-rows` and `:missing-rows` are capped; `:truncated` is how many rows that cap dropped.",
"oneOf" : [ {
"description" : "What every expectation result carries: which expectation this is, and how it came out.\n\n A `:status` of `error` means this one expectation could not be evaluated while the rest of the\n run still reported; `:error` then says why, and nothing else is reported for it.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
}
},
"error" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "message" ],
"additionalProperties" : false
},
"name" : {
"type" : "string"
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
},
"type" : {
"const" : "equals"
}
},
"required" : [ "name", "type", "status" ],
"additionalProperties" : false
}, {
"description" : "The comparison's findings, reported in full on a pass as well as a failure.",
"type" : "object",
"properties" : {
"truncated" : {
"type" : "integer"
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
}
},
"error" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "message" ],
"additionalProperties" : false
},
"name" : {
"type" : "string"
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
},
"extra-rows" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
}
},
"type" : {
"const" : "equals"
},
"missing-rows" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
}
},
"cell-mismatches" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"actual" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "boolean"
}, {
"type" : "number"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"column" : {
"type" : "string"
},
"expected" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "boolean"
}, {
"type" : "number"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "column", "expected", "actual" ],
"additionalProperties" : false
}
},
"row-counts" : {
"type" : "object",
"properties" : {
"actual" : {
"type" : "integer"
},
"expected" : {
"type" : "integer"
}
},
"required" : [ "actual", "expected" ],
"additionalProperties" : false
}
},
"required" : [ "name", "type", "status", "columns", "row-counts", "extra-rows", "missing-rows", "cell-mismatches", "truncated" ],
"additionalProperties" : false
}, {
"description" : "The comparison's findings, reported in full on a pass as well as a failure.",
"type" : "object",
"properties" : {
"truncated" : {
"type" : "integer"
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
}
},
"error" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "message" ],
"additionalProperties" : false
},
"name" : {
"type" : "string"
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
},
"extra-rows" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
}
},
"type" : {
"const" : "equals"
},
"missing-rows" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
}
},
"cell-mismatches" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"actual" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "boolean"
}, {
"type" : "number"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"column" : {
"type" : "string"
},
"expected" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "boolean"
}, {
"type" : "number"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "column", "expected", "actual" ],
"additionalProperties" : false
}
},
"row-counts" : {
"type" : "object",
"properties" : {
"actual" : {
"type" : "integer"
},
"expected" : {
"type" : "integer"
}
},
"required" : [ "actual", "expected" ],
"additionalProperties" : false
}
},
"required" : [ "name", "type", "status", "columns", "row-counts", "extra-rows", "missing-rows", "cell-mismatches", "truncated" ],
"additionalProperties" : false
} ]
},
"metabase-enterprise.transform-testing.schema..expectation-result.base" : {
"description" : "What every expectation result carries: which expectation this is, and how it came out.\n\n A `:status` of `error` means this one expectation could not be evaluated while the rest of the\n run still reported; `:error` then says why, and nothing else is reported for it.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.result-column"
}
},
"error" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "message" ],
"additionalProperties" : false
},
"name" : {
"type" : "string"
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
},
"type" : {
"type" : "string"
}
},
"required" : [ "name", "type", "status" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema..expectation.empty" : {
"description" : "A check that a SQL query over the transform output returns no rows.",
"type" : "object",
"properties" : {
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"sql" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"type" : {
"const" : "empty"
}
},
"required" : [ "type", "name", "sql" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema..expectation.equals" : {
"description" : "A check that the transform output holds exactly the declared rows, over exactly the declared columns.",
"oneOf" : [ {
"description" : "Test data returned by a SQL query run against the transform's source database.",
"type" : "object",
"properties" : {
"format" : {
"const" : "sql"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"sql" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"type" : {
"const" : "equals"
}
},
"required" : [ "type", "name", "format", "sql" ],
"additionalProperties" : false
}, {
"description" : "Test data written out in the request: the columns, with the type each is cast to, and the rows.\n\n A row's keys are the declared column names, exactly: the query reads each row by those names, so a key that names\n no column would be dropped and a column a row leaves out would become a null cell, neither of which the author\n asked for.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.column"
},
"minItems" : 1
},
"format" : {
"const" : "rows"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
}
},
"type" : {
"const" : "equals"
}
},
"required" : [ "type", "name", "format", "columns", "rows" ],
"additionalProperties" : false
} ]
},
"metabase-enterprise.transform-testing.schema..transform-test-run.response" : {
"description" : "A persisted execution of a transform test.",
"type" : "object",
"properties" : {
"end_time" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"initiated_by" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"initiated_by_user" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.user"
}, {
"type" : "null"
} ]
},
"last_heartbeat" : {
"type" : "string",
"format" : "date-time"
},
"start_time" : {
"type" : "string",
"format" : "date-time"
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.run-status"
},
"transform_test_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "transform_test_id", "initiated_by", "start_time", "end_time", "status", "last_heartbeat", "initiated_by_user" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema..transform-test-runs.response" : {
"description" : "A page of transform test runs.",
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema..transform-test-run.response"
}
},
"limit" : {
"type" : "integer",
"minimum" : 1
},
"offset" : {
"type" : "integer"
},
"total" : {
"type" : "integer"
}
},
"required" : [ "data", "limit", "offset", "total" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema..transform-test.create" : {
"description" : "What a client sends to create a transform test.",
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"expectations" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectations"
},
"inputs" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.inputs"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"transform_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
}
},
"required" : [ "transform_id", "name", "inputs", "expectations" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema..transform-test.response" : {
"description" : "A saved transform test: the transform it covers, the inputs that stand in for its source\n tables, and the expectations checked against its output.",
"type" : "object",
"properties" : {
"entity_id" : {
"type" : "string"
},
"last_run" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.transform-test-run"
}, {
"type" : "null"
} ]
},
"expectations" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectations"
},
"transform_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
},
"updated_at" : {
"type" : "string",
"format" : "date-time"
},
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"inputs" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.inputs"
},
"creator_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "entity_id", "transform_id", "creator_id", "name", "description", "inputs", "expectations", "created_at", "updated_at", "last_run" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema..transform-test.update" : {
"description" : "What a client sends to update a transform test. Omitted fields are left unchanged.",
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"expectations" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectations"
},
"inputs" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.inputs"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"transform_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
}
},
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema.column" : {
"description" : "A column of inline test data, with the type its cells are cast to.\n\n A cast target, which on some engines is not a type name the warehouse ever reports: MySQL takes\n `SIGNED` and reports `BIGINT`.",
"type" : "object",
"properties" : {
"cast_type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "name", "cast_type" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema.expectation" : {
"description" : "A check on the output of the transform under test.",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema..expectation.equals"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema..expectation.empty"
} ]
},
"metabase-enterprise.transform-testing.schema.expectation-result" : {
"description" : "What one expectation found. Each type owns the schema of its own result, registered under the key\n named here.",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.expectations.equals.result"
}, {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.expectations.empty.result"
} ]
},
"metabase-enterprise.transform-testing.schema.expectations" : {
"description" : "The checks run against the transform's output. Names must be unique within a test,\n case-sensitively.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectation"
}
},
"metabase-enterprise.transform-testing.schema.input" : {
"description" : "An input table of the transform under test, replaced with test data.",
"oneOf" : [ {
"description" : "Test data returned by a SQL query run against the transform's source database.",
"type" : "object",
"properties" : {
"format" : {
"const" : "sql"
},
"sql" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"table" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.table"
}
},
"required" : [ "table", "format", "sql" ],
"additionalProperties" : false
}, {
"description" : "Test data written out in the request: the columns, with the type each is cast to, and the rows.\n\n A row's keys are the declared column names, exactly: the query reads each row by those names, so a key that names\n no column would be dropped and a column a row leaves out would become a null cell, neither of which the author\n asked for.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.column"
},
"minItems" : 1
},
"format" : {
"const" : "rows"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
}
},
"table" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.table"
}
},
"required" : [ "table", "format", "columns", "rows" ],
"additionalProperties" : false
} ]
},
"metabase-enterprise.transform-testing.schema.inputs" : {
"description" : "Test data for the tables the transform reads. Every table it reads needs one, and an input for\n a table it does not read is refused.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.input"
}
},
"metabase-enterprise.transform-testing.schema.result-column" : {
"description" : "A column reported by a test run, with its database native type.",
"type" : "object",
"properties" : {
"database_type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "name", "database_type" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema.row" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "boolean"
}, {
"type" : "number"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
}, {
"description" : "Value must be a map."
} ]
},
"metabase-enterprise.transform-testing.schema.rows-data" : {
"description" : "Test data written out in the request: the columns, with the type each is cast to, and the rows.\n\n A row's keys are the declared column names, exactly: the query reads each row by those names, so a key that names\n no column would be dropped and a column a row leaves out would become a null cell, neither of which the author\n asked for.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.column"
},
"minItems" : 1
},
"format" : {
"const" : "rows"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.row"
}
}
},
"required" : [ "format", "columns", "rows" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema.run-result" : {
"description" : "The outcome of a transform test run.\n\n `:tables` maps each temp table the run created to the table it stood in for.",
"type" : "object",
"properties" : {
"expectations" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectation-result"
}
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.status"
},
"tables" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"required" : [ "status", "expectations", "tables" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema.run-status" : {
"description" : "The persisted lifecycle state of a transform test run.",
"type" : "string",
"enum" : [ "started", "passed", "failed", "error", "timeout" ]
},
"metabase-enterprise.transform-testing.schema.sql-data" : {
"description" : "Test data returned by a SQL query run against the transform's source database.",
"type" : "object",
"properties" : {
"format" : {
"const" : "sql"
},
"sql" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "format", "sql" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema.status" : {
"description" : "The outcome of a transform test run, or of one of its expectations.\n\n `:error` is an expectation outcome only: that expectation's own query could not be run, while\n the rest of the run completed and still reported.",
"type" : "string",
"enum" : [ "passed", "failed", "error" ]
},
"metabase-enterprise.transform-testing.schema.table" : {
"description" : "A table read by the transform under test, by schema and name.",
"type" : "object",
"properties" : {
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema.transform-test" : {
"description" : "A saved transform test: the transform it covers, the inputs that stand in for its source\n tables, and the expectations checked against its output.",
"type" : "object",
"properties" : {
"entity_id" : {
"type" : "string"
},
"expectations" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.expectations"
},
"transform_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
},
"updated_at" : {
"type" : "string",
"format" : "date-time"
},
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"inputs" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.inputs"
},
"creator_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "entity_id", "transform_id", "creator_id", "name", "description", "inputs", "expectations", "created_at", "updated_at" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema.transform-test-run" : {
"description" : "A persisted execution of a transform test.",
"type" : "object",
"properties" : {
"end_time" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"initiated_by" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"last_heartbeat" : {
"type" : "string",
"format" : "date-time"
},
"start_time" : {
"type" : "string",
"format" : "date-time"
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transform-testing.schema.run-status"
},
"transform_test_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "transform_test_id", "initiated_by", "start_time", "end_time", "status", "last_heartbeat" ],
"additionalProperties" : false
},
"metabase-enterprise.transform-testing.schema.user" : {
"description" : "The user who started a run.",
"type" : "object",
"properties" : {
"common_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"email" : {
"type" : "string"
},
"first_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
},
"last_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "email", "first_name", "last_name" ],
"additionalProperties" : false
},
"metabase-enterprise.transforms-inspector.schema..lens-params.request" : {
"description" : "[[::lens-params]] as the FE echoes them back to the lens endpoints.",
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-params"
},
"metabase-enterprise.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-enterprise.transforms-inspector.schema.trigger-condition"
},
"id" : {
"type" : "string"
},
"message" : {
"type" : "string"
},
"metadata" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
},
"severity" : {
"type" : "string",
"enum" : [ "info", "warning", "error" ]
}
},
"required" : [ "id", "condition", "severity", "message" ]
},
"metabase-enterprise.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-enterprise.transforms-inspector.schema.display-type"
},
"id" : {
"type" : "string"
},
"metadata" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.card-metadata"
},
"section_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"title" : {
"type" : "string"
}
},
"required" : [ "id", "title", "display", "dataset_query" ]
},
"metabase-enterprise.transforms-inspector.schema.card-metadata" : {
"description" : "Common metadata for join-related cards and triggers.",
"type" : "object",
"properties" : {
"dedup_key" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.dedup-key"
},
"group_id" : {
"type" : "string"
},
"group_order" : {
"type" : "integer"
},
"card_type" : {
"type" : "string"
},
"group_role" : {
"$ref" : "#/components/schemas/metabase-enterprise.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-enterprise.transforms-inspector.schema.complexity" : {
"description" : "Complexity estimate for a lens.",
"type" : "object",
"properties" : {
"level" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity-level"
},
"score" : {
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "level" ]
},
"metabase-enterprise.transforms-inspector.schema.complexity-level" : {
"description" : "Estimated complexity/cost of generating a lens.",
"type" : "string",
"enum" : [ "fast", "slow", "very-slow" ]
},
"metabase-enterprise.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-enterprise.transforms-inspector.schema.discovery-response" : {
"description" : "Response from lens discovery.",
"type" : "object",
"properties" : {
"available_lenses" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-metadata"
}
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"sources" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.table"
}
},
"status" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.inspector-status"
},
"target" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.table"
}, {
"type" : "null"
} ]
},
"visited_fields" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.visited-fields"
}, {
"type" : "null"
} ]
}
},
"required" : [ "name", "status", "sources", "available_lenses" ]
},
"metabase-enterprise.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-enterprise.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-enterprise.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-enterprise.transforms-inspector.schema.trigger-condition"
},
"lens_id" : {
"type" : "string"
},
"metadata" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
},
"params" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-params"
},
"reason" : {
"type" : "string"
}
},
"required" : [ "lens_id", "condition" ]
},
"metabase-enterprise.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-enterprise.transforms-inspector.schema.field-stats"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "base_type" ],
"additionalProperties" : false
},
"metabase-enterprise.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"
}
},
"additionalProperties" : false
},
"metabase-enterprise.transforms-inspector.schema.group-role" : {
"description" : "Role of a card within a comparison group.",
"type" : "string",
"enum" : [ "input", "output" ]
},
"metabase-enterprise.transforms-inspector.schema.inspector-status" : {
"description" : "Status of the inspector result.",
"type" : "string",
"enum" : [ "not-run", "ready" ]
},
"metabase-enterprise.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-enterprise.transforms-inspector.schema.lens" : {
"description" : "Full lens contents and drill lens/alert triggers.",
"type" : "object",
"properties" : {
"complexity" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity"
},
"sections" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.section"
}
},
"id" : {
"type" : "string"
},
"summary" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-summary"
},
"alert_triggers" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.alert-trigger"
}
},
"drill_lenses" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.drill-lens"
}
},
"display_name" : {
"type" : "string"
},
"drill_lens_triggers" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.drill-lens-trigger"
}
},
"cards" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.card"
}
}
},
"required" : [ "id", "display_name", "sections", "cards" ]
},
"metabase-enterprise.transforms-inspector.schema.lens-metadata" : {
"type" : "object",
"properties" : {
"complexity" : {
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display_name" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
},
"required" : [ "id", "display_name" ]
},
"metabase-enterprise.transforms-inspector.schema.lens-params" : {
"description" : "Params passed to a drill lens, emitted on drill-lens triggers and echoed back by the FE to the lens endpoints.\n `:join_step` scopes the unmatched-rows lens to one join; it is the only param any lens takes.",
"type" : "object",
"properties" : {
"join_step" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase-enterprise.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-enterprise.transforms-inspector.schema.summary-highlight"
}
},
"text" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
}
},
"metabase-enterprise.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-enterprise.transforms-inspector.schema.layout-type"
},
"title" : {
"type" : "string"
}
},
"required" : [ "id", "title" ]
},
"metabase-enterprise.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-enterprise.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-enterprise.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" ],
"additionalProperties" : false
},
"metabase-enterprise.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-enterprise.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-enterprise.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.actions.schema..action.adhoc" : {
"description" : "Schema for an ad-hoc Action, which runs without being saved, as its create request would describe it.",
"$ref" : "#/components/schemas/metabase.actions.schema..action.create-request"
},
"metabase.actions.schema..action.create-request" : {
"description" : "Schema for the REST API body that creates an Action, without the columns the server populates.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"table_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"kind" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.actions.schema.type"
},
"model_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.actions.schema..action.parameter"
}
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"type" : "boolean"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "name", "type" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"dataset_query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.actions.schema.type"
},
"model_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.actions.schema..action.parameter"
}
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"type" : "boolean"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "name", "type" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"dataset_query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"table_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"kind" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.actions.schema.type"
},
"model_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.actions.schema..action.parameter"
}
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"type" : "boolean"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "name", "type" ],
"additionalProperties" : false
} ]
},
"metabase.actions.schema..action.parameter" : {
"description" : "parameter must be a map with :id and :type keys",
"type" : "object",
"properties" : {
"metabase.actions.models/field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"filteringParameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
}
}, {
"type" : "null"
} ]
},
"mappings" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
}
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
},
"uniqueItems" : true
} ]
}, {
"type" : "null"
} ]
},
"sectionId" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"values_source_config" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.values-source-config"
}, {
"type" : "null"
} ]
},
"hasVariableTemplateTagTarget" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
},
"position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"slug" : {
"type" : "string"
},
"value" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
},
"metabase.actions.models/pk?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"required" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"values_query_type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.values-query-type"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
},
"temporal_units" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}
}, {
"type" : "null"
} ]
},
"is-auto-increment" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"target" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
},
"values_source_type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.values-source-type"
}, {
"type" : "null"
} ]
},
"options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.options"
}, {
"type" : "null"
} ]
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
},
"isMultiSelect" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "type" ],
"additionalProperties" : false
},
"metabase.actions.schema..action.update-request" : {
"description" : "Schema for the REST API body that updates an Action, without the columns the server populates.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.actions.schema.id"
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"table_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"kind" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.actions.schema.type"
},
"model_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.actions.schema..action.parameter"
}
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"type" : "boolean"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"dataset_query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.actions.schema.id"
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.actions.schema.type"
},
"model_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.actions.schema..action.parameter"
}
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"type" : "boolean"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"dataset_query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.actions.schema.id"
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"table_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"kind" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.actions.schema.type"
},
"model_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.actions.schema..action.parameter"
}
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"type" : "boolean"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
} ]
},
"metabase.actions.schema..execute-parameter-values.string-keys" : {
"description" : "value must map parameter ids to scalar values.",
"type" : "object",
"additionalProperties" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
}
} ]
}
},
"metabase.actions.schema..implicit-action.kind" : {
"description" : "Unsupported implicit action kind",
"type" : "string",
"enum" : [ "row/create", "row/update", "row/delete" ]
},
"metabase.actions.schema.action" : {
"description" : "An Action as it should appear when we `SELECT` it from the app DB.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"collection" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.collections.schema.collection-or-root"
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.actions.schema.id"
},
"creator" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.users.schema.user"
}, {
"type" : "null"
} ]
},
"made_public_by_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"database_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"type" : "null"
} ]
},
"updated_at" : { },
"table_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"legacy_query" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"can_write" : {
"type" : "boolean"
},
"kind" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.actions.schema.type"
},
"created_at" : { },
"public_uuid" : {
"oneOf" : [ {
"description" : "value must be a valid UUID.",
"type" : "string",
"pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
}, {
"type" : "null"
} ]
},
"model_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.actions.schema..action.parameter"
}
}, {
"type" : "null"
} ]
},
"creator_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"type" : "boolean"
},
"public_uuid_prefix" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"collection" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.collections.schema.collection-or-root"
}, {
"type" : "null"
} ]
},
"dataset_query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.actions.schema.id"
},
"creator" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.users.schema.user"
}, {
"type" : "null"
} ]
},
"made_public_by_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"database_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"type" : "null"
} ]
},
"updated_at" : { },
"legacy_query" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"can_write" : {
"type" : "boolean"
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.actions.schema.type"
},
"created_at" : { },
"public_uuid" : {
"oneOf" : [ {
"description" : "value must be a valid UUID.",
"type" : "string",
"pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
}, {
"type" : "null"
} ]
},
"model_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.actions.schema..action.parameter"
}
}, {
"type" : "null"
} ]
},
"creator_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"type" : "boolean"
},
"public_uuid_prefix" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"collection" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.collections.schema.collection-or-root"
}, {
"type" : "null"
} ]
},
"dataset_query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.actions.schema.id"
},
"creator" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.users.schema.user"
}, {
"type" : "null"
} ]
},
"made_public_by_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"database_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"type" : "null"
} ]
},
"updated_at" : { },
"table_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"legacy_query" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"can_write" : {
"type" : "boolean"
},
"kind" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.actions.schema.type"
},
"created_at" : { },
"public_uuid" : {
"oneOf" : [ {
"description" : "value must be a valid UUID.",
"type" : "string",
"pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
}, {
"type" : "null"
} ]
},
"model_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.actions.schema..action.parameter"
}
}, {
"type" : "null"
} ]
},
"creator_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"type" : "boolean"
},
"public_uuid_prefix" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
} ]
},
"metabase.actions.schema.execute-parameter-values" : {
"description" : "value must map parameter ids to scalar values.",
"type" : "object",
"additionalProperties" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
}
} ]
}
},
"metabase.actions.schema.id" : {
"description" : "Valid Action ID",
"type" : "integer",
"minimum" : 1
},
"metabase.actions.schema.prefetch-parameter-values" : {
"description" : "value must be a JSON object mapping parameter ids to scalar values.",
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
}
},
"metabase.actions.schema.type" : {
"description" : "Unsupported action type",
"type" : "string",
"enum" : [ "implicit", "query" ]
},
"metabase.actions.types..scope.raw" : {
"type" : "object",
"properties" : {
"webhook-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"model-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"database-id" : {
"$ref" : "#/components/schemas/metabase.actions.types.fk-or-missing-id"
},
"dashcard-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"table-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"card-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"collection-id" : {
"$ref" : "#/components/schemas/metabase.actions.types.fk-or-missing-id"
},
"dashboard-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"unknown" : {
"type" : "string",
"enum" : [ "model-action" ]
},
"type" : {
"type" : "string"
}
},
"additionalProperties" : false
},
"metabase.actions.types.fk-or-missing-id" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.actions.types.missing-id"
}, {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
} ]
},
"metabase.actions.types.missing-id" : {
"type" : "integer",
"minimum" : -1,
"maximum" : -1
},
"metabase.agent-api.api.card-display" : {
"description" : "Display types accepted by Card. Validates LLM-passed values so a bogus\n value (e.g. `\"potato\"`) gets a 400 rather than persisting junk.",
"type" : "string",
"enum" : [ "table", "bar", "line", "pie", "scatter", "area", "row", "combo", "pivot", "scalar", "smartscalar", "gauge", "progress", "funnel", "map", "waterfall", "sankey" ]
},
"metabase.agent-api.api.column-metadata" : {
"description" : "Metadata for a single result column.",
"type" : "object",
"properties" : {
"base_type" : {
"type" : "string"
},
"display_name" : {
"type" : "string"
},
"effective_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
}
},
"required" : [ "name", "base_type", "display_name" ]
},
"metabase.agent-api.api.construct-native-query-request" : {
"description" : "Request body for /v1/construct-native-query: a target database and a raw SQL string.",
"type" : "object",
"properties" : {
"database_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"sql" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "database_id", "sql" ],
"additionalProperties" : false
},
"metabase.agent-api.api.construct-query-request" : {
"description" : "Request body for /v2/construct-query and the fresh-query branch of /v2/query.\n A single `:query` key whose value is a JSON object matching\n [[metabase.lib.schema/external-query]] — the canonical portable MBQL 5 wire format. The\n query is fully self-describing: the database is derived from the first stage's\n `source-table:` or `source-card:`, all field references are portable FKs\n (`[<db-name>, <schema>, <table-name>, <column-name>]`), and there is no auxiliary\n `source_entity` / `referenced_entities` envelope. See\n `resources/metabot/prompts/tools/construct_notebook_query.md` for the full format reference\n (including operators, joins, expressions, multi-stage queries, and FK conventions).\n\n Closed map: any extra top-level keys (notably the legacy `source_entity` /\n `referenced_entities` envelope from before the repr migration) are dropped during request\n decoding, so a caller still sending the old shape is served.\n\n The inner `:query` value is an opaque, string-keyed JSON object ([[ms/OpaqueJSONObject]]) at this boundary\n rather than `::lib.schema/external-query`. Being open matters: a closed map with no declared\n entries would have every key stripped before the handler saw it. Reasons for not naming the\n real schema:\n\n 1. Deep MBQL-shape validation runs inside the representations pipeline\n (`metabot.tools.construct/execute-representations-query` calls `repr/validate-query`\n after the repair pass), so the boundary check would be redundant.\n\n 2. The strict-tool manifest lint (`assert-optional-fields-nullable!`) walks every map\n reachable from the tool input schema. `::external-query` references `::query`, which\n carries several `:optional` keys (`:lib/metadata`, `:database`, `:settings`, …) that\n are not `[:maybe ...]` — for sound reasons unrelated to this endpoint. Recursing into\n them would force a wide schema change just to satisfy the lint at the agent boundary.",
"type" : "object",
"properties" : {
"prompt" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1,
"maxLength" : 10000
}, {
"type" : "null"
} ]
},
"query" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ]
}
},
"required" : [ "query" ],
"additionalProperties" : false
},
"metabase.agent-api.api.construct-query-response" : {
"description" : "Response containing a base64-encoded MBQL query for use with /v1/execute. The optional\n `:prompt` echoes the request's prompt back so the MCP layer can store it with the\n handle (see `metabase.mcp.tools/make-store-construct-query-result`).",
"type" : "object",
"properties" : {
"prompt" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"query" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "query" ]
},
"metabase.agent-api.api.create-collection-request" : {
"description" : "Request shape for `create_collection`. `:parent_collection_id` is named separately from\n the internal `:parent_id` field to make the LLM-facing API less ambiguous (the caller is\n saying \"put it under this parent\", not echoing back a server-set field).",
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string",
"minLength" : 1
},
"parent_collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
},
"metabase.agent-api.api.create-collection-response" : {
"description" : "Returned by `create_collection`. Exposes the materialized-path `:location` so callers\n can sanity-check nesting without a follow-up read.",
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"location" : {
"type" : "string",
"minLength" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
},
"parent_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "parent_id", "location", "description" ]
},
"metabase.agent-api.api.create-dashboard-request" : {
"type" : "object",
"properties" : {
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string",
"minLength" : 1
},
"question_ids" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
},
"metabase.agent-api.api.create-dashboard-response" : {
"type" : "object",
"properties" : {
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"collection_path" : {
"type" : "string"
},
"dashcard_ids" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
},
"tabs" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.agent-api.api.dashboard-tab"
}
},
"url" : {
"type" : "string"
}
},
"required" : [ "id", "name", "url", "collection_id", "collection_path", "description", "dashcard_ids", "tabs" ]
},
"metabase.agent-api.api.create-metric-request" : {
"type" : "object",
"properties" : {
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.agent-api.api.card-display"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string",
"minLength" : 1
},
"query" : {
"type" : "string",
"minLength" : 1
},
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
}
},
"required" : [ "name", "query" ],
"additionalProperties" : false
},
"metabase.agent-api.api.create-metric-response" : {
"type" : "object",
"properties" : {
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"collection_path" : {
"type" : "string"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display" : {
"type" : "string"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
},
"url" : {
"type" : "string"
}
},
"required" : [ "id", "name", "url", "display", "collection_id", "collection_path", "description" ]
},
"metabase.agent-api.api.create-question-request" : {
"type" : "object",
"properties" : {
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.agent-api.api.card-display"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string",
"minLength" : 1
},
"query" : {
"type" : "string",
"minLength" : 1
},
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
}
},
"required" : [ "name", "query" ],
"additionalProperties" : false
},
"metabase.agent-api.api.create-question-response" : {
"type" : "object",
"properties" : {
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"collection_path" : {
"type" : "string"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display" : {
"type" : "string"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
},
"url" : {
"type" : "string"
}
},
"required" : [ "id", "name", "url", "display", "collection_id", "collection_path", "description" ]
},
"metabase.agent-api.api.dashboard-tab" : {
"type" : "object",
"properties" : {
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
}
},
"required" : [ "id", "name" ]
},
"metabase.agent-api.api.dashcard-mutation" : {
"description" : "One dashcard mutation. Discriminated on `:action`:\n - `add` : requires `card_id`. Auto-positioned. Optional `display_size` (\"wide\", \"tall\", or \"full\").\n - `add_heading` : requires `text`. Adds a full-width section heading.\n - `add_text` : requires `text` (Markdown). Adds a text card. Optional `display_size`\n (\"wide\", \"tall\", or \"full\").\n - `update_text` : requires `dashcard_id` and `text`. Replaces a heading or text card's text\n in place, keeping its position and size.\n - `remove` : requires `dashcard_id`.\n - `move` : requires `dashcard_id` and `position` (\"top\" or \"bottom\").\n\n The add actions take an optional `tab_id` (a tab on this dashboard); omitted, new cards land on\n the dashboard's first tab.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"action" : {
"const" : "add"
},
"card_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"display_size" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "wide", "tall", "full" ]
}, {
"type" : "null"
} ]
},
"tab_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"required" : [ "action", "card_id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"action" : {
"const" : "add_heading"
},
"display_size" : {
"type" : "null"
},
"tab_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"text" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "action", "text" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"action" : {
"const" : "add_text"
},
"display_size" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "wide", "tall", "full" ]
}, {
"type" : "null"
} ]
},
"tab_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"text" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "action", "text" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"action" : {
"const" : "update_text"
},
"dashcard_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"text" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "action", "dashcard_id", "text" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"action" : {
"const" : "remove"
},
"dashcard_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "action", "dashcard_id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"action" : {
"const" : "move"
},
"dashcard_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"position" : {
"type" : "string",
"enum" : [ "top", "bottom" ]
}
},
"required" : [ "action", "dashcard_id", "position" ],
"additionalProperties" : false
} ]
},
"metabase.agent-api.api.execute-query-request" : {
"description" : "Request schema for /v1/execute. Accepts a base64-encoded MBQL query.",
"type" : "object",
"properties" : {
"query" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "query" ],
"additionalProperties" : false
},
"metabase.agent-api.api.execute-query-response" : {
"description" : "Response from query execution. The HTTP status is always 202 because results are streamed —\n check the `status` field to determine success or failure.",
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"cols" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.agent-api.api.column-metadata"
}
},
"rows" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : { }
}
}
},
"required" : [ "cols", "rows" ]
},
"error" : {
"type" : "string"
},
"row_count" : {
"type" : "integer"
},
"running_time" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "completed", "failed" ]
}
},
"required" : [ "status" ]
},
"metabase.agent-api.api.execute-sql-request" : {
"description" : "Request shape for /v1/execute-sql. The LLM passes a raw SQL string against a target database.",
"type" : "object",
"properties" : {
"database_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"sql" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "database_id", "sql" ],
"additionalProperties" : false
},
"metabase.agent-api.api.query-request" : {
"description" : "Request body for /v2/query, one of three shapes:\n - `{:continuation_token <string>}` from a prior response (pagination);\n - `{:query <base64-string>}` — a query_handle resolved by the MCP layer to its stored base64\n MBQL; already resolved, so it's executed directly (like /v1/execute) rather than re-run\n through the representations pipeline;\n - `{:query <external-query-object>}` — a fresh portable MBQL 5 payload, same shape as\n /v2/construct-query.\n\n The string-vs-object `:query` distinction is what the `:dispatch` keys on. Each branch is a\n closed map, so top-level keys it doesn't declare (e.g. the legacy `source_entity` /\n `referenced_entities` envelope, or a `:query` sent alongside a `:continuation_token`) are\n dropped before the handler runs.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"continuation_token" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "continuation_token" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"query" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "query" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-request"
} ]
},
"metabase.agent-api.api.query-response" : {
"description" : "Response from query execution. The HTTP status is always 202 because results are streamed —\n check the `status` field to determine success or failure.",
"type" : "object",
"properties" : {
"continuation_token" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"data" : {
"type" : "object",
"properties" : {
"cols" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.agent-api.api.column-metadata"
}
},
"rows" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : { }
}
}
},
"required" : [ "cols", "rows" ]
},
"error" : {
"type" : "string"
},
"row_count" : {
"type" : "integer"
},
"running_time" : {
"type" : "integer"
},
"status" : {
"type" : "string",
"enum" : [ "completed", "failed" ]
}
},
"required" : [ "status" ]
},
"metabase.agent-api.api.read-resource-item" : {
"description" : "One fetched resource. Either `:content` (success) or `:error` (failure) is present.",
"type" : "object",
"properties" : {
"content" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"error" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"uri" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "uri" ]
},
"metabase.agent-api.api.read-resource-request" : {
"description" : "Arguments for /v1/read-resource, shared with the tool declaration.",
"type" : "object",
"properties" : {
"uris" : {
"description" : "A non-empty array of at most 5 URIs, each at most 4096 characters. Request fewer URIs or shorten them to fit these limits.",
"type" : "array",
"items" : {
"description" : "A metabase:// resource URI",
"type" : "string",
"minLength" : 1,
"maxLength" : 4096
},
"minItems" : 1,
"maxItems" : 5
}
},
"required" : [ "uris" ],
"additionalProperties" : false
},
"metabase.agent-api.api.read-resource-response" : {
"description" : "Response shape from /v1/read-resource. `:resources` is the per-URI result list;\n `:output` is the formatted XML string the LLM consumes.",
"type" : "object",
"properties" : {
"output" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.agent-api.api.read-resource-item"
}
}
},
"required" : [ "resources", "output" ]
},
"metabase.agent-api.api.search-response" : {
"description" : "Search results containing tables, models, metrics, saved questions, dashboards, and\n collections matching the query.",
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.agent-api.api.search-result-item"
}
},
"total_count" : {
"type" : "integer"
}
},
"required" : [ "data", "total_count" ]
},
"metabase.agent-api.api.search-result-item" : {
"description" : "A table, model, metric, saved question, dashboard, or collection returned from search.\n The map is intentionally open: the underlying search enriches results with extra fields\n (e.g. `:database_name`, `:portable_entity_id`, metric base-table info) that callers may\n ignore. Only the keys agents commonly rely on are declared here.",
"type" : "object",
"properties" : {
"collection" : {
"oneOf" : [ {
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"id" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"verified" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"location" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"database_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"display_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"type" : "string",
"enum" : [ "table", "metric", "model", "question", "dashboard", "collection" ]
},
"official" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"database_schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "type", "name" ]
},
"metabase.agent-api.api.update-dashboard-request" : {
"description" : "Patch shape for `update_dashboard`. Metadata fields and an optional `dashcards` list of\n add/add_heading/add_text/update_text/remove/move mutations applied in order.",
"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"
} ]
},
"dashcards" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.agent-api.api.dashcard-mutation"
}
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.agent-api.api.update-dashboard-response" : {
"description" : "Returned by `update_dashboard`. `:dashcard_ids` is the post-mutation list of dashcard\n ids in row/col order so the LLM can confirm what landed on the dashboard. `:tabs` lists\n the dashboard's tabs in display order — the ids a mutation's `tab_id` accepts.",
"type" : "object",
"properties" : {
"archived" : {
"type" : "boolean"
},
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"collection_path" : {
"type" : "string"
},
"dashcard_ids" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
},
"tabs" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.agent-api.api.dashboard-tab"
}
}
},
"required" : [ "id", "name", "collection_id", "collection_path", "description", "archived", "dashcard_ids", "tabs" ]
},
"metabase.agent-api.api.update-metric-request" : {
"description" : "Patch shape for `update_metric`. Every field is optional; only the fields the caller\n passes are changed. `:query` accepts a base64-encoded MBQL string (or query_handle UUID\n resolved upstream in the MCP layer) and must still describe a valid metric.",
"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"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.agent-api.api.card-display"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.agent-api.api.update-metric-response" : {
"description" : "Returned by `update_metric` - the fields the LLM is most likely to want to read back\n after an update. Excludes the full dataset_query, which the caller can re-fetch via\n `read_resource` if needed.",
"type" : "object",
"properties" : {
"archived" : {
"type" : "boolean"
},
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"collection_path" : {
"type" : "string"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display" : {
"type" : "string"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "id", "name", "display", "collection_id", "collection_path", "description", "archived" ]
},
"metabase.agent-api.api.update-question-request" : {
"description" : "Patch shape for `update_question`. Every field is optional; only the fields the caller\n passes are changed. `:query` accepts a base64-encoded MBQL string (or query_handle UUID\n resolved upstream in the MCP layer).",
"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"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.agent-api.api.card-display"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"visualization_settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.agent-api.api.update-question-response" : {
"description" : "Returned by `update_question` - the fields the LLM is most likely to want to read back\n after an update. Excludes the full dataset_query, which the caller can re-fetch via\n `read_resource` if needed.",
"type" : "object",
"properties" : {
"archived" : {
"type" : "boolean"
},
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"collection_path" : {
"type" : "string"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display" : {
"type" : "string"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "id", "name", "display", "collection_id", "collection_path", "description", "archived" ]
},
"metabase.api-keys.schema..key.masked" : {
"description" : "Masked string like 'mb_1234**********'.",
"allOf" : [ {
"$ref" : "#/components/schemas/metabase.api-keys.schema..key.raw"
}, {
"type" : "string",
"pattern" : "^mb_.*{4}\\*+$"
} ]
},
"metabase.api-keys.schema..key.raw" : {
"description" : "Unhashed string of the form 'mb_<base-64-bytes>'.",
"type" : "string",
"minLength" : 12,
"maxLength" : 254
},
"metabase.api-keys.schema.id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"metabase.api-keys.schema.name" : {
"type" : "string",
"minLength" : 1,
"maxLength" : 254
},
"metabase.api-keys.schema.prefix" : {
"description" : "Prefix string of an API Key, suitable for passing around unmasked. This must be unique.",
"type" : "string",
"minLength" : 7,
"maxLength" : 7
},
"metabase.cache.api..cache-strategy.ee" : {
"description" : "cache strategy :type must be one of :nocache, :ttl, :duration, :schedule",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.nocache"
}, {
"$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ttl"
}, {
"$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee.duration"
}, {
"$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee.schedule"
} ]
},
"metabase.cache.api..cache-strategy.ee.duration" : {
"description" : "Cache for a fixed duration (EE).",
"type" : "object",
"properties" : {
"duration" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"refresh_automatically" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"type" : {
"const" : "duration"
},
"unit" : {
"type" : "string",
"enum" : [ "hours", "minutes", "seconds", "days" ]
}
},
"required" : [ "type", "duration", "unit" ],
"additionalProperties" : false
},
"metabase.cache.api..cache-strategy.ee.schedule" : {
"description" : "Cache until the next run of a cron schedule (EE).",
"type" : "object",
"properties" : {
"refresh_automatically" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"schedule" : {
"description" : "value must be a valid Quartz cron schedule string.",
"type" : "string",
"minLength" : 1
},
"type" : {
"const" : "schedule"
}
},
"required" : [ "type", "schedule" ],
"additionalProperties" : false
},
"metabase.cache.api..cache-strategy.nocache" : {
"$ref" : "#/components/schemas/metabase.lib.schema..cache-strategy.nocache"
},
"metabase.cache.api..cache-strategy.oss" : {
"description" : "cache strategy :type must be one of :nocache, :ttl",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.nocache"
}, {
"$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ttl"
} ]
},
"metabase.cache.api..cache-strategy.ttl" : {
"description" : "Cache for a multiple of the query's average execution time. Typed as plain numbers here: a strategy reaches a query\n from several places (the Card, a Dashboard, the Database), and `metabase.cache.api` is the one that asks for integers.",
"type" : "object",
"properties" : {
"min_duration_ms" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
},
"multiplier" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"const" : "ttl"
}
},
"required" : [ "type", "multiplier", "min_duration_ms" ],
"additionalProperties" : false
},
"metabase.cache.api.cache-config-item" : {
"type" : "object",
"properties" : {
"collection" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"authority_level" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name" ]
}, {
"type" : "null"
} ]
},
"model" : {
"type" : "string",
"enum" : [ "root", "database", "dashboard", "question" ]
},
"model_id" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"strategy" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
}
},
"required" : [ "type" ]
}
},
"required" : [ "model", "model_id", "strategy" ]
},
"metabase.cache.api.cache-config-list-response" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.cache.api.cache-config-item"
}
},
"limit" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"offset" : {
"oneOf" : [ {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}, {
"type" : "null"
} ]
},
"total" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "data" ]
},
"metabase.cache.api.cache-config-store-response" : {
"type" : "object",
"properties" : {
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "id" ]
},
"metabase.cache.api.cache-invalidate-response" : {
"type" : "object",
"properties" : {
"body" : {
"type" : "object",
"properties" : {
"count" : {
"type" : "integer"
},
"message" : {
"type" : "string"
}
},
"required" : [ "count", "message" ]
},
"status" : {
"const" : 200
}
},
"required" : [ "status", "body" ]
},
"metabase.cache.api.cache-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee"
}, {
"$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.oss"
} ]
},
"metabase.channel.models.channel.Channel" : {
"description" : "[[details-by-type]] as a schema, for the row schemas below.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean"
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"details" : {
"$ref" : "#/components/schemas/metabase.channel.schema.http-details"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "name", "type", "details" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean"
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"details" : {
"$ref" : "#/components/schemas/metabase.channel.schema.slack-details"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "name", "type", "details" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean"
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"details" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.schema.email-details"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "name", "type" ],
"additionalProperties" : false
} ]
},
"metabase.channel.models.channel.ChannelTemplate" : {
"description" : "Channel Template schema.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"channel_type" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"details" : {
"$ref" : "#/components/schemas/metabase.channel.schema..channel-template.email-details"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "channel_type", "details" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"channel_type" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"details" : {
"type" : "null"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "channel_type" ],
"additionalProperties" : false
} ]
},
"metabase.channel.models.channel.ChannelTemplateUserProvided" : {
"description" : "Channel Template schema for API-provided templates. Does not allow handlebars-resource.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"channel_type" : { },
"details" : {
"$ref" : "#/components/schemas/metabase.channel.schema..channel-template.email-details.user-provided"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "channel_type", "details" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"channel_type" : { },
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "channel_type" ],
"additionalProperties" : false
} ]
},
"metabase.channel.schema..channel-template.email-details" : {
"description" : "The `:details` of a `:channel/email` ChannelTemplate.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"path" : {
"type" : "string"
},
"recipient-type" : {
"enum" : [ "cc", "bcc", "cc", "bcc" ]
},
"subject" : {
"type" : "string"
},
"type" : {
"enum" : [ "email/handlebars-resource", "email/handlebars-text", "email/handlebars-resource", "email/handlebars-text" ]
}
},
"required" : [ "type", "subject", "path" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"body" : {
"type" : "string"
},
"recipient-type" : {
"enum" : [ "cc", "bcc", "cc", "bcc" ]
},
"subject" : {
"type" : "string"
},
"type" : {
"enum" : [ "email/handlebars-resource", "email/handlebars-text", "email/handlebars-resource", "email/handlebars-text" ]
}
},
"required" : [ "type", "subject", "body" ],
"additionalProperties" : false
} ]
},
"metabase.channel.schema..channel-template.email-details.user-provided" : {
"description" : "Email template details as the API accepts them. Only an inline Handlebars template is allowed; a resource template is\n for internal use.",
"type" : "object",
"properties" : {
"body" : {
"type" : "string"
},
"recipient-type" : {
"enum" : [ "cc", "bcc", "cc", "bcc" ]
},
"subject" : {
"type" : "string"
},
"type" : {
"enum" : [ "email/handlebars-text", "email/handlebars-text" ]
}
},
"required" : [ "type", "subject", "body" ],
"additionalProperties" : false
},
"metabase.channel.schema..channel.details" : {
"description" : "The `:details` column of a Channel, decoded, when the channel's `:type` is not at hand to pick the schema by. Decoding\n an `:or` keeps the first branch the value satisfies once decoded, and the request decoder strips undeclared keys, so\n the branches run from the most to the least demanding: the empty `::email-details` would swallow anything.",
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.schema.slack-details"
}, {
"$ref" : "#/components/schemas/metabase.channel.schema.http-details"
}, {
"$ref" : "#/components/schemas/metabase.channel.schema.email-details"
} ]
},
"metabase.channel.schema..channel.details-by-type" : {
"description" : "[[details-by-type]] as a schema, for the row schemas below.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"details" : {
"$ref" : "#/components/schemas/metabase.channel.schema.http-details"
}
},
"required" : [ "details" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"details" : {
"$ref" : "#/components/schemas/metabase.channel.schema.slack-details"
}
},
"required" : [ "details" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"details" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.schema.email-details"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
} ]
},
"metabase.channel.schema.email-details" : {
"description" : "The connection `:details` of a `:channel/email` channel: an optional SMTP host and port, as email is otherwise configured by settings.",
"type" : "object",
"properties" : {
"host" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"port" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.channel.schema.http-details" : {
"description" : "The connection `:details` of a `:channel/http` channel.",
"type" : "object",
"properties" : {
"auth-info" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}, {
"description" : "Value must be a map."
} ]
},
"auth-method" : {
"type" : "string",
"enum" : [ "none", "header", "query-param", "request-body" ]
},
"fe-form-type" : {
"type" : "string",
"enum" : [ "api-key", "bearer", "basic", "none" ]
},
"method" : {
"type" : "string",
"enum" : [ "get", "post", "put" ]
},
"url" : {
"description" : "value must be a valid URL."
}
},
"required" : [ "url", "auth-method" ],
"additionalProperties" : false
},
"metabase.channel.schema.slack-details" : {
"description" : "The connection `:details` of a `:channel/slack` channel.",
"type" : "object",
"properties" : {
"channel" : {
"type" : "string"
}
},
"required" : [ "channel" ],
"additionalProperties" : false
},
"metabase.collections-rest.api.Collection" : {
"description" : "A Collection as the REST API returns it. Deliberately open: which hydrated keys come back varies by endpoint and\n by what the Collection is. `POST /` returns the freshly inserted row with no permission flags; `/root` describes a\n virtual Collection with a string id and none of the database-backed columns; `/tree` nests `:children`. Only `:id`\n and `:name` are present in every case, so only those are required here.",
"type" : "object",
"properties" : {
"id" : {
"$ref" : "#/components/schemas/metabase.collections-rest.api.CollectionId"
},
"name" : {
"anyOf" : [ {
"type" : "string"
}, {
"anyOf" : [ { }, { } ]
} ]
}
},
"required" : [ "id", "name" ]
},
"metabase.collections-rest.api.CollectionId" : {
"description" : "A Collection's ID: an integer for a real row, or the string \"root\" for the virtual Root Collection.",
"anyOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "string"
} ]
},
"metabase.collections-rest.api.CollectionTreeNode" : {
"description" : "A Collection in the `/tree` response. `:children` are nested tree nodes, except under `?shallow=true`, where the\n endpoint returns only the requested level and `:children` degrades to a boolean saying whether any exist.",
"type" : "object",
"properties" : {
"children" : {
"anyOf" : [ {
"type" : "boolean"
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.collections-rest.api.CollectionTreeNode"
}
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.collections-rest.api.CollectionId"
},
"name" : {
"anyOf" : [ {
"type" : "string"
}, {
"anyOf" : [ { }, { } ]
} ]
}
},
"required" : [ "id", "name" ]
},
"metabase.collections-rest.api.DashboardQuestionCandidate" : {
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
},
"sole_dashboard_info" : {
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
}
},
"required" : [ "id", "name", "description" ]
}
},
"required" : [ "id", "name", "description", "sole_dashboard_info" ]
},
"metabase.collections-rest.api.DashboardQuestionCandidatesResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.collections-rest.api.DashboardQuestionCandidate"
}
},
"total" : {
"type" : "integer"
}
},
"required" : [ "data", "total" ]
},
"metabase.collections-rest.api.ItemsMetadata" : {
"type" : "object",
"properties" : {
"available_models" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"total_items" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "available_models", "total_items" ]
},
"metabase.collections-rest.api.ItemsResponse" : {
"description" : "A page of a Collection's items. `:available_models` is present only when the request asked for it, and\n `:limit`/`:offset` are dropped entirely in the `snippets` namespace, which is not paginated.",
"type" : "object",
"properties" : {
"available_models" : {
"type" : "array",
"items" : { }
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : { }
}
},
"limit" : {
"oneOf" : [ {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}, {
"type" : "null"
} ]
},
"models" : {
"oneOf" : [ {
"type" : "array",
"items" : { }
}, {
"type" : "null"
} ]
},
"offset" : {
"oneOf" : [ {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}, {
"type" : "null"
} ]
},
"total" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "total", "data", "models" ]
},
"metabase.collections-rest.api.MoveDashboardQuestionCandidatesResponse" : {
"type" : "object",
"properties" : {
"moved" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
}
},
"required" : [ "moved" ]
},
"metabase.collections.schema..collection.update" : {
"description" : "What an update (or insert) of a Collection accepts: every column of `:collection` except `id`, all optional.",
"type" : "object",
"properties" : {
"archive_operation_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"authority_level" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"is_sample" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"is_remote_synced" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"slug" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"archived" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"location" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"namespace" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"personal_owner_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.collections.schema.CardType" : {
"type" : "string",
"enum" : [ "model", "question", "metric" ]
},
"metabase.collections.schema.Collection" : {
"type" : "object",
"properties" : {
"git_sync_enabled" : {
"type" : "boolean"
},
"can_delete" : {
"type" : "boolean"
},
"entity_id" : {
"type" : "string"
},
"authority_level" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"is_sample" : {
"type" : "boolean"
},
"children" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.collections.schema.Collection"
}
},
"id" : {
"anyOf" : [ {
"type" : "string"
}, {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
} ]
},
"effective_ancestors" : {
"type" : "object",
"properties" : { }
},
"effective_location" : {
"type" : "string"
},
"is_remote_synced" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"slug" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"location" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"can_write" : {
"type" : "boolean"
},
"type" : {
"$ref" : "#/components/schemas/metabase.collections.schema.CollectionType"
},
"here" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
},
"uniqueItems" : true
},
"parent_id" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
} ]
}, {
"type" : "null"
} ]
},
"can_restore" : {
"type" : "boolean"
},
"is_personal" : {
"type" : "boolean"
},
"personal_owner_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"below" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
}
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "description", "can_write", "can_restore", "can_delete", "archived", "location" ]
},
"metabase.collections.schema.CollectionItem" : {
"type" : "object",
"properties" : {
"last-edit-info" : {
"$ref" : "#/components/schemas/metabase.collections.schema.LastEditInfo"
},
"model" : {
"$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
},
"copy" : {
"type" : "boolean"
},
"collection_preview" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"dashboard_count" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"can_delete" : {
"type" : "boolean"
},
"entity_id" : {
"type" : "string"
},
"authority_level" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"collection" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.collections.schema.Collection"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"effective_location" : {
"type" : "string"
},
"fully_parameterized" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"collection_position" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"location" : {
"type" : "string"
},
"database_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"can_write" : {
"type" : "boolean"
},
"collection_id" : {
"oneOf" : [ {
"anyOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"based_on_upload" : {
"oneOf" : [ {
"anyOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"moderated_status" : {
"type" : "string"
},
"type" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.collections.schema.CollectionType"
}, {
"$ref" : "#/components/schemas/metabase.collections.schema.CardType"
} ]
},
"here" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
},
"uniqueItems" : true
},
"display" : {
"type" : "string"
},
"can_restore" : {
"type" : "boolean"
},
"personal_owner_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"below" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
}
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "description", "archived" ]
},
"metabase.collections.schema.CollectionItemModel" : {
"type" : "string",
"enum" : [ "card", "dataset", "metric", "dashboard", "snippet", "collection", "indexed-entity", "indexed-entity", "document", "exploration", "table", "action" ]
},
"metabase.collections.schema.CollectionType" : {
"type" : "string",
"enum" : [ "instance-analytics", "trash", "remote-synced", "library", "library-models", "library-metrics", "library-dashboards" ]
},
"metabase.collections.schema.LastEditInfo" : {
"type" : "object",
"properties" : {
"email" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"first_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"last_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"timestamp" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "email", "first_name", "last_name", "timestamp" ]
},
"metabase.collections.schema.collection" : {
"description" : "What an update (or insert) of a Collection accepts: every column of `:collection` except `id`, all optional.",
"type" : "object",
"properties" : {
"archive_operation_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"authority_level" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"is_sample" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
},
"effective_location" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"is_remote_synced" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"slug" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"archived" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"location" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"can_write" : {
"type" : "boolean"
},
"type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"namespace" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"is_personal" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"personal_owner_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
},
"metabase.collections.schema.collection-or-root" : {
"description" : "A Collection row, or the Root Collection placeholder.",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.collections.schema.root-collection"
}, {
"$ref" : "#/components/schemas/metabase.collections.schema.collection"
} ]
},
"metabase.collections.schema.root-collection" : {
"description" : "The placeholder for the Root Collection, which has no row, as `metabase.collections.models.collection.root` builds it.",
"type" : "object",
"properties" : {
"can_delete" : {
"type" : "boolean"
},
"authority_level" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"id" : {
"const" : "root"
},
"effective_ancestors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.collections.schema.collection"
}
},
"effective_location" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"is_remote_synced" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"can_write" : {
"type" : "boolean"
},
"parent_id" : {
"type" : "null"
},
"can_restore" : {
"type" : "boolean"
},
"metabase.collections.models.collection.root/is-root?" : {
"const" : true
},
"namespace" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"is_personal" : {
"type" : "boolean"
}
},
"required" : [ "metabase.collections.models.collection.root/is-root?" ],
"additionalProperties" : false
},
"metabase.comments.schema..comment.context" : {
"description" : "The `:context` column of a Comment, decoded.",
"type" : "object",
"properties" : {
"exploration_query_ids" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
}, {
"type" : "null"
} ]
},
"highlight_label" : {
"oneOf" : [ {
"type" : "string",
"maxLength" : 1000
}, {
"type" : "null"
} ]
},
"highlighted" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.comments.schema..comment.highlight"
}, {
"type" : "null"
} ]
},
"timeline_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.comments.schema..comment.highlight" : {
"description" : "The chart point a comment is anchored to. Identity only — which column, and which dimension values\n pick out the point — so the client can re-find it in a result set it is separately authorized to\n read.",
"type" : "object",
"properties" : {
"columnName" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimensions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"columnName" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"value" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
},
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.comments.schema..prose-mirror-node.attrs" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ],
"type" : "object",
"properties" : {
"entityId" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"label" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"level" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"model" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
}
},
"metabase.comments.schema.prose-mirror-node" : {
"description" : "One node of the ProseMirror/TipTap document a comment is written in, in the shape ProseMirror's `Node.toJSON`\n emits: a `:type`, the children it contains, the marks applied to it, and `:text` on text nodes. Those five keys are\n the whole of the ProseMirror JSON node format; `:attrs` varies by node type. Marks are nodes too as far as this\n schema is concerned -- a mark carries only `:type` and `:attrs`, which is a subset of a node.",
"type" : "object",
"properties" : {
"attrs" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.comments.schema..prose-mirror-node.attrs"
}, {
"type" : "null"
} ]
},
"content" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.comments.schema.prose-mirror-node"
}
},
"marks" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.comments.schema.prose-mirror-node"
}
},
"text" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.comments.schema.reaction-emoji" : {
"description" : "Emoji must be 1 to 10 Unicode code points.",
"minLength" : 1,
"maxLength" : 10,
"type" : "string"
},
"metabase.data-apps.schema.action-spec" : {
"description" : "An action of a data app: an implicit action of `kind` on a table.",
"type" : "object",
"properties" : {
"kind" : {
"$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
},
"table" : {
"type" : "object",
"properties" : {
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}
},
"required" : [ "id" ],
"additionalProperties" : false
}
},
"required" : [ "kind", "table" ],
"additionalProperties" : false
},
"metabase.data-apps.schema.query-spec" : {
"description" : "A Lib test query spec of a data app's question: one stage.",
"type" : "object",
"properties" : {
"stages" : {
"type" : "array",
"prefixItems" : [ {
"$ref" : "#/components/schemas/metabase.data-apps.schema.query-stage-spec"
} ]
}
},
"required" : [ "stages" ],
"additionalProperties" : false
},
"metabase.data-apps.schema.query-stage-spec" : {
"description" : "A stage of a Lib test query spec with only what a data app's question may hold, as the card hooks check it: a table\n source, and no joins or custom expressions.",
"type" : "object",
"properties" : {
"aggregations" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-aggregation-spec"
}
}, {
"type" : "null"
} ]
},
"breakouts" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-breakout-spec"
}
}, {
"type" : "null"
} ]
},
"fields" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-column-spec"
}
}, {
"type" : "null"
} ]
},
"filters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-expression-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-segment-spec"
} ]
}
}, {
"type" : "null"
} ]
},
"limit" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"order-bys" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-order-by-spec"
}
}, {
"type" : "null"
} ]
},
"source" : {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-table-source-spec"
}
},
"required" : [ "source" ],
"additionalProperties" : false
},
"metabase.data-studio.api.table.bulk-table-info" : {
"description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.",
"type" : "object",
"properties" : {
"db_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"display_name" : {
"type" : "string"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"is_published" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "db_id", "name", "display_name", "schema", "is_published" ]
},
"metabase.data-studio.api.table.bulk-table-selection-info" : {
"description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",
"type" : "object",
"properties" : {
"published_downstream_tables" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
}
},
"selected_table" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
}, {
"type" : "null"
} ]
},
"unpublished_upstream_tables" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
}
}
},
"required" : [ "selected_table", "published_downstream_tables", "unpublished_upstream_tables" ]
},
"metabase.data-studio.api.table.data-authorities" : {
"type" : "string",
"enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
},
"metabase.data-studio.api.table.data-layers" : {
"type" : "string",
"enum" : [ "final", "internal", "hidden" ]
},
"metabase.data-studio.api.table.data-sources" : {
"type" : "string",
"enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
},
"metabase.data-studio.api.table.table-selectors" : {
"type" : "object",
"properties" : {
"database_ids" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"schema_ids" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"table_ids" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
}
},
"additionalProperties" : false
},
"metabase.documents.prose-mirror..card-embed.explore-filter" : {
"description" : "One explore-further filter `metabase.explorations` snapshots onto a static card embed: the filter as the client\n sent it, plus the name of the dimension it is on. Its `:field_ref` is the legacy `field_ref` of the chart column\n that was clicked.",
"type" : "object",
"properties" : {
"dimension_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display_value" : {
"type" : "string"
},
"field_ref" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..dimension.target"
},
"operator" : {
"type" : "string"
},
"value" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
} ]
}, {
"type" : "null"
} ]
},
"values" : {
"type" : "array",
"prefixItems" : [ {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
} ]
}, {
"type" : "null"
} ]
}, {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
} ]
}, {
"type" : "null"
} ]
} ]
}
},
"required" : [ "operator", "field_ref", "display_value" ],
"additionalProperties" : false
},
"metabase.documents.prose-mirror..card-embed.host-data" : {
"description" : "What `metabase.explorations` writes under `:host_data` of a static card embed so the frontend can render the\n embed's filter pills and hover highlights without a live lookup.",
"type" : "object",
"properties" : {
"explore_filters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.documents.prose-mirror..card-embed.explore-filter"
}
}, {
"type" : "null"
} ]
},
"query_ids" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer"
}
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.documents.prose-mirror..node.attrs" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ],
"type" : "object",
"properties" : {
"model" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"stored_result_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"label" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"chart_href" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"_id" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string",
"format" : "uuid"
} ]
}, {
"type" : "null"
} ]
},
"entityId" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"child_target_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"host_data" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.documents.prose-mirror..card-embed.host-data"
}, {
"type" : "null"
} ]
}
}
},
"metabase.documents.prose-mirror.ast" : {
"description" : "Schema for a prose-mirror document AST as it arrives at the API or is read back from the application database: a\n node in the shape ProseMirror's `Node.toJSON` emits, whose children and marks are nodes too.",
"type" : "object",
"properties" : {
"attrs" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.documents.prose-mirror..node.attrs"
}, {
"type" : "null"
} ]
},
"content" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
}
}, {
"type" : "null"
} ]
},
"marks" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
}
}, {
"type" : "null"
} ]
},
"text" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"type" : "string"
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.documents.schema..document.id" : {
"description" : "Valid Document ID",
"type" : "integer",
"minimum" : 1
},
"metabase.driver.connection.connection-type" : {
"type" : "string",
"enum" : [ "default", "write-data", "transform" ]
},
"metabase.driver.index-field" : {
"description" : "One form field describing how to request an index: the same shape as a [[connection-properties]] descriptor, plus a\n `:columns` type for the indexed columns.",
"type" : "object",
"properties" : {
"description" : { },
"directions" : {
"type" : "boolean"
},
"display-name" : { },
"name" : {
"type" : "string"
},
"options" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : { },
"value" : {
"type" : "string"
}
},
"required" : [ "name", "value" ]
}
},
"required" : {
"type" : "boolean"
},
"type" : {
"type" : "string",
"enum" : [ "string", "boolean", "select", "integer", "columns" ]
}
},
"required" : [ "name", "display-name", "type" ]
},
"metabase.driver.index-method" : {
"description" : "Metadata for one index kind a driver supports.",
"type" : "object",
"properties" : {
"description" : { },
"display-name" : { },
"fields" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.driver.index-field"
}
},
"lifecycle" : {
"type" : "string",
"enum" : [ "standalone", "inline" ]
}
},
"required" : [ "display-name", "lifecycle", "fields" ]
},
"metabase.driver.supported-index-methods" : {
"description" : "Return shape of [[supported-index-methods]]: index-kind -> metadata.",
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.driver.index-method"
}
},
"metabase.eid-translation.schema.entity-ids-by-model" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}, {
"description" : "Value must be a map."
} ]
},
"metabase.embedding-rest.api.theme.EmbeddingTheme" : {
"type" : "object",
"properties" : {
"created_at" : { },
"entity_id" : {
"type" : "string",
"minLength" : 1
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"is_default" : {
"type" : "boolean"
},
"name" : {
"type" : "string",
"minLength" : 1
},
"settings" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ]
},
"updated_at" : { }
},
"required" : [ "id", "entity_id", "name", "settings", "is_default", "created_at", "updated_at" ]
},
"metabase.embedding.schema..sdk-react-18-host.host" : {
"description" : "The `host` of a EmbeddingSdkReact18Host: a lowercase hostname, or an empty string when the host app page URL has no\n hostname.",
"type" : "string"
},
"metabase.embedding.schema..sdk-react-18-host.response" : {
"description" : "A EmbeddingSdkReact18Host as selected from the app DB: every column of `:embedding_sdk_react_18_host`. `host` is an\n empty string when the host app page URL has no hostname.",
"type" : "object",
"properties" : {
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"host" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"last_seen_at" : {
"type" : "string",
"format" : "date-time"
}
},
"required" : [ "id", "host", "created_at", "last_seen_at" ],
"additionalProperties" : false
},
"metabase.embedding.schema.sdk-react-18-host" : {
"description" : "A EmbeddingSdkReact18Host as selected from the app DB: every column of `:embedding_sdk_react_18_host`. `host` is an\n empty string when the host app page URL has no hostname.",
"type" : "object",
"properties" : {
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"host" : {
"$ref" : "#/components/schemas/metabase.embedding.schema..sdk-react-18-host.host"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"last_seen_at" : {
"type" : "string",
"format" : "date-time"
}
},
"required" : [ "id", "host", "created_at", "last_seen_at" ],
"additionalProperties" : false
},
"metabase.explorations.api.CanceledThread" : {
"description" : "Schema for the cancel endpoint response — just the state-bearing fields the FE needs to\n reflect the cancellation. EQ status changes are picked up via the existing `/queries` poll.",
"type" : "object",
"properties" : {
"canceled_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"completed_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "id", "canceled_at", "completed_at" ]
},
"metabase.explorations.api.DimensionsResponse" : {
"description" : "Schema for GET /dimensions: metrics referencing dimensions by id, plus the grouped dimension list.",
"type" : "object",
"properties" : {
"dimension_groups" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.explorations.api.ExplorationDimensionGroup"
}
},
"metrics" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.explorations.api.ExplorationMetric"
}
}
},
"required" : [ "metrics", "dimension_groups" ]
},
"metabase.explorations.api.ExplorationBlockNode" : {
"description" : "A block (the FE's sidebar group): a heading plus its pages. `:name` is the computed heading\n (the metric name). `:position` is the block's 0-indexed authoring slot.",
"type" : "object",
"properties" : {
"explore_filters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"dimension_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display_value" : {
"type" : "string",
"minLength" : 1
},
"field_ref" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..dimension.target"
},
"operator" : {
"const" : "="
},
"value" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "operator", "field_ref", "value", "display_value" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"dimension_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display_value" : {
"type" : "string",
"minLength" : 1
},
"field_ref" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..dimension.target"
},
"operator" : {
"const" : "between"
},
"values" : {
"type" : "array",
"prefixItems" : [ {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
} ]
}, {
"type" : "null"
} ]
}, {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
} ]
}, {
"type" : "null"
} ]
} ]
}
},
"required" : [ "operator", "field_ref", "values", "display_value" ],
"additionalProperties" : false
} ]
}
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"pages" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.explorations.api.ExplorationPageNode"
}
},
"position" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "id", "name", "position", "pages" ]
},
"metabase.explorations.api.ExplorationDimensionGroup" : {
"description" : "Schema for a dimension group in the /dimensions response. A group bundles together dimensions that\n refer to the same underlying source (same field/binning) so the FE can show a single user-facing\n entry while still tracking the actual per-metric dimensions needed by `start exploration`.",
"type" : "object",
"properties" : {
"dimension_interestingness" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"dimensions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metrics.core.dimension"
}
},
"name" : {
"type" : "string"
}
},
"required" : [ "name", "dimension_interestingness", "dimensions" ]
},
"metabase.explorations.api.ExplorationDocument" : {
"description" : "Schema for the Summary document attached to an exploration.",
"type" : "object",
"properties" : {
"is_placeholder" : {
"type" : "boolean"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"updated_at" : {
"type" : "string",
"format" : "date-time"
},
"exploration_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"creator_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"content_type" : {
"type" : "string"
}
},
"required" : [ "id", "name", "exploration_id", "creator_id", "content_type", "is_placeholder", "created_at", "updated_at" ]
},
"metabase.explorations.api.ExplorationMetric" : {
"description" : "Schema for a metric in the /dimensions response: dimensions referenced by id only.",
"type" : "object",
"properties" : {
"dimension_mappings" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metrics.core.dimension-mapping"
}
}, {
"type" : "null"
} ]
},
"collection" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
}
},
"required" : [ "id", "name" ]
}, {
"type" : "null"
} ]
},
"result_column_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
},
"database_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"dimension_ids" : {
"type" : "array",
"items" : { }
},
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"in_library" : {
"type" : "boolean"
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "description", "collection_id", "dimension_ids" ]
},
"metabase.explorations.api.ExplorationPageNode" : {
"description" : "A page within a block: the bundle of queries for one (card, dimension, query_type) under the\n page's stable id. `:query_ids` reference queries on the same thread, sorted by interestingness.\n `:position` is the page's 0-indexed slot among its block's pages. `:name` is the page's short,\n heading-relative label (e.g. `By Category over time`); `:long_name` is the full\n self-describing name (e.g. `Number of Orders by Category over time`) for use without the block\n heading for context.",
"type" : "object",
"properties" : {
"hidden" : {
"type" : "boolean"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"long_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"position" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
},
"query_ids" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"starred" : {
"type" : "boolean"
}
},
"required" : [ "id", "name", "long_name", "position", "query_ids", "starred", "hidden" ]
},
"metabase.explorations.api.ExplorationQueryStreamResponse" : {
"description" : "Schema for `GET /query/:id`. On success the body is a streamed dataset (api/csv/json/xlsx),\n so we describe it as `:any`. On a not-yet-done query we return a 409 with a status payload.",
"anyOf" : [ { }, {
"type" : "object",
"properties" : {
"body" : {
"type" : "object",
"properties" : {
"error_message" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"finished_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"started_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"status" : {
"type" : "string"
}
},
"required" : [ "id", "status" ]
},
"status" : {
"const" : 409
}
},
"required" : [ "status", "body" ]
} ]
},
"metabase.explorations.api.ExplorationQuerySummary" : {
"description" : "Schema for a query row in API responses. The result blob and `dataset_query` aren't\n asserted here; `interestingness_score`, `contextual_interestingness_score`, and `row_count`\n are batched-hydrated onto each query in `/:id` — the scores from `exploration_query_result`,\n `row_count` from the linked `stored_result` — and may be nil for pending/errored queries or —\n for the contextual score — when the LLM is unconfigured or the thread had no prompt.",
"type" : "object",
"properties" : {
"exploration_thread_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"segment_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"dimension_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"row_count" : {
"oneOf" : [ {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}, {
"type" : "null"
} ]
},
"contextual_interestingness_score" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"interestingness_score" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"started_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"card_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"position" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"status" : {
"type" : "string"
},
"error_message" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"query_type" : {
"type" : "string"
},
"segment_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension_name" : {
"type" : "string"
},
"finished_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
}
},
"required" : [ "id", "exploration_thread_id", "card_id", "dimension_id", "query_type", "position", "status" ]
},
"metabase.explorations.api.ExplorationSummary" : {
"description" : "Lightweight row for the `GET /mine` list. No threads/queries — just the metadata\n needed to render a list entry, plus `current_user_last_touched_at`, the timestamp the list is\n sorted by (the caller's own most-recent touch of this exploration, composed across the\n exploration's revisions and its creation).",
"type" : "object",
"properties" : {
"collection" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "id", "name" ]
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"creator" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"email" : {
"type" : "string",
"minLength" : 1
},
"first_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"last_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
}
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string",
"minLength" : 1
},
"archived" : {
"type" : "boolean"
},
"updated_at" : {
"type" : "string",
"format" : "date-time"
},
"current_user_last_touched_at" : {
"type" : "string",
"format" : "date-time"
},
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"creator_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "creator_id", "created_at", "updated_at", "current_user_last_touched_at" ]
},
"metabase.explorations.api.HydratedExploration" : {
"description" : "Schema for an Exploration with hydrated creator and threads.",
"type" : "object",
"properties" : {
"threads" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.explorations.api.HydratedThread"
}
}, {
"type" : "null"
} ]
},
"can_delete" : {
"type" : "boolean"
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"document" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.explorations.api.ExplorationDocument"
}, {
"type" : "null"
} ]
},
"creator" : {
"oneOf" : [ {
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"updated_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"can_write" : {
"type" : "boolean"
},
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"can_restore" : {
"type" : "boolean"
},
"creator_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "creator_id" ]
},
"metabase.explorations.api.HydratedThread" : {
"description" : "Schema for an Exploration thread with hydrated selections and queries.",
"type" : "object",
"properties" : {
"queries" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.explorations.api.ExplorationQuerySummary"
}
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"started_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"blocks" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.explorations.api.ExplorationBlockNode"
}
}, {
"type" : "null"
} ]
},
"position" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
},
"status" : {
"type" : "string",
"enum" : [ "pending", "running", "canceled", "empty", "failed", "completed", "forbidden" ]
},
"source_page_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"prompt" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"timelines" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"position" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
},
"timeline" : {
"oneOf" : [ {
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"timeline_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "timeline_id" ]
}
}, {
"type" : "null"
} ]
},
"exploration_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"completed_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"canceled_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
}
},
"required" : [ "id", "exploration_id", "position", "status" ]
},
"metabase.explorations.api.MineResponse" : {
"description" : "Paginated envelope for `GET /mine`, mirroring the collection-items index shape. `:total` is the\n count after the membership, permission, and archived filters; `:limit`/`:offset` echo the\n `offset-paging` middleware (both nil when the request is unpaged).",
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.explorations.api.ExplorationSummary"
}
},
"limit" : {
"oneOf" : [ {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}, {
"type" : "null"
} ]
},
"offset" : {
"oneOf" : [ {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}, {
"type" : "null"
} ]
},
"total" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "total", "limit", "offset", "data" ]
},
"metabase.frontend-errors.api.frontend-error-type" : {
"type" : "string",
"enum" : [ "component-crash", "chart-render-error" ]
},
"metabase.health-inspector.api.result" : {
"type" : "object",
"properties" : {
"check_name" : {
"type" : "string"
},
"health" : {
"type" : "number"
},
"message" : {
"type" : "string"
},
"run_at" : {
"type" : "string",
"format" : "date-time"
}
},
"required" : [ "check_name", "health", "message", "run_at" ]
},
"metabase.indexed-entities.schema..model-index.pk-ref" : {
"description" : "The `:pk_ref` column of a ModelIndex, decoded.",
"type" : "array"
},
"metabase.indexed-entities.schema..model-index.value-ref" : {
"description" : "The `:value_ref` column of a ModelIndex, decoded.",
"type" : "array"
},
"metabase.indexes.schema.classical-index" : {
"description" : "Postgres / MySQL / SQL Server secondary index.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.column"
},
"minItems" : 1
},
"include" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.column-name"
}
},
"kind" : {
"type" : "string",
"enum" : [ "btree", "hash", "gin", "gist", "brin", "spgist", "fulltext", "spatial", "clustered", "nonclustered", "columnstore" ]
},
"name" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.index-name"
},
"unique" : {
"type" : "boolean"
}
},
"required" : [ "kind", "name", "columns" ],
"additionalProperties" : false
},
"metabase.indexes.schema.clustering" : {
"description" : "Snowflake (standalone) / BigQuery (inline) clustering. `:name` is required for the standalone form.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.column"
},
"minItems" : 1
},
"kind" : {
"const" : "clustering"
},
"name" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.index-name"
}
},
"required" : [ "kind", "columns" ],
"additionalProperties" : false
},
"metabase.indexes.schema.column" : {
"type" : "object",
"properties" : {
"direction" : {
"type" : "string",
"enum" : [ "asc", "desc" ]
},
"name" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.column-name"
}
},
"required" : [ "name" ],
"additionalProperties" : false
},
"metabase.indexes.schema.column-name" : {
"type" : "string",
"minLength" : 1,
"maxLength" : 255
},
"metabase.indexes.schema.distkey" : {
"description" : "Redshift distribution, inline. Only `:key` uses a column (the one DISTKEY column); `:all`/`:even` take none.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.column"
},
"minItems" : 1,
"maxItems" : 1
},
"kind" : {
"const" : "distkey"
},
"style" : {
"type" : "string",
"enum" : [ "key", "all", "even" ]
}
},
"required" : [ "kind", "style" ],
"additionalProperties" : false
},
"metabase.indexes.schema.index-name" : {
"description" : "Free-form user input, inlined (quoted and escaped) into DDL. 63 is the Postgres identifier limit, the tightest\n engine we support.",
"type" : "string",
"minLength" : 1,
"maxLength" : 63
},
"metabase.indexes.schema.index-structured" : {
"description" : "A single structured index definition, dispatched on `:kind`. The shape stored in\n `metabase_table_indexes.structured` and handed to the driver index multimethods.",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.classical-index"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.sortkey"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.distkey"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.clustering"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.order-by"
}, {
"$ref" : "#/components/schemas/metabase.indexes.schema.skip-index"
} ]
},
"metabase.indexes.schema.order-by" : {
"description" : "ClickHouse ORDER BY, inline.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.column"
},
"minItems" : 1
},
"kind" : {
"const" : "order-by"
}
},
"required" : [ "kind", "columns" ],
"additionalProperties" : false
},
"metabase.indexes.schema.skip-index" : {
"description" : "ClickHouse data-skipping index, standalone. Only arg-free types; the parameterized ones need type-args the form\n can't supply yet.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.column"
},
"minItems" : 1
},
"granularity" : {
"type" : "integer",
"minimum" : 1
},
"kind" : {
"const" : "skip-index"
},
"name" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.index-name"
},
"type" : {
"type" : "string",
"enum" : [ "minmax", "bloom_filter" ]
}
},
"required" : [ "kind", "name", "columns", "type" ],
"additionalProperties" : false
},
"metabase.indexes.schema.sortkey" : {
"description" : "Redshift sort key, inline.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.indexes.schema.column"
},
"minItems" : 1
},
"kind" : {
"const" : "sortkey"
},
"style" : {
"type" : "string",
"enum" : [ "compound", "interleaved" ]
}
},
"required" : [ "kind", "style", "columns" ],
"additionalProperties" : false
},
"metabase.legacy-mbql.schema..legacy-column-metadata.binning-info" : {
"type" : "object",
"properties" : {
"bin_width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"binning_strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
},
"max_value" : {
"type" : "number"
},
"min_value" : {
"type" : "number"
},
"num_bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
}
},
"required" : [ "strategy" ],
"additionalProperties" : false
},
"metabase.legacy-mbql.schema..legacy-column-metadata.qualified-keys" : {
"type" : "object",
"properties" : {
"metabase.query-processor.pivot/idx" : {
"type" : "integer",
"minimum" : 0
},
"metabase.lib.underlying/original" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
"lib/original-join-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/remove-join-alias?" : {
"type" : "boolean"
},
"lib/external-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-column-alias" : {
"oneOf" : [ {
"description" : "Name for a column as returned/projected by the previous stage of the query or source Table/source Card. The\n left-hand side (LHS) of\n\n SELECT lhs AS rhs",
"type" : "string"
}, {
"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"
},
"lib/source-uuid" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/join-field" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"qp/implicit-field?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/ref-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension/id" : {
"oneOf" : [ {
"description" : "Valid Dimension ID",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
}, {
"type" : "null"
} ]
},
"metabase.lib.join/target" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
"lib/deduplicated-name" : {
"description" : "The simply-deduplicated name that was historically used in QP results metadata (originally calculated by\n the [[metabase.query-processor.middleware.annotate]] middleware, now calculated\n by [[metabase.lib.middleware.result-metadata]]). This just adds suffixes to column names e.g. `ID` and `ID` become\n `ID` and `ID_2`, respectively. Kept around because many old field refs use this column name.",
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"values/values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"lib/original-expression-name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"lib/from-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/original-fk-join-alias" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"lib/original-fk-field-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/card-id" : {
"oneOf" : [ {
"description" : "Valid Card ID",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/temporal-unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"lib/expression-name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"lib/breakout?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"values/human-readable-values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"lib/original-effective-type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/join-alias" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"lib/source-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension/human-readable-field-id" : {
"oneOf" : [ {
"description" : "Valid Field ID",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"lib/original-fk-field-id" : {
"oneOf" : [ {
"description" : "Valid Field ID",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.propagate-coercion?" : {
"type" : "boolean"
},
"metabase.lib.join/HACK-from-incomplete-join?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
}, {
"type" : "null"
} ]
},
"lib/options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.lib-options"
}, {
"type" : "null"
} ]
},
"lib/original-binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "default"
}
},
"required" : [ "strategy" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "bin-width"
}
},
"required" : [ "strategy", "bin-width" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "num-bins"
}
},
"required" : [ "strategy", "num-bins" ],
"additionalProperties" : false
} ]
}, {
"type" : "null"
} ]
},
"lib/original-join-alias" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"lib/original-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.field.resolution/fallback-metadata?" : {
"type" : "boolean"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"lib/binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "default"
}
},
"required" : [ "strategy" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "bin-width"
}
},
"required" : [ "strategy", "bin-width" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "num-bins"
}
},
"required" : [ "strategy", "num-bins" ],
"additionalProperties" : false
} ]
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
}, {
"type" : "null"
} ]
},
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
}, {
"type" : "null"
} ]
},
"lib/ref-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension/type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "internal", "external" ]
}, {
"type" : "null"
} ]
},
"lib/original-name" : {
"description" : "The original name of the column as it appeared in the very first place it came from (i.e., the physical name of the\n column in the table it appears in). This should be the same as the `:lib/source-column-alias` for the very first\n usage of the column.\n Allowed to be blank because some databases like SQL Server allow blank column names.",
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/original-ref-style-for-result-metadata-purposes" : {
"type" : "string",
"enum" : [ "original-ref-style/id", "original-ref-style/name" ]
},
"metabase.driver.mongo.query-processor/inherited?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"dimension/name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/simple-display-name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"lib/desired-column-alias" : {
"oneOf" : [ {
"description" : "Name we should use as a column alias for a column in this stage of a query. The desired column alias in stage N\n becomes the source column alias in stage N+1. The right-hand side (RHS) in\n\n SELECT lhs AS rhs",
"type" : "string"
}, {
"type" : "null"
} ]
}
}
},
"metabase.legacy-mbql.schema.AggregationRefOptions" : {
"description" : "Options for a legacy `:aggregation` ref in MBQL 4 are the same as in MBQL 5, except that `:lib/uuid` is optional and\n the map cannot be empty.",
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"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"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"display-name" : {
"type" : "string",
"minLength" : 1
},
"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/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"type" : "string"
},
"lib/uuid" : {
"type" : "string",
"minLength" : 36,
"maxLength" : 36
},
"name" : {
"type" : "string",
"minLength" : 1
},
"lib/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"type" : "string",
"minLength" : 1
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"additionalProperties" : false
},
"metabase.legacy-mbql.schema.ExpressionName" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.legacy-mbql.schema.ExpressionRefOptions" : {
"description" : "Options for a legacy `:expression` ref in MBQL 4 are the same as in MBQL 5, except that `:lib/uuid` is optional and\n it cannot be empty.",
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"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"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"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/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"type" : "string"
},
"lib/uuid" : {
"type" : "string",
"minLength" : 36,
"maxLength" : 36
},
"name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"lib/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"type" : "string"
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"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" ]
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"additionalProperties" : false
},
"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" : [ {
"allOf" : [ {
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
"inherited-temporal-unit" : {
"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" ]
},
"database-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"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"
},
"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/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"type" : "string"
},
"lib/uuid" : {
"type" : "string",
"minLength" : 36,
"maxLength" : 36
},
"name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"lib/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"type" : "string"
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"type" : "integer",
"minimum" : 1
},
"join-alias" : {
"type" : "string",
"minLength" : 1
},
"lib/original-binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"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" ]
},
"source-field-join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"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"
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"additionalProperties" : false
}, {
"allOf" : [ ]
} ]
}, {
"type" : "null"
} ]
},
"metabase.legacy-mbql.schema.Reference" : {
"description" : "Schema for any type of valid Field clause, or for an indexed reference to an aggregation clause.",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.expression"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
} ]
},
"metabase.legacy-mbql.schema.SourceTable" : {
"description" : "Schema for a valid value for the `:source-table` clause of an MBQL query.",
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"description" : "`card__<id>` string Table ID",
"type" : "string",
"pattern" : "^card__[1-9]\\d*$"
} ]
},
"metabase.legacy-mbql.schema.aggregation" : {
"description" : "schema for a valid MBQL 4 :aggregation clause",
"allOf" : [ ]
},
"metabase.legacy-mbql.schema.expression" : {
"description" : "schema for a valid MBQL 4 :expression clause",
"allOf" : [ ]
},
"metabase.legacy-mbql.schema.field" : {
"description" : "Schema for a valid MBQL 4 :field clause.",
"allOf" : [ {
"description" : "schema for a valid MBQL 4 :field clause",
"allOf" : [ ]
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.require-base-type-for-field-name"
} ]
},
"metabase.legacy-mbql.schema.legacy-column-metadata" : {
"description" : "Schema for a single legacy metadata column. This is the pre-Lib equivalent of\n `:metabase.lib.schema.metadata/column`.",
"allOf" : [ {
"type" : "object",
"properties" : {
"points_of_interest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.pivot/idx" : {
"type" : "integer",
"minimum" : 0
},
"preview_display" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"database_partitioned" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/original" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
"lib/original-join-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"aggregation_index" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
"field_ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/remove-join-alias?" : {
"type" : "boolean"
},
"lib/external-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-column-alias" : {
"oneOf" : [ {
"description" : "Name for a column as returned/projected by the previous stage of the query or source Table/source Card. The\n left-hand side (LHS) of\n\n SELECT lhs AS rhs",
"type" : "string"
}, {
"type" : "null"
} ]
},
"remapped_from" : {
"oneOf" : [ {
"type" : "string"
}, {
"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"
},
"database_required" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"remapped_from_index" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.visualization-settings"
}, {
"type" : "null"
} ]
},
"fingerprint" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
}, {
"type" : "null"
} ]
},
"visibility_type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
}, {
"type" : "null"
} ]
},
"base_type" : {
"default" : "type/*",
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
"source_alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-uuid" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}, {
"type" : "null"
} ]
},
"custom_position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/join-field" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"special_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"qp/implicit-field?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/ref-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension/id" : {
"oneOf" : [ {
"description" : "Valid Dimension ID",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"expression_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
}, {
"type" : "null"
} ]
},
"metabase.lib.join/target" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
"id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"lib/deduplicated-name" : {
"description" : "The simply-deduplicated name that was historically used in QP results metadata (originally calculated by\n the [[metabase.query-processor.middleware.annotate]] middleware, now calculated\n by [[metabase.lib.middleware.result-metadata]]). This just adds suffixes to column names e.g. `ID` and `ID` become\n `ID` and `ID_2`, respectively. Kept around because many old field refs use this column name.",
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"coercion_strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
}, {
"type" : "null"
} ]
},
"lib/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"values/values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"lib/original-expression-name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"lib/from-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/original-fk-join-alias" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"fingerprint_version" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"lib/original-fk-field-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/card-id" : {
"oneOf" : [ {
"description" : "Valid Card ID",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/temporal-unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"lib/expression-name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"lib/breakout?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"data_sensitivity" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"database_position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"values/human-readable-values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"semantic_type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"fk_field_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/original-effective-type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/join-alias" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"database_is_auto_increment" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"table_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.SourceTable"
}, {
"type" : "null"
} ]
},
"has_field_values" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
}, {
"type" : "null"
} ]
},
"lib/source-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display_name" : {
"type" : "string"
},
"remapping" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"dimension/human-readable-field-id" : {
"oneOf" : [ {
"description" : "Valid Field ID",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"lib/original-fk-field-id" : {
"oneOf" : [ {
"description" : "Valid Field ID",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.propagate-coercion?" : {
"type" : "boolean"
},
"metabase.lib.join/HACK-from-incomplete-join?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
}, {
"type" : "null"
} ]
},
"converted_timezone" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal.timezone-id"
}, {
"type" : "null"
} ]
},
"selected?" : {
"type" : "boolean"
},
"fk_join_alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
}, {
"type" : "null"
} ]
},
"fk_field_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"lib/options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.lib-options"
}, {
"type" : "null"
} ]
},
"remapped_to" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"binning_info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema..legacy-column-metadata.binning-info"
}, {
"type" : "null"
} ]
},
"nfc_path" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "string"
}
}, {
"type" : "null"
} ]
},
"target" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
} ]
}, {
"type" : "null"
} ]
},
"lib/original-binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "default"
}
},
"required" : [ "strategy" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "bin-width"
}
},
"required" : [ "strategy", "bin-width" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "num-bins"
}
},
"required" : [ "strategy", "num-bins" ],
"additionalProperties" : false
} ]
}, {
"type" : "null"
} ]
},
"effective_type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
"lib/original-join-alias" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"parent_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"lib/original-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.field.resolution/fallback-metadata?" : {
"type" : "boolean"
},
"unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"lib/binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "default"
}
},
"required" : [ "strategy" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "bin-width"
}
},
"required" : [ "strategy", "bin-width" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "num-bins"
}
},
"required" : [ "strategy", "num-bins" ],
"additionalProperties" : false
} ]
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
}, {
"type" : "null"
} ]
},
"inherited_temporal_unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"caveats" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
}, {
"type" : "null"
} ]
},
"active" : {
"type" : "boolean"
},
"options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.options"
}, {
"type" : "null"
} ]
},
"lib/ref-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension/type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "internal", "external" ]
}, {
"type" : "null"
} ]
},
"lib/original-name" : {
"description" : "The original name of the column as it appeared in the very first place it came from (i.e., the physical name of the\n column in the table it appears in). This should be the same as the `:lib/source-column-alias` for the very first\n usage of the column.\n Allowed to be blank because some databases like SQL Server allow blank column names.",
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"database_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/original-ref-style-for-result-metadata-purposes" : {
"type" : "string",
"enum" : [ "original-ref-style/id", "original-ref-style/name" ]
},
"metabase.driver.mongo.query-processor/inherited?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension/name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/simple-display-name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"fk_target_field_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"lib/desired-column-alias" : {
"oneOf" : [ {
"description" : "Name we should use as a column alias for a column in this stage of a query. The desired column alias in stage N\n becomes the source column alias in stage N+1. The right-hand side (RHS) in\n\n SELECT lhs AS rhs",
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "display_name", "name" ],
"additionalProperties" : false
}, {
"allOf" : [ ]
} ]
},
"metabase.legacy-mbql.schema.require-base-type-for-field-name" : {
"description" : "Fields using names rather than integer IDs are required to specify `:base-type`."
},
"metabase.lib-be.schema..internal-query.scope" : {
"description" : "Mirrors `metabase.actions.types/scope.normalized`. Duplicated (rather than referenced) so this namespace does not\n have to depend on the `actions` module.",
"anyOf" : [ {
"type" : "object",
"properties" : {
"dashboard-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "dashboard-id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"dashcard-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "dashcard-id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"card-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "card-id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"model-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "model-id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"table-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string"
}
},
"required" : [ "type", "table-id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"webhook-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "type", "webhook-id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"unknown" : {
"type" : "string",
"enum" : [ "model-action" ]
}
},
"required" : [ "type", "unknown" ],
"additionalProperties" : false
} ]
},
"metabase.lib-be.schema.empty-query" : {
"const" : { }
},
"metabase.lib-be.schema.internal-query" : {
"description" : "An internal (audit) query: either the QP's own `:fn`/`:args` invocation shape, or the action-descriptor shape\n stashed on a [[metabase.actions.audit/Base]] row's `:template` for a `:model.row/*` or similar action.",
"type" : "object",
"properties" : {
"action-id" : {
"oneOf" : [ {
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"offset" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"args" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
} ]
}, {
"type" : "null"
} ]
}
}, {
"type" : "null"
} ]
},
"info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.info.info"
}, {
"type" : "null"
} ]
},
"fn" : {
"type" : "string"
},
"limit" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"middleware" : {
"$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
},
"database" : {
"oneOf" : [ {
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"scope" : {
"$ref" : "#/components/schemas/metabase.lib-be.schema..internal-query.scope"
},
"action" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
},
"type" : {
"const" : "internal"
},
"viz-settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.lib-be.schema.maybe-legacy-or-empty-query" : {
"description" : "value must be a valid MBQL query, or an empty query.",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.empty-query"
}, {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
} ]
},
"metabase.lib-be.schema.maybe-legacy-or-internal-query" : {
"description" : "value must be a valid MBQL query, or an internal audit query.",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.internal-query"
}, {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
} ]
},
"metabase.lib-be.schema.maybe-legacy-query" : {
"description" : "value must be a valid MBQL query.",
"$ref" : "#/components/schemas/metabase.lib.schema.query"
},
"metabase.lib-metric.schema..dimension-mapping.target" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..dimension-mapping.target"
},
"metabase.lib-metric.schema..dimension-mapping.type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..dimension-mapping.type"
},
"metabase.lib-metric.schema..dimension-reference.options" : {
"description" : "Options map for dimension references.",
"type" : "object",
"properties" : {
"binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.binning"
}, {
"type" : "null"
} ]
},
"display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"temporal-unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.lib-metric.schema..dimension-source.type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..dimension-source.type"
},
"metabase.lib-metric.schema..filter-clause.options" : {
"description" : "The options of a metric filter clause: MBQL options plus the offset [[metabase.lib-metric.filter]] puts on a\n relative date filter (`previous N units, starting M units ago`).",
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"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"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"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/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"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/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"offset-value" : {
"type" : "integer"
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"offset-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"required" : [ "lib/uuid" ],
"additionalProperties" : false
},
"metabase.lib-metric.schema.binning" : {
"description" : "Schema for `:binning` options passed to a `:dimension` clause.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"strategy" : {
"const" : "default"
}
},
"required" : [ "strategy" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.positive-number"
},
"strategy" : {
"const" : "bin-width"
}
},
"required" : [ "strategy", "bin-width" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"num-bins" : {
"type" : "integer",
"minimum" : 1
},
"strategy" : {
"const" : "num-bins"
}
},
"required" : [ "strategy", "num-bins" ],
"additionalProperties" : false
} ]
},
"metabase.lib-metric.schema.dimension" : {
"description" : "Schema for a dimension definition, plus what the metrics module annotates a dimension with before handing it to a\n client: the column it came from, its group, its field values status and how interesting it looks.",
"type" : "object",
"properties" : {
"sources" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-source"
}
}, {
"type" : "null"
} ]
},
"group" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-group"
}, {
"type" : "null"
} ]
},
"display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
},
"effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"status" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"has-field-values" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
}, {
"type" : "null"
} ]
},
"status-message" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"default-temporal-unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"lib/source" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"dimension-interestingness" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"default" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
},
"metabase.lib-metric.schema.dimension-group" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.dimension-group"
},
"metabase.lib-metric.schema.dimension-id" : {
"description" : "UUID string identifying a dimension.",
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.dimension-id"
},
"metabase.lib-metric.schema.dimension-mapping" : {
"description" : "Schema for a dimension mapping.",
"type" : "object",
"properties" : {
"dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
},
"table-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"target" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-mapping.target"
},
"type" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-mapping.type"
}
},
"required" : [ "type", "dimension-id", "target" ],
"additionalProperties" : false
},
"metabase.lib-metric.schema.dimension-reference" : {
"description" : "Dimension reference clause [:dimension opts uuid].\n Handles normalization from JSON where the tag arrives as a string.",
"type" : "array",
"prefixItems" : [ {
"const" : "dimension"
}, {
"$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-reference.options"
}, {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
} ]
},
"metabase.lib-metric.schema.dimension-source" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.dimension-source"
},
"metabase.lib-metric.schema.dimension-status" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.dimension-status"
},
"metabase.lib-metric.schema.expression-leaf" : {
"description" : "A leaf node in a metric math expression: either a metric or measure reference.",
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.metric-expression-ref"
}, {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.measure-expression-ref"
} ]
},
"metabase.lib-metric.schema.filter-clause" : {
"description" : "MBQL filter clause with normalization for API input.\n Handles string operators and dimension references. After normalization every clause is a tag, an options map and\n arguments that are dimension references, literals or clauses themselves."
},
"metabase.lib-metric.schema.instance-filter" : {
"description" : "A filter associated with a specific expression instance via lib/uuid.",
"type" : "object",
"properties" : {
"filter" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.filter-clause"
},
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "lib/uuid", "filter" ],
"additionalProperties" : false
},
"metabase.lib-metric.schema.instance-filters" : {
"description" : "A sequence of per-instance filters.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.instance-filter"
}
},
"metabase.lib-metric.schema.measure-expression-ref" : {
"description" : "A measure reference in an expression: [:measure {:lib/uuid uuid} measure-id].",
"type" : "array",
"prefixItems" : [ {
"const" : "measure"
}, {
"type" : "object",
"properties" : {
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "lib/uuid" ],
"additionalProperties" : false
}, {
"type" : "integer",
"minimum" : 1
} ]
},
"metabase.lib-metric.schema.metric-expression-ref" : {
"description" : "A metric reference in an expression: [:metric {:lib/uuid uuid} card-id].",
"type" : "array",
"prefixItems" : [ {
"const" : "metric"
}, {
"type" : "object",
"properties" : {
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "lib/uuid" ],
"additionalProperties" : false
}, {
"type" : "integer",
"minimum" : 1
} ]
},
"metabase.lib-metric.schema.metric-math-expression" : {
"description" : "A recursive metric math expression tree.\n Can be a leaf (metric/measure ref) or an arithmetic expression [op opts expr expr ...]\n with at least 2 operands.\n Note: uses :fn validator for arithmetic to avoid Malli's recursive seqex limitation.",
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.expression-leaf"
}, {
"type" : "number"
}, {
"type" : "array"
} ]
},
"metabase.lib-metric.schema.typed-projection" : {
"description" : "A projection associated with a specific expression leaf instance via :lib/uuid.\n The :type and :id identify the source metric/measure for metadata resolution.\n The :lib/uuid disambiguates multiple references to the same metric/measure in an expression.",
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"minimum" : 1
},
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"projection" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-reference"
}
},
"type" : {
"type" : "string",
"enum" : [ "metric", "measure" ]
}
},
"required" : [ "type", "id", "lib/uuid", "projection" ],
"additionalProperties" : false
},
"metabase.lib-metric.schema.typed-projections" : {
"description" : "A sequence of typed projections.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.typed-projection"
}
},
"metabase.lib.metadata.protocols.metadata-provider" : {
"description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol."
},
"metabase.lib.schema..cache-strategy.duration" : {
"description" : "Cache for a fixed duration (EE).",
"type" : "object",
"properties" : {
"duration" : {
"type" : "number"
},
"refresh_automatically" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"type" : {
"const" : "duration"
},
"unit" : {
"type" : "string",
"enum" : [ "hours", "minutes", "seconds", "days" ]
}
},
"required" : [ "type", "duration", "unit" ],
"additionalProperties" : false
},
"metabase.lib.schema..cache-strategy.nocache" : {
"type" : "object",
"properties" : {
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"const" : "nocache"
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.lib.schema..cache-strategy.on-query" : {
"description" : "What is added to a strategy once it is attached to a query.",
"type" : "object",
"properties" : {
"avg-execution-ms" : {
"type" : "integer",
"minimum" : 0
},
"invalidated-at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, { } ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.lib.schema..cache-strategy.schedule" : {
"description" : "Cache until the next run of a cron schedule (EE).",
"type" : "object",
"properties" : {
"refresh_automatically" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"schedule" : {
"type" : "string"
},
"type" : {
"const" : "schedule"
}
},
"required" : [ "type", "schedule" ],
"additionalProperties" : false
},
"metabase.lib.schema..cache-strategy.ttl" : {
"description" : "Cache for a multiple of the query's average execution time. Typed as plain numbers here: a strategy reaches a query\n from several places (the Card, a Dashboard, the Database), and `metabase.cache.api` is the one that asks for integers.",
"type" : "object",
"properties" : {
"min_duration_ms" : {
"type" : "number"
},
"multiplier" : {
"type" : "number"
},
"type" : {
"const" : "ttl"
}
},
"required" : [ "type", "multiplier", "min_duration_ms" ],
"additionalProperties" : false
},
"metabase.lib.schema..query.map" : {
"description" : "Valid MBQL 5 query.",
"type" : "object",
"properties" : {
"lib/metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.metadata-provider"
},
"show-column-totals" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase-enterprise.sandbox.query-processor.middleware.sandboxing/details" : {
"$ref" : "#/components/schemas/metabase.lib.schema..sandboxing.details"
},
"user-parameters" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
"pivot-rows" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"update-row" : {
"$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
},
"qp.pivot/remapped-breakout-combination" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"qp/non-default-parameterized?" : {
"type" : "boolean"
},
"lib/type" : {
"default" : "mbql/query",
"const" : "mbql/query"
},
"pivot_rows" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"settings" : {
"$ref" : "#/components/schemas/metabase.lib.schema.settings.settings"
},
"constraints" : {
"$ref" : "#/components/schemas/metabase.lib.schema.constraints.constraints"
},
"cache-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.cache-strategy"
}, {
"type" : "null"
} ]
},
"lib.convert/converted?" : {
"type" : "boolean"
},
"info" : {
"$ref" : "#/components/schemas/metabase.lib.schema.info.info"
},
"impersonation/admin?" : {
"type" : "boolean"
},
"async?" : {
"type" : "boolean"
},
"qp/skip-result-metadata-persistence" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/external-remaps" : {
"$ref" : "#/components/schemas/metabase.lib.schema.external-remappings"
},
"show-row-totals" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"qp/compiled-inline" : {
"$ref" : "#/components/schemas/metabase.lib.schema.compiled-native-query"
},
"qp.pivot/remapped-indexes" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"minimum" : 0
}
},
"middleware" : {
"$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
},
"database" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
} ]
},
"destination-database/id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
"qp.pivot/unremapped-breakout-combination" : {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
},
"pivot-measures" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"impersonation/allow-write?" : {
"type" : "boolean"
},
"pivot_cols" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"impersonation/role" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp.pivot/num-remapped-breakouts" : {
"type" : "integer",
"minimum" : 0
},
"qp/compiled" : {
"$ref" : "#/components/schemas/metabase.lib.schema.compiled-native-query"
},
"stages" : {
"$ref" : "#/components/schemas/metabase.lib.schema.stages"
},
"qp.pivot/num-unremapped-breakouts" : {
"type" : "integer",
"minimum" : 0
},
"metabase.query-processor.util.add-alias-info/original" : {
"$ref" : "#/components/schemas/metabase.lib.schema..query.snapshot"
},
"viz-settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.visualization-settings"
}, {
"type" : "null"
} ]
},
"pivot-cols" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"show_column_totals" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"qp.pivot/num-remapped-cols" : {
"type" : "integer",
"minimum" : 0
},
"qp/source-card-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"parameters" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
"query-permissions/referenced-card-ids" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"uniqueItems" : true
}, {
"type" : "null"
} ]
},
"show_row_totals" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"create-row" : {
"$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
},
"pivot_measures" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"metabase-enterprise.sandbox.query-processor.middleware.sandboxing/original-metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema..sandboxing.original-metadata"
},
"was-pivot" : {
"description" : "Whether this query was originally run as a pivot query. Stamped into the saved `json_query` by\n `metabase.query-processor.middleware.process-userland-query` and sent back by clients re-downloading pivot query\n results.",
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"required" : [ "stages" ],
"additionalProperties" : false
},
"metabase.lib.schema..query.snapshot" : {
"description" : "A whole copy of a query stashed on the query itself under one of the internal keys below: the same shape as\n [[::query]] minus the `:and`-level constraints, so validating the stashed copy does not re-run uniqueness checks\n against the query it was copied from.",
"$ref" : "#/components/schemas/metabase.lib.schema..query.map"
},
"metabase.lib.schema..sandboxing.details" : {
"description" : "Audit-log details for the sandboxes (row-level restrictions) applied to a query, keyed by the Table ID each one sandboxes. Stashed on the query by the enterprise sandboxing middleware and copied into the results metadata so the restrictions can be recorded in the QueryExecution log.",
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema..sandboxing.details.entry"
}
},
"metabase.lib.schema..sandboxing.details.entry" : {
"description" : "Audit-log entry describing one applied sandbox (row-level restriction): which Table it sandboxes, which sandbox/group/Card it came from, and which login attributes were remapped to which Fields. An attribute's `:value` is the user's actual attribute value, recorded only when `analytics-pii-retention-enabled` is set.",
"type" : "object",
"properties" : {
"attributes" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"field_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"value" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}, {
"type" : "null"
} ]
}
},
"required" : [ "field_id" ],
"additionalProperties" : false
}
},
"card_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"group_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"sandbox_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"table_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}
},
"required" : [ "table_id", "sandbox_id", "group_id", "card_id", "attributes" ],
"additionalProperties" : false
},
"metabase.lib.schema..sandboxing.original-metadata" : {
"description" : "The legacy columns a query was expected to return before sandboxes replaced its source tables, stashed on the query by the enterprise sandboxing middleware and merged into the sandboxed results.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
}
},
"metabase.lib.schema..stage.additional" : {
"oneOf" : [ { }, { } ]
},
"metabase.lib.schema..stage.common" : {
"type" : "object",
"properties" : {
"qp/stage-had-source-card" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"source-query/native-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"persisted-info/native" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/remaps" : {
"$ref" : "#/components/schemas/metabase.lib.schema.external-remappings"
},
"metabase.query-processor.util.add-alias-info/join-alias->escaped" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"lib/stage-metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
},
"metabase.driver.sql.query-processor/cte-level" : {
"type" : "integer",
"minimum" : 0
},
"metabase.query-processor.middleware.cumulative-aggregations/replaced-indexes" : {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
},
"uniqueItems" : true
},
"metabase.query-processor.util.add-alias-info/desired-alias->escaped" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
}
},
"metabase.query-processor.middleware.add-implicit-joins/reused-join-aliases" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"uniqueItems" : true
},
"qp/skip-persisted-cache" : {
"type" : "boolean"
},
"metabase-enterprise.sandbox.query-processor.middleware.sandboxing/sandbox?" : {
"type" : "boolean"
},
"source-query/model?" : {
"type" : "boolean"
},
"qp.pivot/forced-shape" : {
"type" : "string",
"enum" : [ "native-pivot-query", "union-all" ]
},
"parameters" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
"qp/added-implicit-fields?" : {
"type" : "boolean"
},
"qp/stage-is-from-source-card" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"query-permissions/sandboxed-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}
},
"additionalProperties" : false
},
"metabase.lib.schema..stage.initial" : {
"oneOf" : [ { }, { } ]
},
"metabase.lib.schema..stage.mbql" : {
"allOf" : [ {
"type" : "object",
"properties" : {
"qp/stage-had-source-card" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"source-query/native-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"persisted-info/native" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"source-card" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"metabase.query-processor.middleware.add-remaps/remaps" : {
"$ref" : "#/components/schemas/metabase.lib.schema.external-remappings"
},
"metabase.query-processor.util.add-alias-info/join-alias->escaped" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"lib/type" : {
"const" : "mbql.stage/mbql"
},
"lib/stage-metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
},
"pivot" : {
"$ref" : "#/components/schemas/metabase.lib.schema.pivot"
},
"metabase.driver.sql.query-processor/cte-level" : {
"type" : "integer",
"minimum" : 0
},
"breakout" : {
"$ref" : "#/components/schemas/metabase.lib.schema.breakouts"
},
"filters" : {
"$ref" : "#/components/schemas/metabase.lib.schema.filters"
},
"metabase.query-processor.middleware.cumulative-aggregations/replaced-indexes" : {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
},
"uniqueItems" : true
},
"limit" : {
"type" : "integer",
"minimum" : 0
},
"metabase.query-processor.util.add-alias-info/desired-alias->escaped" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
}
},
"metabase.query-processor.middleware.add-implicit-joins/reused-join-aliases" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"uniqueItems" : true
},
"qp/skip-persisted-cache" : {
"type" : "boolean"
},
"metabase-enterprise.sandbox.query-processor.middleware.sandboxing/sandbox?" : {
"type" : "boolean"
},
"joins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.joins"
},
"aggregation" : {
"$ref" : "#/components/schemas/metabase.lib.schema.aggregation.aggregations"
},
"source-query/model?" : {
"type" : "boolean"
},
"fields" : {
"$ref" : "#/components/schemas/metabase.lib.schema.fields"
},
"source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
},
"qp.pivot/forced-shape" : {
"type" : "string",
"enum" : [ "native-pivot-query", "union-all" ]
},
"order-by" : {
"$ref" : "#/components/schemas/metabase.lib.schema.order-by.order-bys"
},
"page" : {
"$ref" : "#/components/schemas/metabase.lib.schema.page"
},
"parameters" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
"qp/added-implicit-fields?" : {
"type" : "boolean"
},
"qp/stage-is-from-source-card" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"query-permissions/sandboxed-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
},
"expressions" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expressions"
}
},
"required" : [ "lib/type" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.lib.schema..stage.valid-refs"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema..stage.page-and-limit-are-mutually-exclusive"
}, {
"allOf" : [ ]
} ]
},
"metabase.lib.schema..stage.native" : {
"allOf" : [ {
"type" : "object",
"properties" : {
"qp/stage-had-source-card" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"source-query/native-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"persisted-info/native" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/remaps" : {
"$ref" : "#/components/schemas/metabase.lib.schema.external-remappings"
},
"metabase.query-processor.util.add-alias-info/join-alias->escaped" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"lib/type" : {
"const" : "mbql.stage/native"
},
"lib/stage-metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
},
"params" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.param-value"
}
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/cte-level" : {
"type" : "integer",
"minimum" : 0
},
"projections" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "string"
}
}, {
"type" : "null"
} ]
},
"mbql?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"collection" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"native" : {
"anyOf" : [ {
"type" : "string"
}, {
"description" : "a driver's native query when it is not a string, e.g. a MongoDB pipeline or a query with its parameters; its shape is the driver's"
} ]
},
"metabase.query-processor.middleware.cumulative-aggregations/replaced-indexes" : {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
},
"uniqueItems" : true
},
"metabase.query-processor.util.add-alias-info/desired-alias->escaped" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
}
},
"metabase.query-processor.middleware.add-implicit-joins/reused-join-aliases" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"uniqueItems" : true
},
"qp/skip-persisted-cache" : {
"type" : "boolean"
},
"metabase-enterprise.sandbox.query-processor.middleware.sandboxing/sandbox?" : {
"type" : "boolean"
},
"qp/table-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"source-query/model?" : {
"type" : "boolean"
},
"qp.pivot/forced-shape" : {
"type" : "string",
"enum" : [ "native-pivot-query", "union-all" ]
},
"parameters" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
"query-permissions/referenced-card-ids" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"uniqueItems" : true
}, {
"type" : "null"
} ]
},
"template-tags" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tags"
},
"qp/added-implicit-fields?" : {
"type" : "boolean"
},
"qp/stage-is-from-source-card" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"query-permissions/sandboxed-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}
},
"required" : [ "lib/type" ],
"additionalProperties" : false
}, {
"allOf" : [ ]
} ]
},
"metabase.lib.schema..stage.page-and-limit-are-mutually-exclusive" : {
"description" : "If an MBQL query stage specifies `:page`, it should not also specify `:limit`"
},
"metabase.lib.schema..stage.valid-refs" : { },
"metabase.lib.schema..stages.valid-refs" : { },
"metabase.lib.schema.actions.row" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
},
"metabase.lib.schema.aggregation..distinct.arg" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"metabase.lib.schema.aggregation..percentile.percentile" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
},
"metabase.lib.schema.aggregation.aggregation" : {
"$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
},
"metabase.lib.schema.aggregation.aggregations" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.aggregation.aggregation"
},
"minItems" : 1
},
"metabase.lib.schema.binning.bin-width" : {
"description" : "Bin width (size of each bin).",
"$ref" : "#/components/schemas/metabase.lib.schema.common.positive-number"
},
"metabase.lib.schema.binning.binning" : {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "default"
}
},
"required" : [ "strategy" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "bin-width"
}
},
"required" : [ "strategy", "bin-width" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"max-value" : {
"type" : "number"
},
"min-value" : {
"type" : "number"
},
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "num-bins"
}
},
"required" : [ "strategy", "num-bins" ],
"additionalProperties" : false
} ]
},
"metabase.lib.schema.binning.num-bins" : {
"description" : "Number of bins to use.",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.binning.strategy" : {
"type" : "string",
"enum" : [ "bin-width", "default", "num-bins" ]
},
"metabase.lib.schema.breakout" : {
"$ref" : "#/components/schemas/metabase.lib.schema.ref.ref"
},
"metabase.lib.schema.breakouts" : {
"allOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.breakout"
},
"minItems" : 1
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
} ]
},
"metabase.lib.schema.cache-strategy" : {
"description" : "The caching strategy the results-cache middleware should apply to this query, attached\n by [[metabase.query-processor.card]]. Any of the strategy types: which ones an instance may configure is\n `metabase.cache.api`'s business, not the query's.",
"oneOf" : [ {
"description" : "What is added to a strategy once it is attached to a query.",
"type" : "object",
"properties" : {
"avg-execution-ms" : {
"type" : "integer",
"minimum" : 0
},
"invalidated-at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, { } ]
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"const" : "nocache"
}
},
"required" : [ "type" ],
"additionalProperties" : false
}, {
"description" : "What is added to a strategy once it is attached to a query.",
"type" : "object",
"properties" : {
"avg-execution-ms" : {
"type" : "integer",
"minimum" : 0
},
"invalidated-at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, { } ]
}, {
"type" : "null"
} ]
},
"min_duration_ms" : {
"type" : "number"
},
"multiplier" : {
"type" : "number"
},
"type" : {
"const" : "ttl"
}
},
"required" : [ "type", "multiplier", "min_duration_ms" ],
"additionalProperties" : false
}, {
"description" : "What is added to a strategy once it is attached to a query.",
"type" : "object",
"properties" : {
"avg-execution-ms" : {
"type" : "integer",
"minimum" : 0
},
"duration" : {
"type" : "number"
},
"invalidated-at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, { } ]
}, {
"type" : "null"
} ]
},
"refresh_automatically" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"type" : {
"const" : "duration"
},
"unit" : {
"type" : "string",
"enum" : [ "hours", "minutes", "seconds", "days" ]
}
},
"required" : [ "type", "duration", "unit" ],
"additionalProperties" : false
}, {
"description" : "What is added to a strategy once it is attached to a query.",
"type" : "object",
"properties" : {
"avg-execution-ms" : {
"type" : "integer",
"minimum" : 0
},
"invalidated-at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, { } ]
}, {
"type" : "null"
} ]
},
"refresh_automatically" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"schedule" : {
"type" : "string"
},
"type" : {
"const" : "schedule"
}
},
"required" : [ "type", "schedule" ],
"additionalProperties" : false
} ]
},
"metabase.lib.schema.common..add-alias-info.source-table" : {
"description" : "Value of the `:metabase.query-processor.util.add-alias-info/source-table` option\n that [[metabase.query-processor.util.add-alias-info]] adds to a `:field` ref: the ID of the Table the field comes\n from, the (escaped) alias of the join or source query it comes from, or one of the two sentinel keywords that\n namespace uses for 'the source query' and 'nowhere in particular'.",
"anyOf" : [ {
"type" : "string"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "string",
"enum" : [ "metabase.query-processor.util.add-alias-info/source", "metabase.query-processor.util.add-alias-info/none" ]
} ]
},
"metabase.lib.schema.common.base-type" : {
"type" : "string"
},
"metabase.lib.schema.common.coercion-strategy" : {
"type" : "string"
},
"metabase.lib.schema.common.field-value" : {
"description" : "One value of a Field; the `.cljc` equivalent of [[metabase.util.malli.schema/FieldValue]].",
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
}, {
"type" : "string",
"format" : "uuid"
}, { } ]
}, {
"type" : "null"
} ]
},
"metabase.lib.schema.common.kebab-cased-map" : { },
"metabase.lib.schema.common.non-blank-string" : {
"type" : "string",
"minLength" : 1
},
"metabase.lib.schema.common.options" : {
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"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"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"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/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"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/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"required" : [ "lib/uuid" ],
"additionalProperties" : false
},
"metabase.lib.schema.common.positive-number" : { },
"metabase.lib.schema.common.semantic-or-relation-type" : {
"description" : "valid semantic or relation type",
"type" : "string"
},
"metabase.lib.schema.common.uuid" : {
"type" : "string",
"minLength" : 36,
"maxLength" : 36
},
"metabase.lib.schema.common.visualization-settings" : {
"description" : "visualization settings",
"type" : "object",
"properties" : { }
},
"metabase.lib.schema.compiled-native-query" : {
"description" : "drivers add their own keys to a compiled query, and an already-native query compiles to its whole native stage",
"type" : "object",
"properties" : {
"params" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.param-value"
}
}, {
"type" : "null"
} ]
},
"query" : {
"$ref" : "#/components/schemas/metabase.lib.schema.driver-native-query"
}
},
"required" : [ "query" ]
},
"metabase.lib.schema.constraints.constraints" : {
"description" : "Additional constraints added to a query limiting the maximum number of rows that can be returned. Mostly useful\n because native queries don't support the MBQL `:limit` clause. For MBQL queries, if `:limit` is set, it will\n override these values.",
"type" : "object",
"properties" : {
"max-results" : {
"description" : "Maximum number of results to allow for a query with aggregations. If `max-results-bare-rows` is unset, this\n applies to all queries",
"type" : "integer",
"minimum" : 0
},
"max-results-bare-rows" : {
"description" : "Maximum number of results to allow for a query with no aggregations. If set, this should be LOWER than\n `:max-results`.",
"type" : "integer",
"minimum" : 0
}
},
"additionalProperties" : false
},
"metabase.lib.schema.deduplicate-refs-ignoring-source-field-name-when-possible" : { },
"metabase.lib.schema.driver-native-query" : {
"description" : "A driver's native query: a native query document, or a form in the driver's own shape such as a keyword-keyed map decoded from a JSON request.",
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.native-query-document-value"
}, {
"description" : "a driver's native query in the driver's own shape, e.g. a keyword-keyed map from a JSON request"
} ]
},
"metabase.lib.schema.expression..expression.definition" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"metabase.lib.schema.expression.arithmetic..args.numbers" : { },
"metabase.lib.schema.expression.arithmetic.plus-minus-numeric-schema" : { },
"metabase.lib.schema.expression.arithmetic.plus-minus-temporal-interval-schema" : {
"allOf" : [ ]
},
"metabase.lib.schema.expression.arithmetic.temporal-difference-schema" : { },
"metabase.lib.schema.expression.boolean" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
} ]
},
"metabase.lib.schema.expression.equality-comparable" : {
"oneOf" : [ {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
} ]
}, {
"type" : "null"
} ]
},
"metabase.lib.schema.expression.expression" : {
"oneOf" : [ {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
} ]
}, {
"type" : "null"
} ]
},
"metabase.lib.schema.expression.expressions" : {
"description" : "The `:expressions` definition map as found as a top-level key in an MBQL stage.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression..expression.definition"
},
"minItems" : 1
},
"metabase.lib.schema.expression.integer" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
} ]
},
"metabase.lib.schema.expression.number" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
} ]
},
"metabase.lib.schema.expression.orderable" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
} ]
},
"metabase.lib.schema.expression.positive-integer-or-numeric-expression" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.integer"
},
"metabase.lib.schema.expression.string" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
} ]
},
"metabase.lib.schema.expression.temporal" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
} ]
},
"metabase.lib.schema.expression.temporal..absolute-datetime.base-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
"metabase.lib.schema.expression.temporal..absolute-datetime.options" : {
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"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"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"base-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
"lib/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"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/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"required" : [ "lib/uuid" ],
"additionalProperties" : false
},
"metabase.lib.schema.expression.temporal..relative-datetime.amount" : {
"oneOf" : [ {
"const" : "current"
}, {
"type" : "integer"
} ]
},
"metabase.lib.schema.expression.temporal..relative-datetime.unit" : {
"anyOf" : [ {
"const" : "default"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.date-time.interval"
} ]
},
"metabase.lib.schema.expression.temporal..temporal-extract.unit" : {
"type" : "string",
"enum" : [ "year-of-era", "quarter-of-year", "month-of-year", "week-of-year-iso", "week-of-year-us", "week-of-year-instance", "day-of-month", "day-of-week", "day-of-week-iso", "hour-of-day", "minute-of-hour", "second-of-minute" ]
},
"metabase.lib.schema.expression.temporal.datetime-diff-unit" : {
"type" : "string",
"enum" : [ "day", "week", "month", "quarter", "year", "second", "minute", "hour" ]
},
"metabase.lib.schema.expression.temporal.timezone-id" : {
"allOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"anyOf" : [ {
"type" : "string"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal..string.zone-offset"
} ]
} ]
},
"metabase.lib.schema.expression.temporal.week-mode" : {
"type" : "string",
"enum" : [ "iso", "us", "instance" ]
},
"metabase.lib.schema.expression.window..offset.n" : {
"type" : "integer"
},
"metabase.lib.schema.external-remapping" : {
"description" : "One external (Dimension) column remapping, as recorded on a query or stage\n by [[metabase.query-processor.middleware.add-remaps]]. Mirrors `:metabase.query-processor.middleware.add-remaps/external-remapping`;\n it is duplicated here because Lib may not depend on the query processor.",
"type" : "object",
"properties" : {
"field-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"field-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"human-readable-field-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"human-readable-field-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "id", "name", "field-id", "field-name", "human-readable-field-id", "human-readable-field-name" ],
"additionalProperties" : false
},
"metabase.lib.schema.external-remappings" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.external-remapping"
}
},
"metabase.lib.schema.fields" : {
"allOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.ref.ref"
},
"minItems" : 1
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.deduplicate-refs-ignoring-source-field-name-when-possible"
} ]
},
"metabase.lib.schema.filter.string-filter-options" : {
"description" : "String filter operator options. Only set for `:contains`, `:does-not-contain`, `:starts-with`, `:ends-with`\n operators.",
"type" : "object",
"properties" : {
"case-sensitive" : {
"type" : "boolean"
}
},
"additionalProperties" : false
},
"metabase.lib.schema.filter.time-interval-options" : {
"description" : "Options for `:time-interval` operator. Note that `:relative-time-interval` does not support these options.",
"type" : "object",
"properties" : {
"include-current" : {
"type" : "boolean"
}
},
"additionalProperties" : false
},
"metabase.lib.schema.filters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
},
"minItems" : 1
},
"metabase.lib.schema.id.action" : {
"description" : "Valid Action ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.card" : {
"description" : "Valid Card ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.collection" : {
"description" : "Valid Collection ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.dashboard" : {
"description" : "Valid Dashboard ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.dashcard" : {
"description" : "Valid DashboardCard ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.database" : {
"description" : "Valid Database ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.dimension" : {
"description" : "Valid Dimension ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.field" : {
"description" : "Valid Field ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.measure" : {
"description" : "Valid Measure ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.metric" : {
"description" : "Valid Metric ID (metrics are Cards with type :metric)",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.pulse" : {
"description" : "Valid Pulse ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.sandbox" : {
"description" : "Valid Sandbox ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.saved-questions-virtual-database" : {
"description" : "The ID used to signify that a database is 'virtual' rather than physical.\n\n A fake integer ID is used so as to minimize the number of changes that need to be made on the frontend -- by using\n something that would otherwise be a legal ID, *nothing* need change there, and the frontend can query against this\n 'database' none the wiser. (This integer ID is negative which means it will never conflict with a *real* database\n ID.)\n\n This ID acts as a sort of flag. The relevant places in the middleware can check whether the DB we're querying is\n this 'virtual' database and take the appropriate actions.",
"const" : -1337
},
"metabase.lib.schema.id.segment" : {
"description" : "Valid legacy Segment ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.snippet" : {
"description" : "Valid Snippet ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.table" : {
"description" : "Valid Table ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.transform" : {
"description" : "Valid Transform ID",
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.user" : {
"description" : "Valid User ID",
"type" : "integer",
"minimum" : 1
},
"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", "action-execute", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "metabot", "metric", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-action-execute", "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", "table-rows-sample", "transform-inspector", "slackbot", "exploration" ]
},
"metabase.lib.schema.info.hash" : {
"type" : "string",
"format" : "byte"
},
"metabase.lib.schema.info.info" : {
"description" : "Schema for query `:info` dictionary, which is used for informational purposes to record information about how a query\n was executed in QueryExecution and other places. It is considered bad form for middleware to change its behavior\n based on this information, don't do it!\n\n TODO - this schema is somewhat misleading because if you use a function\n like [[metabase.query-processor/userland-query]] some of these keys (e.g. `:context`) are in fact required",
"type" : "object",
"properties" : {
"query-hash" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.info.hash"
}, {
"type" : "null"
} ]
},
"action-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.action"
}, {
"type" : "null"
} ]
},
"visualization-settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.visualization-settings"
}, {
"type" : "null"
} ]
},
"lens-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"pivot/original-query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.query"
}, {
"type" : "null"
} ]
},
"executed-by" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"pivot/query-hash" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.info.hash"
}, {
"type" : "null"
} ]
},
"card-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"pivot/result-metadata" : {
"oneOf" : [ {
"oneOf" : [ {
"const" : "none"
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
}
} ]
}, {
"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"
}, {
"type" : "null"
} ]
},
"dashboard-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
}, {
"type" : "null"
} ]
},
"lens-params" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"join_step" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"metadata/model-metadata" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
}
}, {
"type" : "null"
} ]
},
"metadata/own-model-query?" : {
"type" : "boolean"
},
"pulse-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.pulse"
}, {
"type" : "null"
} ]
},
"card-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.lib.schema.join.alias" : {
"description" : "The name used to alias the joined table or query. This is usually generated automatically and generally looks like\n `table__via__field`. You can specify this yourself if you need to reference a joined field with a `:join-alias` in\n the options.",
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.lib.schema.join.condition" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
},
"metabase.lib.schema.join.conditions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.condition"
},
"minItems" : 1
},
"metabase.lib.schema.join.fields" : {
"description" : "The Fields to include in the results *if* a top-level `:fields` clause *is not* specified. This can be either\n `:none`, `:all`, or a sequence of Field clauses.\n\n * `:none`: no Fields from the joined table or nested query are included (unless indirectly included by breakouts or\n other clauses). This is the default, and what is used for automatically-generated joins.\n\n * `:all`: will include all of the Fields from the joined table or query\n\n * a sequence of Field clauses: include only the Fields specified. Only `:field` clauses are allowed here! References\n to expressions or aggregations in the thing we're joining should use column literal (string column name) `:field`\n references. This should be non-empty and all elements should be distinct (ignoring `:lib/uuid`).",
"oneOf" : [ {
"type" : "string",
"enum" : [ "all", "none" ]
}, {
"allOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/mbql.clause.field"
},
"minItems" : 1
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
} ]
} ]
},
"metabase.lib.schema.join.join" : {
"allOf" : [ {
"default" : { },
"type" : "object",
"properties" : {
"fk-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"lib/type" : {
"default" : "mbql/join",
"const" : "mbql/join"
},
"strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.strategy"
},
"fk-field-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.join/replace-alias" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"metabase.query-processor.middleware.add-implicit-joins/original-position" : {
"type" : "integer",
"minimum" : 0
},
"stages" : {
"$ref" : "#/components/schemas/metabase.lib.schema.stages"
},
"fk-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"fields" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.fields"
},
"alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/is-implicit-join" : {
"type" : "boolean"
},
"qp/keep-default-join-alias" : {
"type" : "boolean"
},
"conditions" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.conditions"
},
"metabase.query-processor.util.add-alias-info/original-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}
},
"required" : [ "stages", "conditions", "alias" ],
"additionalProperties" : false
}, {
"allOf" : [ ]
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.join.validate-field-aliases-match-join-alias"
} ]
},
"metabase.lib.schema.join.joins" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.join"
},
"minItems" : 1
},
"metabase.lib.schema.join.strategy" : {
"description" : "Valid values for the optional `:strategy` key in a join. Note that these are only valid if the current Database\n supports that specific join type; these match 1:1 with the Database `:features`, e.g. a Database that supports left\n joins will support the `:left-join` feature.\n\n When `:strategy` is not specified, [[default-strategy]] is used.",
"default" : "left-join",
"type" : "string",
"enum" : [ "left-join", "right-join", "inner-join", "full-join" ]
},
"metabase.lib.schema.join.validate-field-aliases-match-join-alias" : { },
"metabase.lib.schema.literal..string.date" : {
"type" : "string",
"pattern" : "^\\d{4}-\\d{2}-\\d{2}$"
},
"metabase.lib.schema.literal..string.datetime" : {
"anyOf" : [ {
"type" : "string",
"pattern" : "^\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?$"
}, {
"type" : "string",
"pattern" : "^\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))$"
} ]
},
"metabase.lib.schema.literal..string.time" : {
"anyOf" : [ {
"type" : "string",
"pattern" : "^\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?$"
}, {
"type" : "string",
"pattern" : "^\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))$"
} ]
},
"metabase.lib.schema.literal..string.year" : {
"type" : "string",
"pattern" : "^\\d{4}$"
},
"metabase.lib.schema.literal..string.year-month" : {
"type" : "string",
"pattern" : "^\\d{4}-\\d{2}$"
},
"metabase.lib.schema.literal..string.zone-offset" : {
"type" : "string",
"pattern" : "^(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))$"
},
"metabase.lib.schema.literal..value.options" : {
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"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"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"coercion-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"effective-type" : {
"type" : "string"
},
"base-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"lib/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"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/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"required" : [ "lib/uuid", "effective-type" ],
"additionalProperties" : false
},
"metabase.lib.schema.literal..value.value" : {
"description" : "The value slot of a `:value` clause: a single literal that is not a Clojure collection."
},
"metabase.lib.schema.literal.date" : {
"anyOf" : [ { }, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal..string.date"
} ]
},
"metabase.lib.schema.literal.datetime" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.literal..string.datetime"
}, { }, { }, { } ]
},
"metabase.lib.schema.literal.integer" : {
"anyOf" : [ {
"type" : "integer"
}, { } ]
},
"metabase.lib.schema.literal.jvm.big-decimal" : { },
"metabase.lib.schema.literal.jvm.float" : { },
"metabase.lib.schema.literal.literal" : {
"anyOf" : [ {
"type" : "null"
}, {
"type" : "boolean"
}, {
"type" : "string"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.integer"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.non-integer-real"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.temporal"
} ]
},
"metabase.lib.schema.literal.non-integer-real" : {
"anyOf" : [ {
"type" : "number"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.jvm.float"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.jvm.big-decimal"
} ]
},
"metabase.lib.schema.literal.param-value" : {
"description" : "A value bound to a native query parameter: a literal or, once the query processor has substituted parameters, a\n UUID or a `java.time` object.",
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}, {
"type" : "string",
"format" : "uuid"
}, { } ]
},
"metabase.lib.schema.literal.temporal" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.date"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.time"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.datetime"
} ]
},
"metabase.lib.schema.literal.time" : {
"description" : "time literal",
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.literal..string.time"
}, { }, { } ]
},
"metabase.lib.schema.mbql-clause.clause" : {
"oneOf" : [ { }, {
"$ref" : "#/components/schemas/mbql.clause._BANG__EQ_"
}, {
"$ref" : "#/components/schemas/mbql.clause._STAR_"
}, {
"$ref" : "#/components/schemas/mbql.clause._PLUS_"
}, {
"$ref" : "#/components/schemas/mbql.clause.-"
}, {
"$ref" : "#/components/schemas/mbql.clause._SLASH_"
}, {
"$ref" : "#/components/schemas/mbql.clause._LT_"
}, {
"$ref" : "#/components/schemas/mbql.clause._LT__EQ_"
}, {
"$ref" : "#/components/schemas/mbql.clause._EQ_"
}, {
"$ref" : "#/components/schemas/mbql.clause._GT_"
}, {
"$ref" : "#/components/schemas/mbql.clause._GT__EQ_"
}, {
"$ref" : "#/components/schemas/mbql.clause.abs"
}, {
"$ref" : "#/components/schemas/mbql.clause.absolute-datetime"
}, {
"$ref" : "#/components/schemas/mbql.clause.aggregation"
}, {
"$ref" : "#/components/schemas/mbql.clause.and"
}, {
"$ref" : "#/components/schemas/mbql.clause.asc"
}, {
"$ref" : "#/components/schemas/mbql.clause.avg"
}, {
"$ref" : "#/components/schemas/mbql.clause.between"
}, {
"$ref" : "#/components/schemas/mbql.clause.case"
}, {
"$ref" : "#/components/schemas/mbql.clause.ceil"
}, {
"$ref" : "#/components/schemas/mbql.clause.coalesce"
}, {
"$ref" : "#/components/schemas/mbql.clause.collate"
}, {
"$ref" : "#/components/schemas/mbql.clause.concat"
}, {
"$ref" : "#/components/schemas/mbql.clause.contains"
}, {
"$ref" : "#/components/schemas/mbql.clause.convert-timezone"
}, {
"$ref" : "#/components/schemas/mbql.clause.count"
}, {
"$ref" : "#/components/schemas/mbql.clause.count-where"
}, {
"$ref" : "#/components/schemas/mbql.clause.cum-count"
}, {
"$ref" : "#/components/schemas/mbql.clause.cum-sum"
}, {
"$ref" : "#/components/schemas/mbql.clause.date"
}, {
"$ref" : "#/components/schemas/mbql.clause.datetime"
}, {
"$ref" : "#/components/schemas/mbql.clause.datetime-add"
}, {
"$ref" : "#/components/schemas/mbql.clause.datetime-diff"
}, {
"$ref" : "#/components/schemas/mbql.clause.datetime-subtract"
}, {
"$ref" : "#/components/schemas/mbql.clause.day-name"
}, {
"$ref" : "#/components/schemas/mbql.clause.desc"
}, {
"$ref" : "#/components/schemas/mbql.clause.distinct"
}, {
"$ref" : "#/components/schemas/mbql.clause.distinct-where"
}, {
"$ref" : "#/components/schemas/mbql.clause.does-not-contain"
}, {
"$ref" : "#/components/schemas/mbql.clause.domain"
}, {
"$ref" : "#/components/schemas/mbql.clause.during"
}, {
"$ref" : "#/components/schemas/mbql.clause.ends-with"
}, {
"$ref" : "#/components/schemas/mbql.clause.exp"
}, {
"$ref" : "#/components/schemas/mbql.clause.expression"
}, {
"$ref" : "#/components/schemas/mbql.clause.field"
}, {
"$ref" : "#/components/schemas/mbql.clause.float"
}, {
"$ref" : "#/components/schemas/mbql.clause.floor"
}, {
"$ref" : "#/components/schemas/mbql.clause.get-day"
}, {
"$ref" : "#/components/schemas/mbql.clause.get-day-of-week"
}, {
"$ref" : "#/components/schemas/mbql.clause.get-hour"
}, {
"$ref" : "#/components/schemas/mbql.clause.get-minute"
}, {
"$ref" : "#/components/schemas/mbql.clause.get-month"
}, {
"$ref" : "#/components/schemas/mbql.clause.get-quarter"
}, {
"$ref" : "#/components/schemas/mbql.clause.get-second"
}, {
"$ref" : "#/components/schemas/mbql.clause.get-week"
}, {
"$ref" : "#/components/schemas/mbql.clause.get-year"
}, {
"$ref" : "#/components/schemas/mbql.clause.host"
}, {
"$ref" : "#/components/schemas/mbql.clause.if"
}, {
"$ref" : "#/components/schemas/mbql.clause.in"
}, {
"$ref" : "#/components/schemas/mbql.clause.inside"
}, {
"$ref" : "#/components/schemas/mbql.clause.integer"
}, {
"$ref" : "#/components/schemas/mbql.clause.interval"
}, {
"$ref" : "#/components/schemas/mbql.clause.is-empty"
}, {
"$ref" : "#/components/schemas/mbql.clause.is-null"
}, {
"$ref" : "#/components/schemas/mbql.clause.length"
}, {
"$ref" : "#/components/schemas/mbql.clause.log"
}, {
"$ref" : "#/components/schemas/mbql.clause.lower"
}, {
"$ref" : "#/components/schemas/mbql.clause.ltrim"
}, {
"$ref" : "#/components/schemas/mbql.clause.max"
}, {
"$ref" : "#/components/schemas/mbql.clause.measure"
}, {
"$ref" : "#/components/schemas/mbql.clause.median"
}, {
"$ref" : "#/components/schemas/mbql.clause.metric"
}, {
"$ref" : "#/components/schemas/mbql.clause.min"
}, {
"$ref" : "#/components/schemas/mbql.clause.month-name"
}, {
"$ref" : "#/components/schemas/mbql.clause.not"
}, {
"$ref" : "#/components/schemas/mbql.clause.not-empty"
}, {
"$ref" : "#/components/schemas/mbql.clause.not-in"
}, {
"$ref" : "#/components/schemas/mbql.clause.not-null"
}, {
"$ref" : "#/components/schemas/mbql.clause.now"
}, {
"$ref" : "#/components/schemas/mbql.clause.offset"
}, {
"$ref" : "#/components/schemas/mbql.clause.or"
}, {
"$ref" : "#/components/schemas/mbql.clause.path"
}, {
"$ref" : "#/components/schemas/mbql.clause.percentile"
}, {
"$ref" : "#/components/schemas/mbql.clause.power"
}, {
"$ref" : "#/components/schemas/mbql.clause.quarter-name"
}, {
"$ref" : "#/components/schemas/mbql.clause.regex-match-first"
}, {
"$ref" : "#/components/schemas/mbql.clause.relative-datetime"
}, {
"$ref" : "#/components/schemas/mbql.clause.relative-time-interval"
}, {
"$ref" : "#/components/schemas/mbql.clause.replace"
}, {
"$ref" : "#/components/schemas/mbql.clause.round"
}, {
"$ref" : "#/components/schemas/mbql.clause.rtrim"
}, {
"$ref" : "#/components/schemas/mbql.clause.segment"
}, {
"$ref" : "#/components/schemas/mbql.clause.share"
}, {
"$ref" : "#/components/schemas/mbql.clause.split-part"
}, {
"$ref" : "#/components/schemas/mbql.clause.sqrt"
}, {
"$ref" : "#/components/schemas/mbql.clause.starts-with"
}, {
"$ref" : "#/components/schemas/mbql.clause.stddev"
}, {
"$ref" : "#/components/schemas/mbql.clause.subdomain"
}, {
"$ref" : "#/components/schemas/mbql.clause.substring"
}, {
"$ref" : "#/components/schemas/mbql.clause.sum"
}, {
"$ref" : "#/components/schemas/mbql.clause.sum-where"
}, {
"$ref" : "#/components/schemas/mbql.clause.temporal-extract"
}, {
"$ref" : "#/components/schemas/mbql.clause.text"
}, {
"$ref" : "#/components/schemas/mbql.clause.time"
}, {
"$ref" : "#/components/schemas/mbql.clause.time-interval"
}, {
"$ref" : "#/components/schemas/mbql.clause.today"
}, {
"$ref" : "#/components/schemas/mbql.clause.trim"
}, {
"$ref" : "#/components/schemas/mbql.clause.upper"
}, {
"$ref" : "#/components/schemas/mbql.clause.value"
}, {
"$ref" : "#/components/schemas/mbql.clause.var"
} ]
},
"metabase.lib.schema.metadata..card.result-metadata" : {
"description" : "Schema for the `:result-metadata` for a Card (Saved Question, Model, or v2 Metric).",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
}
},
"metabase.lib.schema.metadata..card.type" : {
"description" : "All acceptable card types.\n\n Previously (< 49), we only had 2 card types: question and model, which were differentiated using the boolean\n `dataset` column. Soon we'll have more card types (e.g: metric) and we will longer be able to use a boolean column\n to differentiate between all types. So we've added a new `type` column for this purpose.\n\n Migrating all the code to use `report_card.type` will be quite an effort, we decided that we'll migrate it\n gradually.",
"type" : "string",
"enum" : [ "question", "metric", "model" ]
},
"metabase.lib.schema.metadata..column.binning-info" : {
"description" : "The legacy description of how a column was binned, as [[metabase.lib.metadata.result-metadata]] spells it out for\n the frontend.",
"type" : "object",
"properties" : {
"max-value" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
}, {
"type" : "null"
} ]
},
"max_value" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"bin_width" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"num_bins" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"bin-width" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"num-bins" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"min_value" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"binning_strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
}, {
"type" : "null"
} ]
},
"binning-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
}, {
"type" : "null"
} ]
},
"min-value" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.lib.schema.metadata..column.data-sensitivity" : {
"type" : "string",
"enum" : [ "SEC_KEY", "SYS_TELEMETRY", "PHI", "BIO_GEN", "PCI_FIN", "SENS_PERS", "PII", "CORP_IP", "BIZ_CONF", "PUBLIC" ]
},
"metabase.lib.schema.metadata..column.has-field-values" : {
"type" : "string",
"enum" : [ "auto-list", "list", "none", "search" ]
},
"metabase.lib.schema.metadata..column.legacy-source" : {
"description" : "Possible values for `column.source` -- this is added by [[metabase.lib.metadata.result-metadata]] for historical\n reasons (it is used in a few places in the FE). DO NOT use this in the backend for any purpose, use `:lib/source`\n instead.",
"type" : "string",
"enum" : [ "aggregation", "fields", "breakout", "native" ]
},
"metabase.lib.schema.metadata..column.lib-options" : {
"description" : "What [[metabase.lib.options/with-options]] puts under `:lib/options` when it is handed a column rather than a\n clause: the expression name [[metabase.lib.fe-util/expression-parts]] pins on an expression column, and a `:lib/uuid`\n if something asked for one.",
"type" : "object",
"properties" : {
"lib/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}
},
"additionalProperties" : false
},
"metabase.lib.schema.metadata..column.map" : {
"description" : "The map portion of [[::column]], without its constraints.",
"type" : "object",
"properties" : {
"visibility-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.pivot/idx" : {
"type" : "integer",
"minimum" : 0
},
"field-values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.field-value"
}
}, {
"type" : "null"
} ]
},
"remapped-from-index" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"remapped-to" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/original" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
"lib/original-join-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"fk-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"database-default" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
"database-partitioned" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/remove-join-alias?" : {
"type" : "boolean"
},
"lib/external-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
}, {
"type" : "null"
} ]
},
"inherited-temporal-unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-column-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.source-column-alias"
}, {
"type" : "null"
} ]
},
"database-type" : {
"oneOf" : [ {
"type" : "string"
}, {
"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"
},
"database-required" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"binning-info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.binning-info"
}, {
"type" : "null"
} ]
},
"coercion-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
}, {
"type" : "null"
} ]
},
"settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.visualization-settings"
}, {
"type" : "null"
} ]
},
"fingerprint" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
}, {
"type" : "null"
} ]
},
"table-id" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "string",
"pattern" : "^card__\\d+$"
} ]
}, {
"type" : "null"
} ]
},
"converted-timezone" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-uuid" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/join-field" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"order-by-position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"data-sensitivity" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.data-sensitivity"
}, {
"type" : "null"
} ]
},
"qp/implicit-field?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/ref-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension/id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
}, {
"type" : "null"
} ]
},
"metabase.lib.join/target" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
"id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"lib/deduplicated-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.deduplicated-name"
},
"base-type" : {
"default" : "type/*",
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
"lib/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"breakout-positions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer"
}
}, {
"type" : "null"
} ]
},
"fingerprint-version" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"values/values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"lib/original-expression-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"fk-field-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/from-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"updated-at" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
}, {
"type" : "null"
} ]
},
"lib/original-fk-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"lib/original-fk-field-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/card-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/temporal-unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"lib/expression-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"lib/breakout?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"values/human-readable-values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"last-analyzed" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
}, {
"type" : "null"
} ]
},
"database-is-pk" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"json-unfolding" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/original-effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"lib/join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"created-at" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
}, {
"type" : "null"
} ]
},
"lib/source-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"nfc-path" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "string"
}
}, {
"type" : "null"
} ]
},
"remapping" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"preview-display" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"dimension/human-readable-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"lib/original-fk-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.propagate-coercion?" : {
"type" : "boolean"
},
"has-field-values" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
}, {
"type" : "null"
} ]
},
"metabase.lib.join/HACK-from-incomplete-join?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
}, {
"type" : "null"
} ]
},
"selected?" : {
"type" : "boolean"
},
"database-is-generated" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.lib-options"
}, {
"type" : "null"
} ]
},
"fk-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"target" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
} ]
}, {
"type" : "null"
} ]
},
"lib/original-binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
}, {
"type" : "null"
} ]
},
"lib/original-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"lib/original-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.field.resolution/fallback-metadata?" : {
"type" : "boolean"
},
"unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"remapped-from" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"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"
}, {
"type" : "null"
} ]
},
"database-indexed" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"caveats" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
}, {
"type" : "null"
} ]
},
"database-is-auto-increment" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"active" : {
"type" : "boolean"
},
"points-of-interest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"filter-positions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer"
}
}, {
"type" : "null"
} ]
},
"options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.options"
}, {
"type" : "null"
} ]
},
"lib/ref-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension-interestingness" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"dimension/type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "internal", "external" ]
}, {
"type" : "null"
} ]
},
"lib/original-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
},
"name-field" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
} ]
}, {
"type" : "null"
} ]
},
"database-position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"lib/original-ref-style-for-result-metadata-purposes" : {
"type" : "string",
"enum" : [ "original-ref-style/id", "original-ref-style/name" ]
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/inherited?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"fk-target-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"custom-position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"dimension/name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"parent-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"lib/simple-display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"database-is-nullable" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/desired-column-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
},
"metabase.lib.schema.metadata..column.options" : {
"description" : "What the query processor stashes under a column's `:options` while it runs: never sent by a client, and never\n handed back to one.",
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.propagate-coercion?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"additionalProperties" : false
},
"metabase.lib.schema.metadata..column.remapping.external" : {
"description" : "External remapping (Dimension) for a column. From the [[metabase.warehouse-schema.models.dimension]] with `type =\n external` associated with a `Field` in the application database.\n See [[metabase.query-processor.middleware.add-remaps]] for what this means.",
"type" : "object",
"properties" : {
"field-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"lib/type" : {
"const" : "metadata.column.remapping/external"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "lib/type", "id", "name", "field-id" ],
"additionalProperties" : false
},
"metabase.lib.schema.metadata..column.remapping.internal" : {
"description" : "Internal remapping (FieldValues) for a column. From [[metabase.warehouse-schema.models.dimension]] with `type =\n internal` and the [[metabase.warehouse-schema.models.field-values]] associated with a `Field` in the application\n database. See [[metabase.query-processor.middleware.add-remaps]] for what this means.",
"type" : "object",
"properties" : {
"human-readable-values" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"lib/type" : {
"const" : "metadata.column.remapping/internal"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"values" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}
},
"required" : [ "lib/type", "id", "name", "values", "human-readable-values" ],
"additionalProperties" : false
},
"metabase.lib.schema.metadata..column.snapshot" : {
"description" : "A whole column metadata map stashed on *another* column under one of the internal keys below: the same shape as\n [[::column]] minus the `:and`-level constraints, so validating the stashed copy does not re-run those constraints\n against the column it was copied from.",
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.map"
},
"metabase.lib.schema.metadata..column.source" : {
"description" : "`:lib/source` -- where a column came from with respect to the current stage.\n\n Traditionally, `:lib/source` meant something slightly different -- it denoted what part of the current stage a\n column came from, and thus included two additional options -- `:source/fields`, for columns used by `:fields`, and\n `:source/breakouts`, for columns used in `:breakout`. This was not really useful information and made `:lib/source`\n itself useless for determining if a column was 'inherited' or not (i.e., whether it came from a previous stage,\n source card, or a join, and should get field name refs instead of field ID refs --\n see [[metabase.lib.field.util/inherited-column?]]).",
"type" : "string",
"enum" : [ "source/card", "source/native", "source/previous-stage", "source/table-defaults", "source/aggregations", "source/joins", "source/expressions", "source/implicitly-joinable", "source/pivot-grouping" ]
},
"metabase.lib.schema.metadata..column.timestamp" : {
"description" : "A timestamp column of a `metabase_field` row: a `java.time` value on the JVM, the string it was encoded as elsewhere.",
"anyOf" : [ {
"type" : "string"
}, { } ]
},
"metabase.lib.schema.metadata..column.validate-for-source" : {
"description" : "Do additional validation for column metadata based on `:lib/source`.",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-card"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-native"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-previous-stage"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-table-defaults"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-aggregations"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-joins"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-expressions"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-pivot-grouping"
}, { } ]
},
"metabase.lib.schema.metadata..column.validate-for-source-aggregations" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-card" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-expressions" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-joins" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-native" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-pivot-grouping" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-previous-stage" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-table-defaults" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.visibility-type" : {
"type" : "string",
"enum" : [ "retired", "sensitive", "normal", "hidden", "details-only" ]
},
"metabase.lib.schema.metadata..dimension-mapping.target" : {
"description" : "Target field reference for a dimension mapping, e.g. [:field {:source-field 1} 2].",
"$ref" : "#/components/schemas/mbql.clause.field"
},
"metabase.lib.schema.metadata..dimension-mapping.type" : {
"description" : "Type of dimension mapping.",
"type" : "string",
"enum" : [ "table" ]
},
"metabase.lib.schema.metadata..dimension-source.type" : {
"type" : "string",
"enum" : [ "field" ]
},
"metabase.lib.schema.metadata.column" : {
"description" : "Malli schema for a valid map of column metadata, which can mean one of two things:\n\n 1. Metadata about a particular Field in the application database. This will always have an `:id`\n\n 2. Results metadata from a column in `data.cols` and/or `data.results_metadata.columns` in a Query Processor\n response, or saved in something like `Card.result_metadata`. These *may* have an `:id`, or may not -- columns\n coming back from native queries or things like `SELECT count(*)` aren't associated with any particular `Field`\n and thus will not have an `:id`.\n\n Now maybe these should be two different schemas, but `:id` being there or not is the only real difference; besides\n that they are largely compatible. So they're the same for now. We can revisit this in the future if we actually want\n to differentiate between the two versions.",
"allOf" : [ {
"type" : "object",
"properties" : {
"visibility-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.pivot/idx" : {
"type" : "integer",
"minimum" : 0
},
"field-values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.field-value"
}
}, {
"type" : "null"
} ]
},
"remapped-from-index" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"remapped-to" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/original" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
"lib/original-join-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"fk-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"database-default" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
"database-partitioned" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/remove-join-alias?" : {
"type" : "boolean"
},
"lib/external-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
}, {
"type" : "null"
} ]
},
"inherited-temporal-unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-column-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.source-column-alias"
}, {
"type" : "null"
} ]
},
"database-type" : {
"oneOf" : [ {
"type" : "string"
}, {
"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"
},
"database-required" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"binning-info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.binning-info"
}, {
"type" : "null"
} ]
},
"coercion-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
}, {
"type" : "null"
} ]
},
"settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.visualization-settings"
}, {
"type" : "null"
} ]
},
"fingerprint" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
}, {
"type" : "null"
} ]
},
"table-id" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "string",
"pattern" : "^card__\\d+$"
} ]
}, {
"type" : "null"
} ]
},
"converted-timezone" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-uuid" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/join-field" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"order-by-position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"data-sensitivity" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.data-sensitivity"
}, {
"type" : "null"
} ]
},
"qp/implicit-field?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/ref-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension/id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
}, {
"type" : "null"
} ]
},
"metabase.lib.join/target" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
"id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"lib/deduplicated-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.deduplicated-name"
},
"base-type" : {
"default" : "type/*",
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
"lib/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"breakout-positions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer"
}
}, {
"type" : "null"
} ]
},
"fingerprint-version" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"values/values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"lib/original-expression-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"fk-field-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/from-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"updated-at" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
}, {
"type" : "null"
} ]
},
"lib/original-fk-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"lib/original-fk-field-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/card-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/temporal-unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"lib/expression-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"lib/breakout?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"values/human-readable-values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"last-analyzed" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
}, {
"type" : "null"
} ]
},
"database-is-pk" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"json-unfolding" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/original-effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"lib/join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"created-at" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
}, {
"type" : "null"
} ]
},
"lib/source-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"nfc-path" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "string"
}
}, {
"type" : "null"
} ]
},
"remapping" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"preview-display" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"dimension/human-readable-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"lib/original-fk-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.propagate-coercion?" : {
"type" : "boolean"
},
"has-field-values" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
}, {
"type" : "null"
} ]
},
"metabase.lib.join/HACK-from-incomplete-join?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
}, {
"type" : "null"
} ]
},
"selected?" : {
"type" : "boolean"
},
"database-is-generated" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.lib-options"
}, {
"type" : "null"
} ]
},
"fk-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"target" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
} ]
}, {
"type" : "null"
} ]
},
"lib/original-binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
}, {
"type" : "null"
} ]
},
"lib/original-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"lib/original-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.field.resolution/fallback-metadata?" : {
"type" : "boolean"
},
"unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"remapped-from" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"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"
}, {
"type" : "null"
} ]
},
"database-indexed" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"caveats" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
}, {
"type" : "null"
} ]
},
"database-is-auto-increment" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"active" : {
"type" : "boolean"
},
"points-of-interest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"filter-positions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer"
}
}, {
"type" : "null"
} ]
},
"options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.options"
}, {
"type" : "null"
} ]
},
"lib/ref-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension-interestingness" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"dimension/type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "internal", "external" ]
}, {
"type" : "null"
} ]
},
"lib/original-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
},
"name-field" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
} ]
}, {
"type" : "null"
} ]
},
"database-position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"lib/original-ref-style-for-result-metadata-purposes" : {
"type" : "string",
"enum" : [ "original-ref-style/id", "original-ref-style/name" ]
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/inherited?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"fk-target-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"custom-position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"dimension/name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"parent-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"lib/simple-display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"database-is-nullable" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/desired-column-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
}, {
"allOf" : [ ]
} ]
},
"metabase.lib.schema.metadata.deduplicated-name" : {
"description" : "The simply-deduplicated name that was historically used in QP results metadata (originally calculated by\n the [[metabase.query-processor.middleware.annotate]] middleware, now calculated\n by [[metabase.lib.middleware.result-metadata]]). This just adds suffixes to column names e.g. `ID` and `ID` become\n `ID` and `ID_2`, respectively. Kept around because many old field refs use this column name.",
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.schema.metadata.desired-column-alias" : {
"description" : "Name we should use as a column alias for a column in this stage of a query. The desired column alias in stage N\n becomes the source column alias in stage N+1. The right-hand side (RHS) in\n\n SELECT lhs AS rhs",
"type" : "string"
},
"metabase.lib.schema.metadata.dimension-group" : {
"description" : "Group descriptor for a dimension, indicating which table it belongs to.",
"type" : "object",
"properties" : {
"display-name" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "main", "connection" ]
}
},
"required" : [ "id", "type", "display-name" ],
"additionalProperties" : false
},
"metabase.lib.schema.metadata.dimension-id" : {
"description" : "UUID string identifying a dimension.",
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
},
"metabase.lib.schema.metadata.dimension-source" : {
"type" : "object",
"properties" : {
"binning" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..dimension-source.type"
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.lib.schema.metadata.dimension-status" : {
"description" : "Status of a dimension indicating whether it's active or has issues.\n - :status/active - Column exists, dimension is usable\n - :status/orphaned - Column was removed from schema, dimension preserved for reference",
"type" : "string",
"enum" : [ "status/active", "status/orphaned" ]
},
"metabase.lib.schema.metadata.fingerprint..fingerprint.global" : {
"description" : "Fingerprint values that Fields of all types should have.",
"type" : "object",
"properties" : {
"distinct-count" : {
"type" : "integer"
},
"nil%" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.lib.schema.metadata.fingerprint..fingerprint.number" : {
"description" : "Schema for fingerprint information for Fields deriving from `:type/Number`.",
"type" : "object",
"properties" : {
"mode-fraction" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
"min" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"q1" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"max" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"avg" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"sd" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"skewness" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"q3" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"top-3-fraction" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
"excess-kurtosis" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"zero-fraction" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.lib.schema.metadata.fingerprint..fingerprint.temporal" : {
"description" : "Schema for fingerprint information for Fields deriving from `:type/Temporal`.",
"type" : "object",
"properties" : {
"earliest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"hour-distribution" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}
}, {
"type" : "null"
} ]
},
"latest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"mode-fraction" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
"skewness" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"top-3-fraction" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
"weekday-distribution" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.lib.schema.metadata.fingerprint..fingerprint.text" : {
"description" : "Schema for fingerprint information for Fields deriving from `:type/Text`.",
"type" : "object",
"properties" : {
"mode-fraction" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
"percent-json" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
"percent-blank" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
"percent-url" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
"percent-state" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
"percent-email" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
"max-length" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"average-length" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"min-length" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"top-3-fraction" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.lib.schema.metadata.fingerprint..fingerprint.type-specific" : {
"description" : "Schema for type-specific fingerprint information.",
"type" : "object",
"properties" : {
"type/Date" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.temporal"
},
"type/DateTime" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.temporal"
},
"type/Number" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.number"
},
"type/Text" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.text"
},
"type/Time" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.temporal"
}
},
"additionalProperties" : false
},
"metabase.lib.schema.metadata.fingerprint.fingerprint" : {
"description" : "Schema for a Field 'fingerprint' generated as part of the analysis stage. Used to power the 'classification'\n sub-stage of analysis. Stored as the `fingerprint` column of Field.",
"type" : "object",
"properties" : {
"experimental" : {
"type" : "object",
"properties" : { },
"additionalProperties" : false
},
"global" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.global"
},
"type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.type-specific"
}
},
"additionalProperties" : false
},
"metabase.lib.schema.metadata.fingerprint.percent" : {
"description" : "Schema for something represting a percentage. A floating-point value between (inclusive) 0 and 1.",
"type" : "number"
},
"metabase.lib.schema.metadata.lib-or-legacy-column" : {
"description" : "Schema for the maps in card `:result-metadata` and similar. These can be either\n `:metabase.lib.schema.metadata/result-metadata` (i.e., kebab-cased) maps, or map snake_cased as returned by QP\n metadata, but they should NOT be a mixture of both -- if we mixed them somehow there is a bug in our code.",
"oneOf" : [ {
"description" : "Malli schema for a valid map of column metadata, which can mean one of two things:\n\n 1. Metadata about a particular Field in the application database. This will always have an `:id`\n\n 2. Results metadata from a column in `data.cols` and/or `data.results_metadata.columns` in a Query Processor\n response, or saved in something like `Card.result_metadata`. These *may* have an `:id`, or may not -- columns\n coming back from native queries or things like `SELECT count(*)` aren't associated with any particular `Field`\n and thus will not have an `:id`.\n\n Now maybe these should be two different schemas, but `:id` being there or not is the only real difference; besides\n that they are largely compatible. So they're the same for now. We can revisit this in the future if we actually want\n to differentiate between the two versions.",
"allOf" : [ {
"type" : "object",
"properties" : {
"visibility-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.pivot/idx" : {
"type" : "integer",
"minimum" : 0
},
"field-values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.field-value"
}
}, {
"type" : "null"
} ]
},
"remapped-from-index" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"remapped-to" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/original" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
"lib/original-join-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"fk-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"database-default" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
"database-partitioned" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.lib.metadata.result-metadata/remove-join-alias?" : {
"type" : "boolean"
},
"lib/external-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
}, {
"type" : "null"
} ]
},
"inherited-temporal-unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-column-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.source-column-alias"
}, {
"type" : "null"
} ]
},
"database-type" : {
"oneOf" : [ {
"type" : "string"
}, {
"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"
},
"database-required" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"binning-info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.binning-info"
}, {
"type" : "null"
} ]
},
"coercion-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
}, {
"type" : "null"
} ]
},
"settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.visualization-settings"
}, {
"type" : "null"
} ]
},
"fingerprint" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
}, {
"type" : "null"
} ]
},
"table-id" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "string",
"pattern" : "^card__\\d+$"
} ]
}, {
"type" : "null"
} ]
},
"converted-timezone" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-uuid" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/join-field" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"order-by-position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"data-sensitivity" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.data-sensitivity"
}, {
"type" : "null"
} ]
},
"qp/implicit-field?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/ref-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension/id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
}, {
"type" : "null"
} ]
},
"metabase.lib.join/target" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
"id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"lib/deduplicated-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.deduplicated-name"
},
"base-type" : {
"default" : "type/*",
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
"lib/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"breakout-positions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer"
}
}, {
"type" : "null"
} ]
},
"fingerprint-version" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"values/values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"lib/original-expression-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"fk-field-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/from-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"updated-at" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
}, {
"type" : "null"
} ]
},
"lib/original-fk-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"lib/original-fk-field-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/card-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"metabase.lib.underlying/temporal-unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"lib/expression-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"lib/breakout?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"values/human-readable-values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"last-analyzed" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
}, {
"type" : "null"
} ]
},
"database-is-pk" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"json-unfolding" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/original-effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"lib/join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"created-at" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
}, {
"type" : "null"
} ]
},
"lib/source-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"nfc-path" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "string"
}
}, {
"type" : "null"
} ]
},
"remapping" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
"preview-display" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"dimension/human-readable-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"lib/original-fk-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.propagate-coercion?" : {
"type" : "boolean"
},
"has-field-values" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
}, {
"type" : "null"
} ]
},
"metabase.lib.join/HACK-from-incomplete-join?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
}, {
"type" : "null"
} ]
},
"selected?" : {
"type" : "boolean"
},
"database-is-generated" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.lib-options"
}, {
"type" : "null"
} ]
},
"fk-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"target" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
} ]
}, {
"type" : "null"
} ]
},
"lib/original-binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
}, {
"type" : "null"
} ]
},
"lib/original-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"lib/original-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.field.resolution/fallback-metadata?" : {
"type" : "boolean"
},
"unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"remapped-from" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"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"
}, {
"type" : "null"
} ]
},
"database-indexed" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"caveats" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
}, {
"type" : "null"
} ]
},
"database-is-auto-increment" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"active" : {
"type" : "boolean"
},
"points-of-interest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"filter-positions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer"
}
}, {
"type" : "null"
} ]
},
"options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.options"
}, {
"type" : "null"
} ]
},
"lib/ref-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dimension-interestingness" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"dimension/type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "internal", "external" ]
}, {
"type" : "null"
} ]
},
"lib/original-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
},
"name-field" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
} ]
}, {
"type" : "null"
} ]
},
"database-position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"lib/original-ref-style-for-result-metadata-purposes" : {
"type" : "string",
"enum" : [ "original-ref-style/id", "original-ref-style/name" ]
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.driver.mongo.query-processor/inherited?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"fk-target-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"custom-position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"dimension/name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"parent-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"lib/simple-display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"database-is-nullable" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"lib/desired-column-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
}, {
"allOf" : [ ]
} ]
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
} ]
},
"metabase.lib.schema.metadata.metadata-provider" : {
"description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol.",
"$ref" : "#/components/schemas/metabase.lib.metadata.protocols.metadata-provider"
},
"metabase.lib.schema.metadata.original-name" : {
"description" : "The original name of the column as it appeared in the very first place it came from (i.e., the physical name of the\n column in the table it appears in). This should be the same as the `:lib/source-column-alias` for the very first\n usage of the column.\n Allowed to be blank because some databases like SQL Server allow blank column names.",
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.lib.schema.metadata.source-column-alias" : {
"description" : "Name for a column as returned/projected by the previous stage of the query or source Table/source Card. The\n left-hand side (LHS) of\n\n SELECT lhs AS rhs",
"type" : "string"
},
"metabase.lib.schema.metadata.stage" : {
"description" : "Metadata about the columns returned by a particular stage of a MBQL 5 query. For example a single-stage native query\n like\n\n {:database 1\n :lib/type :mbql/query\n :stages [{:lib/type :mbql.stage/mbql\n :native \"SELECT id, name FROM VENUES;\"}]}\n\n might have stage metadata like\n\n {:columns [{:name \"id\", :base-type :type/Integer}\n {:name \"name\", :base-type :type/Text}]}\n\n associated with the query's lone stage.\n\n At some point in the near future we will hopefully attach this metadata directly to each stage in a query, so a\n multi-stage query will have `:lib/stage-metadata` for each stage. The main goal is to facilitate things like\n returning lists of visible or filterable columns for a given stage of a query. This is TBD, see #28717 for a WIP\n implementation of this idea.\n\n This is the same format as the results metadata returned with QP results in `data.results_metadata`. The `:columns`\n portion of this (`data.results_metadata.columns`) is also saved as `Card.result_metadata` for Saved Questions.\n\n Note that queries currently actually come back with both `data.results_metadata` AND `data.cols`; it looks like the\n Frontend actually *merges* these together -- see `applyMetadataDiff` in\n `frontend/src/metabase/query_builder/selectors.js` -- but this is ridiculous. Let's try to merge anything missing in\n `results_metadata` into `cols` going forward so things don't need to be manually merged in the future.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
}
},
"lib/type" : {
"default" : "metadata/results",
"const" : "metadata/results"
}
},
"required" : [ "columns" ],
"additionalProperties" : false
},
"metabase.lib.schema.middleware-options.middleware-options" : {
"description" : "Additional options that can be used to toggle middleware on or off.",
"type" : "object",
"properties" : {
"process-viz-settings?" : {
"description" : "Whether to process a question's visualization settings and include them in the result metadata so that they can\n incorporated into an export. Used by `metabase.query-processor.middleware.visualization-settings`; default\n `false`.",
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"skip-results-metadata?" : {
"description" : "Should we skip adding `results_metadata` to query results after running the query? Used by\n `metabase.query-processor.middleware.results-metadata`; default `false`. (Note: we may change the name of this\n column in the near future, to `result_metadata`, to fix inconsistencies in how we name things.)",
"type" : "boolean"
},
"add-default-userland-constraints?" : {
"description" : "Whether to add some default `max-results` and `max-results-bare-rows` constraints. By default, none are added,\n although the functions that ultimately power most API endpoints tend to set this to `true`. See\n `add-constraints` middleware for more details.",
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"disable-max-results?" : {
"description" : "Disable applying a default limit on the query results. Handled in the `add-default-limit` middleware. If true,\n this will override the `:max-results` and `:max-results-bare-rows` values in `Constraints`.",
"type" : "boolean"
},
"ignore-cached-results?" : {
"description" : "Whether to ignore any cached results and re-run the query. Used by the query results cache middleware; default\n `false`.",
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"csv-include-bom?" : {
"description" : "Whether a CSV download should start with a UTF-8 byte-order mark, which Excel needs to read the file as UTF-8.\n Set by `metabase.query-processor.api` from the download's options and read by\n `metabase.query-processor.middleware.format-rows` and the CSV writer; default `true`.",
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"format-rows?" : {
"description" : "Should we skip converting datetime types to ISO-8601 strings with appropriate timezone when post-processing\n results? Used by `metabase.query-processor.middleware.format-rows`default `false`.",
"type" : "boolean"
},
"pivot-options" : {
"description" : "Which of the query's breakouts and aggregations are the pivot table's rows, columns and measures, and whether it\n shows totals. Attached by `metabase.query-processor.pivot` from the question's visualization settings (or from the\n matching top-level query keys) so the export middleware and streaming writers can lay the results out; not something\n a client sets itself.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"column-sort-order" : {
"oneOf" : [ {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
}, { } ]
}, {
"type" : "null"
} ]
},
"pivot-cols" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"pivot-measures" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"pivot-rows" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"show-column-totals" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"show-row-totals" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"disable-remaps?" : {
"description" : "Whether to skip the remapped (human-readable) columns that `metabase.query-processor.middleware.add-remaps`\n normally splices in. Set by callers that want the query's own columns and nothing else -- calculating a Card's\n result metadata, or fetching field values for a filter widget; default `false`.",
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"js-int-to-string?" : {
"description" : "Whether to convert bigint values in results to strings so that they can be parsed losslessly by JavaScript\n clients. Used by `metabase.query-processor.middleware.large-int`; default `false`.",
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"skip-result-metadata-persistence?" : {
"description" : "Should we skip persisting `result_metadata` to a saved Card while still returning it in query results? Used by\n `metabase.query-processor.middleware.results-metadata`; default `false`. Has no effect when\n `skip-results-metadata?` is true.",
"type" : "boolean"
},
"pivot?" : {
"description" : "Whether the results should be laid out as a pivot table. Set by `metabase.query-processor.api` from the\n `format_rows`/pivot download options and read by `metabase.query-processor.middleware.pivot-export` and the\n streaming writers; default `false`.",
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"disable-mbql->native?" : {
"description" : "Disable the MBQL->native middleware. If you do this, the query will not work at all, so there are no cases where\n you should set this yourself. This is only used by the `metabase.query-processor.preprocess/preprocess` function to\n get the fully pre-processed query without attempting to convert it to native.",
"type" : "boolean"
},
"userland-query?" : {
"description" : "Userland queries are ones ran as a result of an API call, Pulse, or the like. Special handling is done in\n certain userland-only middleware for such queries -- results are returned in a slightly different format, and\n QueryExecution entries are normally saved, unless you pass `:no-save` as the option.",
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.lib.schema.native-query-document-value" : {
"description" : "A value inside a driver's compiled native query document: a scalar, or a nested document/array of them. Covers\n every native query shape drivers in this codebase actually produce -- SQL text (a bare `:string`) as well as\n document-pipeline languages like Mongo's (a `:map-of`/`:sequential` tree).",
"$ref" : "#/components/schemas/metabase.lib.schema.value"
},
"metabase.lib.schema.order-by.direction" : {
"type" : "string",
"enum" : [ "asc", "desc" ]
},
"metabase.lib.schema.order-by.order-by" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/mbql.clause.asc"
}, {
"$ref" : "#/components/schemas/mbql.clause.desc"
} ]
},
"metabase.lib.schema.order-by.order-bys" : {
"allOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.order-by.order-by"
},
"minItems" : 1
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
} ]
},
"metabase.lib.schema.page" : {
"description" : "`page` = page num, starting with 1. `items` = number of items per page.\n e.g.\n\n {:page 1, :items 10} = items 1-10\n {:page 2, :items 10} = items 11-20",
"type" : "object",
"properties" : {
"items" : {
"type" : "integer",
"minimum" : 1
},
"page" : {
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "page", "items" ],
"additionalProperties" : false
},
"metabase.lib.schema.parameter..dimension.options" : {
"type" : "object",
"properties" : {
"stage-number" : {
"type" : "integer"
}
},
"additionalProperties" : false
},
"metabase.lib.schema.parameter..dimension.target" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-expression-ref"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.template-tag"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
} ]
},
"metabase.lib.schema.parameter..parameter.options" : {
"description" : "Options the frontend attaches to a parameter value.",
"type" : "object",
"properties" : {
"case-sensitive" : {
"type" : "boolean"
},
"include-current" : {
"type" : "boolean"
}
},
"additionalProperties" : false
},
"metabase.lib.schema.parameter..parameter.value" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
}
} ]
},
"metabase.lib.schema.parameter..parameter.value.scalar" : {
"description" : "A single scalar parameter value."
},
"metabase.lib.schema.parameter..target.legacy-expression-ref" : {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.expression"
},
"metabase.lib.schema.parameter..target.legacy-field-ref" : {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
},
"metabase.lib.schema.parameter..template-tag.tag-name" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "id" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
} ]
},
"metabase.lib.schema.parameter..values-source-config.value" : {
"description" : "One value of a static-list source: a bare value, a one-tuple of it, or a `[value label]` pair.",
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
}, {
"type" : "array",
"prefixItems" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
} ]
}, {
"type" : "array",
"prefixItems" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
}, {
"type" : "string"
} ]
} ]
},
"metabase.lib.schema.parameter..variable.target" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.template-tag"
} ]
},
"metabase.lib.schema.parameter.dimension" : { },
"metabase.lib.schema.parameter.id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.lib.schema.parameter.parameter" : {
"description" : "parameter must be a map with a :type key",
"allOf" : [ {
"type" : "object",
"properties" : {
"values-query-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.values-query-type"
}, {
"type" : "null"
} ]
},
"filteringparameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
}
}, {
"type" : "null"
} ]
},
"values-source-config" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.values-source-config"
}, {
"type" : "null"
} ]
},
"display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
},
"ismultiselect" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"slug" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"value" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
},
"values-source-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.values-source-type"
}, {
"type" : "null"
} ]
},
"sectionid" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"hasvariabletemplatetagtarget" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"required" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
},
"target" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
},
"temporal-units" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}
}, {
"type" : "null"
} ]
},
"options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.options"
}, {
"type" : "null"
} ]
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
},
"required" : [ "type" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
} ]
},
"metabase.lib.schema.parameter.parameters" : {
"description" : "Schema for a list of `:parameters` as passed in to a query.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameter"
}
},
"metabase.lib.schema.parameter.target" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.dimension"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.variable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.text-tag"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
} ]
},
"metabase.lib.schema.parameter.template-tag" : {
"description" : "This is the reference like [:template-tag <whatever>], not the schema for native query template tags -- that lives\n in [[metabase.lib.schema.template-tag]].",
"type" : "array",
"prefixItems" : [ {
"const" : "template-tag"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..template-tag.tag-name"
} ]
},
"metabase.lib.schema.parameter.text-tag" : {
"description" : "A :text-tag parameter :target applies to parameterized text cards in viz settings",
"type" : "array",
"prefixItems" : [ {
"const" : "text-tag"
}, {
"type" : "string"
} ]
},
"metabase.lib.schema.parameter.type" : {
"description" : "Valid parameter :type",
"default" : "text",
"type" : "string",
"enum" : [ "number", "text", "date", "boolean", "date/single", "id", "category", "location/city", "location/state", "location/zip_code", "location/country", "date/range", "date/month-year", "date/quarter-year", "date/relative", "date/all-options", "temporal-unit", "number/!=", "number/<=", "number/=", "number/>=", "number/between", "string/!=", "string/=", "string/contains", "string/does-not-contain", "string/ends-with", "string/starts-with", "boolean/=" ]
},
"metabase.lib.schema.parameter.values-query-type" : {
"description" : "How a filter widget asks for its values.",
"type" : "string",
"enum" : [ "none", "list", "search" ]
},
"metabase.lib.schema.parameter.values-source-config" : {
"description" : "The configuration of a filter widget's value source. Its keys are the frontend's snake_case names.",
"type" : "object",
"properties" : {
"card_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"label_field" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-expression-ref"
} ]
}, {
"type" : "null"
} ]
},
"value_field" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-expression-ref"
} ]
}, {
"type" : "null"
} ]
},
"values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..values-source-config.value"
}
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.lib.schema.parameter.values-source-type" : {
"description" : "Where a filter widget's values come from, when not from the field it is connected to.",
"type" : "string",
"enum" : [ "static-list", "card" ]
},
"metabase.lib.schema.parameter.variable" : {
"type" : "array",
"prefixItems" : [ {
"const" : "variable"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..variable.target"
} ]
},
"metabase.lib.schema.parameter.widget-type" : {
"description" : "The type of widget to display in the FE UI for the user to use to pick values for this parameter.",
"type" : "string",
"enum" : [ "none", "number", "text", "date", "boolean", "date/single", "id", "category", "location/city", "location/state", "location/zip_code", "location/country", "date/range", "date/month-year", "date/quarter-year", "date/relative", "date/all-options", "temporal-unit", "number/!=", "number/<=", "number/=", "number/>=", "number/between", "string/!=", "string/=", "string/contains", "string/does-not-contain", "string/ends-with", "string/starts-with", "boolean/=" ]
},
"metabase.lib.schema.pivot" : {
"description" : "Pivot intent. `:rows` and `:columns` are sequences of UUIDs that reference `:lib/uuid` values on breakouts of the\n stage that carries this clause. `:show-row-totals` and `:show-column-totals` default to `true` when absent.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}
},
"show-column-totals" : {
"type" : "boolean"
},
"show-row-totals" : {
"type" : "boolean"
}
},
"required" : [ "rows", "columns" ],
"additionalProperties" : false
},
"metabase.lib.schema.pivot-only-on-last-stage" : { },
"metabase.lib.schema.query" : {
"allOf" : [ {
"description" : "Valid MBQL 5 query.",
"type" : "object",
"properties" : {
"lib/metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.metadata-provider"
},
"show-column-totals" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase-enterprise.sandbox.query-processor.middleware.sandboxing/details" : {
"$ref" : "#/components/schemas/metabase.lib.schema..sandboxing.details"
},
"user-parameters" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
"pivot-rows" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"update-row" : {
"$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
},
"qp.pivot/remapped-breakout-combination" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"qp/non-default-parameterized?" : {
"type" : "boolean"
},
"lib/type" : {
"default" : "mbql/query",
"const" : "mbql/query"
},
"pivot_rows" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"settings" : {
"$ref" : "#/components/schemas/metabase.lib.schema.settings.settings"
},
"constraints" : {
"$ref" : "#/components/schemas/metabase.lib.schema.constraints.constraints"
},
"cache-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.cache-strategy"
}, {
"type" : "null"
} ]
},
"lib.convert/converted?" : {
"type" : "boolean"
},
"info" : {
"$ref" : "#/components/schemas/metabase.lib.schema.info.info"
},
"impersonation/admin?" : {
"type" : "boolean"
},
"async?" : {
"type" : "boolean"
},
"qp/skip-result-metadata-persistence" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/external-remaps" : {
"$ref" : "#/components/schemas/metabase.lib.schema.external-remappings"
},
"show-row-totals" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"qp/compiled-inline" : {
"$ref" : "#/components/schemas/metabase.lib.schema.compiled-native-query"
},
"qp.pivot/remapped-indexes" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"minimum" : 0
}
},
"middleware" : {
"$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
},
"database" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
} ]
},
"destination-database/id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
"qp.pivot/unremapped-breakout-combination" : {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
},
"pivot-measures" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"impersonation/allow-write?" : {
"type" : "boolean"
},
"pivot_cols" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"impersonation/role" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp.pivot/num-remapped-breakouts" : {
"type" : "integer",
"minimum" : 0
},
"qp/compiled" : {
"$ref" : "#/components/schemas/metabase.lib.schema.compiled-native-query"
},
"stages" : {
"$ref" : "#/components/schemas/metabase.lib.schema.stages"
},
"qp.pivot/num-unremapped-breakouts" : {
"type" : "integer",
"minimum" : 0
},
"metabase.query-processor.util.add-alias-info/original" : {
"$ref" : "#/components/schemas/metabase.lib.schema..query.snapshot"
},
"viz-settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.visualization-settings"
}, {
"type" : "null"
} ]
},
"pivot-cols" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"show_column_totals" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"qp.pivot/num-remapped-cols" : {
"type" : "integer",
"minimum" : 0
},
"qp/source-card-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"parameters" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
"query-permissions/referenced-card-ids" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"uniqueItems" : true
}, {
"type" : "null"
} ]
},
"show_row_totals" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"create-row" : {
"$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
},
"pivot_measures" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "integer",
"minimum" : 0
}
}, {
"type" : "null"
} ]
},
"metabase-enterprise.sandbox.query-processor.middleware.sandboxing/original-metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema..sandboxing.original-metadata"
},
"was-pivot" : {
"description" : "Whether this query was originally run as a pivot query. Stamped into the saved `json_query` by\n `metabase.query-processor.middleware.process-userland-query` and sent back by clients re-downloading pivot query\n results.",
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"required" : [ "stages" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.util.unique-uuids"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.pivot-only-on-last-stage"
}, {
"allOf" : [ ]
} ]
},
"metabase.lib.schema.ref..expression.options" : {
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"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"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"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/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"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/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"type" : "string"
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"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" ]
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"required" : [ "lib/uuid" ],
"additionalProperties" : false
},
"metabase.lib.schema.ref..field.id" : {
"type" : "array",
"prefixItems" : [ {
"const" : "field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.ref..field.options"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
} ]
},
"metabase.lib.schema.ref..field.literal" : {
"type" : "array",
"prefixItems" : [ {
"const" : "field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.ref..field.literal.options"
}, {
"type" : "string"
} ]
},
"metabase.lib.schema.ref..field.literal.options" : {
"allOf" : [ {
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
"inherited-temporal-unit" : {
"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" ]
},
"database-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"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"
},
"effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"base-type" : {
"type" : "string"
},
"lib/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"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/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"type" : "string"
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"type" : "integer",
"minimum" : 1
},
"join-alias" : {
"type" : "string",
"minLength" : 1
},
"lib/original-binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"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" ]
},
"source-field-join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"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"
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"required" : [ "lib/uuid", "base-type" ],
"additionalProperties" : false
}, {
"allOf" : [ ]
} ]
},
"metabase.lib.schema.ref..field.options" : {
"allOf" : [ {
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
"inherited-temporal-unit" : {
"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" ]
},
"database-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"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"
},
"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/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"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/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"type" : "string"
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"type" : "integer",
"minimum" : 1
},
"join-alias" : {
"type" : "string",
"minLength" : 1
},
"lib/original-binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"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" ]
},
"source-field-join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"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"
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"required" : [ "lib/uuid" ],
"additionalProperties" : false
}, {
"allOf" : [ ]
} ]
},
"metabase.lib.schema.ref.aggregation-options" : {
"default" : { },
"type" : "object",
"properties" : {
"metabase.query-processor.util.add-alias-info/source-table" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
"metabase.mcp.v2.query/keyset" : {
"type" : "boolean"
},
"qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
"type" : "boolean"
},
"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"
} ]
},
"metabase.driver.sql.query-processor/forced-alias" : {
"type" : "boolean"
},
"metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"type" : "boolean"
},
"display-name" : {
"type" : "string",
"minLength" : 1
},
"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/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/nfc-path" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"metabase.driver.sql.query-processor/add-cast" : {
"type" : "string"
},
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
},
"name" : {
"type" : "string",
"minLength" : 1
},
"lib/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
"metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
"case-sensitive" : {
"type" : "boolean"
},
"lib/original-effective-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"metabase.driver.sql.query-processor/wrap-in-case" : {
"type" : "boolean"
},
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source-name" : {
"type" : "string",
"minLength" : 1
},
"qp/ignore-coercion" : {
"type" : "boolean"
},
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"metabase.driver.mongo.query-processor/join-local" : {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"qp/native-sandbox-column.force-coercion-strategy" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"metabase.query-processor.util.add-alias-info/resolved" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
"include-current" : {
"type" : "boolean"
},
"temporal-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
"metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
"type" : "boolean"
}
},
"required" : [ "lib/uuid" ],
"additionalProperties" : false
},
"metabase.lib.schema.ref.ref" : {
"$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
},
"metabase.lib.schema.settings.settings" : {
"description" : "Options that tweak the behavior of the query processor.",
"type" : "object",
"properties" : {
"include-sensitive-fields" : {
"description" : "Whether to include fields with visibility_type :sensitive when fetching query metadata.",
"type" : "boolean"
},
"report-timezone" : {
"description" : "The timezone the query should be ran in, overriding the default report timezone for the instance.",
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal.timezone-id"
}
},
"additionalProperties" : false
},
"metabase.lib.schema.stage" : {
"default" : {
"lib/type" : "mbql.stage/mbql"
},
"allOf" : [ {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema..stage.native"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema..stage.mbql"
} ]
}, {
"allOf" : [ ]
} ]
},
"metabase.lib.schema.stages" : {
"allOf" : [ {
"default" : [ ],
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.stage"
},
"minItems" : 1
}, {
"$ref" : "#/components/schemas/metabase.lib.schema..stages.valid-refs"
} ]
},
"metabase.lib.schema.template-tag..field-filter.options" : {
"description" : "Options appended to the filter clause a Field Filter template tag generates. These get merged into the parameter\n value the QP builds for the tag, so they are the same options as `:metabase.lib.schema.parameter/parameter.options`.",
"type" : "object",
"properties" : {
"case-sensitive" : {
"type" : "boolean"
},
"include-current" : {
"type" : "boolean"
}
},
"additionalProperties" : false
},
"metabase.lib.schema.template-tag..raw-value.type" : {
"type" : "string",
"enum" : [ "date", "number", "boolean", "text" ]
},
"metabase.lib.schema.template-tag..template-tag-map.validate-names" : { },
"metabase.lib.schema.template-tag..value.common" : {
"type" : "object",
"properties" : {
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
},
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
},
"lib.walk/template-tag-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"required" : {
"type" : "boolean"
},
"sectionid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "name", "display-name" ],
"additionalProperties" : false
},
"metabase.lib.schema.template-tag.common" : {
"type" : "object",
"properties" : {
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
},
"lib.walk/template-tag-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"sectionid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "name", "display-name" ],
"additionalProperties" : false
},
"metabase.lib.schema.template-tag.disallow-dimension" : { },
"metabase.lib.schema.template-tag.distinct-template-tags" : { },
"metabase.lib.schema.template-tag.field-filter" : {
"type" : "object",
"properties" : {
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
},
"lib.walk/template-tag-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"sectionid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"required" : {
"type" : "boolean"
},
"type" : {
"const" : "dimension"
},
"alias" : {
"type" : "string"
},
"options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag..field-filter.options"
}, {
"type" : "null"
} ]
},
"dimension" : {
"$ref" : "#/components/schemas/mbql.clause.field"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
},
"widget-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.widget-type"
}
},
"required" : [ "name", "display-name", "type", "widget-type" ],
"additionalProperties" : false
},
"metabase.lib.schema.template-tag.id" : {
"oneOf" : [ {
"type" : "string",
"format" : "uuid"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
} ]
},
"metabase.lib.schema.template-tag.name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.lib.schema.template-tag.raw-value" : {
"allOf" : [ {
"type" : "object",
"properties" : {
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
},
"lib.walk/template-tag-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"sectionid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"required" : {
"type" : "boolean"
},
"type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag..raw-value.type"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
},
"widget-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.widget-type"
}, {
"type" : "null"
} ]
}
},
"required" : [ "name", "display-name", "type" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
} ]
},
"metabase.lib.schema.template-tag.snippet" : {
"allOf" : [ {
"type" : "object",
"properties" : {
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"snippet-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
},
"lib.walk/template-tag-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"database" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
"sectionid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"type" : {
"const" : "snippet"
},
"snippet-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
}
},
"required" : [ "name", "display-name", "type", "snippet-name" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
} ]
},
"metabase.lib.schema.template-tag.source-filter" : {
"description" : "Schema for a single source-filter applied to a table template tag.",
"type" : "object",
"properties" : {
"field-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"op" : {
"type" : "string",
"enum" : [ "<=", ">", ">=", "!=", "=", "<" ]
},
"value" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
},
"required" : [ "field-id", "op", "value" ],
"additionalProperties" : false
},
"metabase.lib.schema.template-tag.source-query" : {
"allOf" : [ {
"type" : "object",
"properties" : {
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
},
"lib.walk/template-tag-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"card-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"sectionid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"required" : {
"type" : "boolean"
},
"type" : {
"const" : "card"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
},
"required" : [ "name", "display-name", "type", "card-id" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
} ]
},
"metabase.lib.schema.template-tag.source-table" : {
"allOf" : [ {
"type" : "object",
"properties" : {
"table-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
},
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
},
"lib.walk/template-tag-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"sectionid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"source-filters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-filter"
}
},
"required" : {
"type" : "boolean"
},
"type" : {
"const" : "table"
},
"emit-alias" : {
"type" : "boolean"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
},
"required" : [ "name", "display-name", "type", "table-id" ],
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
} ]
},
"metabase.lib.schema.template-tag.template-tag" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.temporal-unit"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.field-filter"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.snippet"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-query"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-table"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.raw-value"
} ]
},
"metabase.lib.schema.template-tag.template-tag-map" : {
"description" : "Legacy way to store template tags... storing them as a map is problematic because having more than 8 template tags\n causes the map to switch to a hash map (in Clojure < 1.13) and order gets lost (see #5136). For the sake of keeping\n things simple for the FE (which does not have this issue with JS Objects).\n\n This is still used by a handful of functions to support easy lookup by tag name, so we'll leave the schema around\n FOR NOW, but it would probably be better to remove this entirely and just introduce helper functions for looking\n things up.",
"allOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tag"
}
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag..template-tag-map.validate-names"
} ]
},
"metabase.lib.schema.template-tag.template-tags" : {
"description" : "Prior to 63, this was a map, but was changed to a list to preserve order with more than 8 template tags.\n\n Each tag must have a distinct `:name`.",
"allOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tag"
}
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.distinct-template-tags"
} ]
},
"metabase.lib.schema.template-tag.temporal-unit" : {
"type" : "object",
"properties" : {
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
},
"lib.walk/template-tag-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
"sectionid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"required" : {
"type" : "boolean"
},
"type" : {
"const" : "temporal-unit"
},
"alias" : {
"type" : "string"
},
"dimension" : {
"$ref" : "#/components/schemas/mbql.clause.field"
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
},
"required" : [ "name", "display-name", "type" ],
"additionalProperties" : false
},
"metabase.lib.schema.template-tag.widget-type" : {
"description" : "Schema for valid values of `:widget-type` for a `:metabase.lib.schema.template-tag/field-filter` template tag.",
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.widget-type"
},
"metabase.lib.schema.temporal-bucketing..unit.date" : {
"type" : "string",
"enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "month", "month-of-year", "quarter", "quarter-of-year", "week", "week-of-year", "year", "year-of-era" ]
},
"metabase.lib.schema.temporal-bucketing..unit.date-time" : {
"type" : "string",
"enum" : [ "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year", "second-of-minute", "minute-of-hour", "hour-of-day", "day-of-week", "day-of-month", "day-of-year", "week-of-year", "month-of-year", "quarter-of-year", "year-of-era" ]
},
"metabase.lib.schema.temporal-bucketing..unit.date-time.interval" : {
"type" : "string",
"enum" : [ "day", "hour", "millisecond", "minute", "month", "quarter", "second", "week", "year" ]
},
"metabase.lib.schema.temporal-bucketing..unit.time.interval" : {
"type" : "string",
"enum" : [ "hour", "millisecond", "minute", "second" ]
},
"metabase.lib.schema.temporal-bucketing.unit" : {
"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" ]
},
"metabase.lib.schema.test-spec.test-aggregation-spec" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-expression-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-named-aggregation-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-measure-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-metric-spec"
} ]
},
"metabase.lib.schema.test-spec.test-binning-bucket-spec" : {
"type" : "object",
"properties" : {
"binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-binning-spec"
}, {
"type" : "null"
} ]
}
}
},
"metabase.lib.schema.test-spec.test-binning-spec" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"strategy" : {
"const" : "default"
}
},
"required" : [ "strategy" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"num-bins" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
"strategy" : {
"const" : "num-bins"
}
},
"required" : [ "strategy", "num-bins" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"bin-width" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
"strategy" : {
"const" : "bin-width"
}
},
"required" : [ "strategy", "bin-width" ],
"additionalProperties" : false
} ]
},
"metabase.lib.schema.test-spec.test-breakout-spec" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-column-with-binning-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-breakout-with-name-spec"
} ]
},
"metabase.lib.schema.test-spec.test-breakout-with-name-spec" : {
"type" : "object",
"properties" : {
"column" : {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-column-with-binning-spec"
},
"name" : {
"type" : "string"
},
"type" : {
"const" : "breakout"
}
},
"required" : [ "type", "name", "column" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-column-spec" : {
"description" : "A column of the stage: a field by `:field-id`, or else a column by its `:name`. Every other key is matched exactly:\n a missing `:join-alias` means the column does not come from a join, a missing `:source-field-id` means it is not\n implicitly joined.",
"type" : "object",
"properties" : {
"field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"source-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"source-field-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"type" : {
"const" : "column"
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-column-with-binning-spec" : {
"description" : "A column of the stage: a field by `:field-id`, or else a column by its `:name`. Every other key is matched exactly:\n a missing `:join-alias` means the column does not come from a join, a missing `:source-field-id` means it is not\n implicitly joined.",
"type" : "object",
"properties" : {
"binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-binning-spec"
}, {
"type" : "null"
} ]
},
"field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"source-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"source-field-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"type" : {
"const" : "column"
},
"unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-expression-spec" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-column-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-literal-expression-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-operator-expression-spec"
} ]
},
"metabase.lib.schema.test-spec.test-literal-arg-spec" : {
"description" : "A literal argument of an operator: a value, or several values that are each an argument, as in `[:= x 4 5]`.",
"type" : "object",
"properties" : {
"type" : {
"const" : "literal"
},
"value" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
},
"minItems" : 1
} ]
}
},
"required" : [ "type", "value" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-literal-expression-spec" : {
"type" : "object",
"properties" : {
"type" : {
"const" : "literal"
},
"value" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
},
"required" : [ "type", "value" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-measure-spec" : {
"type" : "object",
"properties" : {
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.measure"
},
"type" : {
"const" : "measure"
}
},
"required" : [ "type", "id" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-metric-spec" : {
"type" : "object",
"properties" : {
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.metric"
},
"type" : {
"const" : "metric"
}
},
"required" : [ "type", "id" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-named-aggregation-spec" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"value" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-expression-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-measure-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-metric-spec"
} ]
}
},
"required" : [ "name", "value" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-operator-arg-spec" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-column-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-literal-arg-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-operator-expression-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-segment-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-measure-spec"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-metric-spec"
} ]
},
"metabase.lib.schema.test-spec.test-operator-expression-spec" : {
"type" : "object",
"properties" : {
"args" : {
"default" : [ ],
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-operator-arg-spec"
}
},
"name" : {
"type" : "string"
},
"operator" : {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-operator-spec"
},
"type" : {
"const" : "operator"
}
},
"required" : [ "type", "operator" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-operator-spec" : {
"type" : "string"
},
"metabase.lib.schema.test-spec.test-order-by-spec" : {
"description" : "A column of the stage: a field by `:field-id`, or else a column by its `:name`. Every other key is matched exactly:\n a missing `:join-alias` means the column does not come from a join, a missing `:source-field-id` means it is not\n implicitly joined.",
"type" : "object",
"properties" : {
"field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"binning" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-binning-spec"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"direction" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.order-by.direction"
}, {
"type" : "null"
} ]
},
"source-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"type" : {
"const" : "column"
},
"join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
},
"unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
"source-field-join-alias" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-segment-spec" : {
"type" : "object",
"properties" : {
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.segment"
},
"type" : {
"const" : "segment"
}
},
"required" : [ "type", "id" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-table-source-spec" : {
"type" : "object",
"properties" : {
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
},
"type" : {
"const" : "table"
}
},
"required" : [ "type", "id" ],
"additionalProperties" : false
},
"metabase.lib.schema.test-spec.test-temporal-bucket-spec" : {
"type" : "object",
"properties" : {
"unit" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
}
}
},
"metabase.lib.schema.util.distinct-mbql-clauses" : { },
"metabase.lib.schema.util.unique-uuids" : { },
"metabase.lib.schema.validate.source-entity-type" : {
"description" : "The type of the source entity causing an error.",
"type" : "string",
"enum" : [ "table", "card", "transform" ]
},
"metabase.lib.schema.validate.validate-error-type" : {
"type" : "string",
"enum" : [ "missing-column", "missing-table-alias", "missing-table", "missing-card", "duplicate-column", "syntax-error", "validation-exception-error" ]
},
"metabase.lib.schema.value" : {
"anyOf" : [ {
"type" : "null"
}, {
"type" : "boolean"
}, {
"type" : "string"
}, {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.value"
}
}, {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.value"
}
} ]
},
"metabase.lib.util.query-like" : {
"description" : "query-like map",
"type" : "object",
"properties" : { }
},
"metabase.logger.rest.api.log-level" : {
"type" : "string",
"enum" : [ "off", "fatal", "error", "warn", "info", "debug", "trace" ]
},
"metabase.logger.rest.api.time-unit" : {
"type" : "string",
"enum" : [ "days", "hours", "minutes", "seconds", "milliseconds", "microseconds", "nanoseconds" ]
},
"metabase.mcp.callback-api.bootstrap-user" : {
"description" : "The projection of the current user the MCP iframe may read. Closed on purpose: a field belongs here only when\n something the iframe renders reads it, so widening the projection is a decision someone has to make in this file\n rather than a side effect of the shared `GET /api/user/current` response growing.\n\n Deliberately absent: `email`, `login_attributes`, `jwt_attributes`, `attributes`, `sso_source`, `group_ids` and\n the advanced-permissions flags. Nothing in the visualization reads them, and they are what made the general\n endpoint a scope-escalation target. The name fields are absent for the same reason: the iframe displays no\n user, and `common_name` falls back to the email address when a user has neither first nor last name.",
"type" : "object",
"properties" : {
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"is_data_analyst" : {
"type" : "boolean"
},
"is_qbnewb" : {
"type" : "boolean"
},
"is_superuser" : {
"type" : "boolean"
},
"locale" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"permissions" : {
"type" : "object",
"properties" : {
"can_create_native_queries" : {
"type" : "boolean"
},
"can_create_queries" : {
"type" : "boolean"
}
},
"required" : [ "can_create_queries", "can_create_native_queries" ],
"additionalProperties" : false
},
"personal_collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"tenant_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "locale", "is_superuser", "is_data_analyst", "is_qbnewb", "tenant_id", "personal_collection_id", "permissions" ],
"additionalProperties" : false
},
"metabase.mcp.permissions.tool-access" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}, {
"description" : "Value must be a map."
} ]
},
"metabase.measures.api.RemappedValueResponse" : {
"description" : "Response schema for dimension remapping endpoint.\n Returns [value] if no remapping, or [value, display-name] if remapped.",
"anyOf" : [ {
"type" : "array",
"prefixItems" : [ { } ]
}, {
"type" : "array",
"prefixItems" : [ { }, {
"type" : "string"
} ]
} ]
},
"metabase.measures.api.measure" : {
"description" : "Schema for a Measure entity as returned from the API.",
"type" : "object",
"properties" : {
"dimension_mappings" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : { }
}
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"result_column_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"creator" : {
"oneOf" : [ {
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string",
"minLength" : 1
},
"archived" : {
"type" : "boolean"
},
"dimensions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : { }
}
}, {
"type" : "null"
} ]
},
"updated_at" : { },
"table_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"definition" : {
"$ref" : "#/components/schemas/metabase.measures.schema.definition"
},
"created_at" : { },
"creator_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "table_id", "definition", "archived", "creator_id", "created_at", "updated_at" ]
},
"metabase.measures.schema.definition" : {
"description" : "value must be a valid MBQL query with a source table.",
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
},
"metabase.metabot.context.context" : {
"description" : "The context a Metabot request carries. Besides what the client sends, [[create-context]] adds the user's recent\n views, the current time and the caller's capabilities before the agent reads it.",
"type" : "object",
"properties" : {
"capabilities" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}, {
"type" : "array",
"items" : {
"type" : "string"
}
} ]
}, {
"type" : "null"
} ]
},
"first_day_of_week" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"references" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ]
}, {
"type" : "null"
} ]
},
"slack_channel_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"user_recently_viewed" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.context.recently-viewed-item"
}
}, {
"type" : "null"
} ]
},
"research_plan" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.metabot.context.research-plan"
}, {
"type" : "null"
} ]
},
"code_editor" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"buffers" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"cursor" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
},
"required" : [ "line", "column" ],
"additionalProperties" : false
},
"id" : {
"type" : "string"
},
"selection" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"end" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
},
"required" : [ "line", "column" ],
"additionalProperties" : false
},
"start" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
},
"required" : [ "line", "column" ],
"additionalProperties" : false
},
"text" : {
"type" : "string"
}
},
"required" : [ "text", "start", "end" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"source" : {
"type" : "object",
"properties" : {
"database_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"language" : {
"const" : "sql"
}
},
"required" : [ "language", "database_id" ],
"additionalProperties" : false
}
},
"required" : [ "id", "source", "cursor" ],
"additionalProperties" : false
}
},
"type" : {
"const" : "code_editor"
}
},
"required" : [ "type", "buffers" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"user_is_viewing" : {
"type" : "array",
"items" : {
"anyOf" : [ {
"type" : "object",
"properties" : {
"query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
}, {
"type" : "object",
"properties" : {
"database" : {
"type" : "null"
},
"lib/type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"native" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"collection" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"template-tags" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tag-map"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
}
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"source-table" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"stages" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.stage"
}
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
} ]
},
"error" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"type" : "string",
"enum" : [ "model", "question", "metric", "adhoc" ]
},
"database_schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"sql_engine" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"used_tables" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"database_schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
},
"buffers" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"cursor" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
},
"required" : [ "line", "column" ],
"additionalProperties" : false
},
"id" : {
"type" : "string"
},
"selection" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"end" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
},
"required" : [ "line", "column" ],
"additionalProperties" : false
},
"start" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
},
"required" : [ "line", "column" ],
"additionalProperties" : false
},
"text" : {
"type" : "string"
}
},
"required" : [ "text", "start", "end" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"source" : {
"type" : "object",
"properties" : {
"database_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"language" : {
"const" : "sql"
}
},
"required" : [ "language", "database_id" ],
"additionalProperties" : false
}
},
"required" : [ "id", "source", "cursor" ],
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"chart_configs" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"data" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "boolean", "string", "null", "number", "time", "datetime", "date" ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
}
},
"rows" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
} ]
}
}
}
},
"required" : [ "columns", "rows" ],
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
}, {
"type" : "object",
"properties" : {
"database" : {
"type" : "null"
},
"lib/type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"native" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"collection" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"template-tags" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tag-map"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
}
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"source-table" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"stages" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.stage"
}
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
} ]
},
"series" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"chart_type" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
},
"display_name" : {
"type" : "string"
},
"stacked" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"x" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "boolean", "string", "null", "number", "time", "datetime", "date" ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
},
"x_values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
}, {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ]
} ]
}, {
"type" : "null"
} ]
}
}, {
"type" : "null"
} ]
},
"y" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "boolean", "string", "null", "number", "time", "datetime", "date" ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"y_values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
}, {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ]
} ]
}, {
"type" : "null"
} ]
}
}, {
"type" : "null"
} ]
}
},
"required" : [ "x", "display_name", "chart_type" ],
"additionalProperties" : false
}
}, {
"description" : "Value must be a map."
} ]
}, {
"type" : "null"
} ]
},
"timeline_events" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"timestamp" : {
"type" : "string"
}
},
"required" : [ "name", "timestamp" ],
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
},
"title" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
}
},
"required" : [ "type" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
}, {
"type" : "object",
"properties" : {
"database" : {
"type" : "null"
},
"lib/type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"native" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"collection" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"template-tags" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tag-map"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
}
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"source-table" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"stages" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.stage"
}
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
} ]
},
"error" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"type" : "string",
"enum" : [ "dashboard", "model", "code_editor", "document", "question", "metric", "adhoc" ]
},
"database_schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"sql_engine" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"used_tables" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"database_schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
},
"buffers" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"cursor" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
},
"required" : [ "line", "column" ],
"additionalProperties" : false
},
"id" : {
"type" : "string"
},
"selection" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"end" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
},
"required" : [ "line", "column" ],
"additionalProperties" : false
},
"start" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
},
"required" : [ "line", "column" ],
"additionalProperties" : false
},
"text" : {
"type" : "string"
}
},
"required" : [ "text", "start", "end" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"source" : {
"type" : "object",
"properties" : {
"database_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"language" : {
"const" : "sql"
}
},
"required" : [ "language", "database_id" ],
"additionalProperties" : false
}
},
"required" : [ "id", "source", "cursor" ],
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"chart_configs" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"data" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "boolean", "string", "null", "number", "time", "datetime", "date" ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
}
},
"rows" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
} ]
}
}
}
},
"required" : [ "columns", "rows" ],
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
}, {
"type" : "object",
"properties" : {
"database" : {
"type" : "null"
},
"lib/type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"native" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"collection" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"template-tags" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tag-map"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
}
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"source-table" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"stages" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.stage"
}
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
} ]
},
"series" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"chart_type" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
},
"display_name" : {
"type" : "string"
},
"stacked" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"x" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "boolean", "string", "null", "number", "time", "datetime", "date" ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
},
"x_values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
}, {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ]
} ]
}, {
"type" : "null"
} ]
}
}, {
"type" : "null"
} ]
},
"y" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "boolean", "string", "null", "number", "time", "datetime", "date" ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"y_values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
}, {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ]
} ]
}, {
"type" : "null"
} ]
}
}, {
"type" : "null"
} ]
}
},
"required" : [ "x", "display_name", "chart_type" ],
"additionalProperties" : false
}
}, {
"description" : "Value must be a map."
} ]
}, {
"type" : "null"
} ]
},
"timeline_events" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"timestamp" : {
"type" : "string"
}
},
"required" : [ "name", "timestamp" ],
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
},
"title" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}
}, {
"type" : "null"
} ]
}
},
"required" : [ "type" ],
"additionalProperties" : false
} ]
}
},
"current_user_time" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"default_database_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"in_host_app" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"current_time_with_timezone" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.metabot.context.recently-viewed-item" : {
"description" : "One of the user's recent views, trimmed to what the model gets told about it.",
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.metabot.context.research-plan" : {
"description" : "The in-progress Research plan the frontend serializes into `:research_plan` each turn (`ResearchPlanContext`).",
"type" : "object",
"properties" : {
"groups" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.context.research-plan-group"
}
},
"name" : {
"type" : "string"
},
"timelines" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.context.research-plan-ref"
}
}
},
"required" : [ "name", "groups", "timelines" ],
"additionalProperties" : false
},
"metabase.metabot.context.research-plan-group" : {
"type" : "object",
"properties" : {
"block_id" : {
"type" : "string"
},
"dimensions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.context.research-plan-ref"
}
},
"metric" : {
"$ref" : "#/components/schemas/metabase.metabot.context.research-plan-ref"
}
},
"required" : [ "block_id", "metric", "dimensions" ],
"additionalProperties" : false
},
"metabase.metabot.context.research-plan-ref" : {
"description" : "A named reference to a research-plan metric/dimension/timeline: what the frontend echoes back in\n `ResearchPlanContext`.",
"type" : "object",
"properties" : {
"id" : {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "string"
} ]
},
"name" : {
"type" : "string"
}
},
"required" : [ "id", "name" ],
"additionalProperties" : false
},
"metabase.metabot.schema..transform.source" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.metabot.schema.query"
}, {
"type" : "null"
} ]
},
"type" : {
"anyOf" : [ {
"const" : "query"
}, {
"const" : "query"
} ]
}
},
"required" : [ "type" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"body" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"source-database" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"source-tables" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema..transform.source-table"
}
}, {
"type" : "null"
} ]
},
"type" : {
"anyOf" : [ {
"const" : "python"
}, {
"const" : "python"
} ]
}
},
"required" : [ "type" ],
"additionalProperties" : false
} ]
},
"metabase.metabot.schema..transform.source-table" : {
"description" : "One entry of a Python transform's `source-tables`. Mirrors\n `metabase.metabot.context/TransformSourceTableSchema`.",
"type" : "object",
"properties" : {
"alias" : {
"type" : "string"
},
"database_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"table_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
}
},
"required" : [ "alias" ],
"additionalProperties" : false
},
"metabase.metabot.schema..transform.target" : {
"type" : "object",
"properties" : {
"database" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"anyOf" : [ {
"const" : "table"
}, {
"const" : "table"
} ]
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.metabot.schema.chart" : {
"type" : "object",
"properties" : {
"chart_config" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.metabot.schema.chart-config"
}, {
"type" : "null"
} ]
},
"chart_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"queries" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.metabot.schema.query"
}, {
"type" : "null"
} ]
}
}, {
"type" : "null"
} ]
},
"query_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"timeline_events" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.chart-timeline-event"
}
}, {
"type" : "null"
} ]
},
"visualization_settings" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"chart_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.metabot.schema.chart-config" : {
"description" : "A `chart_configs` entry: a chart's title, pre-materialized series data, and the query that produced it.\n Mirrors `metabase.metabot.context/ChartConfigSchema`.",
"type" : "object",
"properties" : {
"data" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.chart-data"
}
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"display_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.metabot.schema.query"
}, {
"type" : "null"
} ]
},
"series" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.series-config"
}
}, {
"description" : "Value must be a map."
} ]
}, {
"type" : "null"
} ]
},
"timeline_events" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.chart-timeline-event"
}
}, {
"type" : "null"
} ]
},
"title" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.metabot.schema.chart-data" : {
"description" : "One pre-materialized table of raw chart data (columns + rows). Mirrors\n `metabase.metabot.context/ChartDataSchema`.",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.column-info"
}
},
"rows" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
} ]
}
}
}
},
"required" : [ "columns", "rows" ],
"additionalProperties" : false
},
"metabase.metabot.schema.chart-timeline-event" : {
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"timestamp" : {
"type" : "string"
}
},
"required" : [ "name", "timestamp" ],
"additionalProperties" : false
},
"metabase.metabot.schema.client-message" : {
"description" : "One persisted message as the client models it.",
"type" : "object",
"properties" : {
"contextTokens" : {
"type" : "integer"
},
"externalId" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"parts" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.client-message-part"
}
},
"role" : {
"type" : "string",
"enum" : [ "user", "agent" ]
},
"status" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.client-message-status"
}
},
"required" : [ "id", "role", "parts", "status" ]
},
"metabase.metabot.schema.client-message-part" : {
"description" : "One part of a persisted message: its a text, tool call, or data blob.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"message" : {
"type" : "string"
},
"role" : {
"type" : "string",
"enum" : [ "user", "agent" ]
},
"type" : {
"const" : "text"
}
},
"required" : [ "id", "role", "type", "message" ]
}, {
"type" : "object",
"properties" : {
"args" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"type" : "string"
},
"is_error" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"result" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"role" : {
"const" : "agent"
},
"status" : {
"type" : "string",
"enum" : [ "started", "ended" ]
},
"type" : {
"const" : "tool_call"
}
},
"required" : [ "id", "role", "type", "name", "args", "status" ]
}, {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"part" : {
"type" : "object",
"properties" : {
"data" : { },
"type" : {
"type" : "string"
}
},
"required" : [ "type", "data" ]
},
"role" : {
"const" : "agent"
},
"type" : {
"const" : "data_part"
}
},
"required" : [ "id", "role", "type", "part" ]
} ]
},
"metabase.metabot.schema.client-message-status" : {
"description" : "Where a message's turn got to.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"type" : {
"const" : "done"
}
},
"required" : [ "type" ]
}, {
"type" : "object",
"properties" : {
"type" : {
"const" : "aborted"
}
},
"required" : [ "type" ]
}, {
"type" : "object",
"properties" : {
"type" : {
"const" : "in_progress"
}
},
"required" : [ "type" ]
}, {
"type" : "object",
"properties" : {
"contextWindowFull" : {
"type" : "boolean"
},
"finishReason" : {
"type" : "string",
"enum" : [ "length", "content-filter", "tool-calls" ]
},
"type" : {
"const" : "incomplete"
}
},
"required" : [ "type", "finishReason" ]
}, {
"type" : "object",
"properties" : {
"error" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "object",
"properties" : {
"data" : { },
"message" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"type" : "string"
}
}
} ]
},
"type" : {
"const" : "errored"
}
},
"required" : [ "type", "error" ]
} ]
},
"metabase.metabot.schema.column-info" : {
"description" : "A chart column's name and inferred type, as sent for chart analysis. Mirrors\n `metabase.metabot.context/ColumnInfoSchema`.",
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "boolean", "string", "null", "number", "time", "datetime", "date" ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
},
"metabase.metabot.schema.query" : {
"description" : "An MBQL 5 or legacy query in any state of normalization, as it round-trips through tool-call JSON or persisted turn\n state. Normalizing repairs a structured query that lost its `:lib/*` keys, so every tool reads a valid MBQL 5 query;\n see [[query-repair/repair-stripped-query]].",
"$ref" : "#/components/schemas/metabase.lib.util.query-like"
},
"metabase.metabot.schema.row-value" : {
"description" : "One cell value in a chart series. The `object` arm is never read by this code -- it's forwarded to the\n interestingness stats/repr code as-is -- so it's opaque rather than typed. Mirrors\n `metabase.metabot.context/RowValueSchema`.",
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "number"
}, {
"type" : "boolean"
}, {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : { }
}, {
"description" : "Value must be a map."
} ]
} ]
}, {
"type" : "null"
} ]
},
"metabase.metabot.schema.series-config" : {
"description" : "One series of a chart, pre-materialized by the frontend for `analyze_chart`. Mirrors\n `metabase.metabot.context/SeriesConfigSchema`.",
"type" : "object",
"properties" : {
"chart_type" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
},
"display_name" : {
"type" : "string"
},
"stacked" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"x" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.column-info"
},
"x_values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.row-value"
}
}, {
"type" : "null"
} ]
},
"y" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.metabot.schema.column-info"
}, {
"type" : "null"
} ]
},
"y_values" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.row-value"
}
}, {
"type" : "null"
} ]
}
},
"required" : [ "x", "display_name", "chart_type" ],
"additionalProperties" : false
},
"metabase.metabot.schema.state" : {
"type" : "object",
"properties" : {
"chart-configs" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.chart-config"
}
},
"charts" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.chart"
}
},
"client-ids" : {
"anyOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.state-map-key"
},
"uniqueItems" : true
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.state-map-key"
}
} ]
},
"link-registry" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"queries" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.query"
}
},
"todos" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.todo"
}
},
"transforms" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.metabot.schema.transform"
}
}
},
"additionalProperties" : false
},
"metabase.metabot.schema.state-map-key" : {
"description" : "A dynamic state-map key, normalized to its canonical string representation.",
"type" : "string"
},
"metabase.metabot.schema.todo" : {
"description" : "A todo item in conversation state persisted while Metabot had todo tools. `:todos` stays in [[::state]], a\n closed map, so those conversations still validate.",
"type" : "object",
"properties" : {
"content" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"type" : "string"
},
"priority" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "high", "medium", "low" ]
}, {
"type" : "null"
} ]
},
"status" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "pending", "in_progress", "completed", "cancelled" ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
},
"metabase.metabot.schema.transform" : {
"type" : "object",
"properties" : {
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.metabot.schema..transform.source"
}, {
"type" : "null"
} ]
},
"target" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.metabot.schema..transform.target"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.metrics.api.BreakoutValuesResponse" : {
"type" : "object",
"properties" : {
"col" : {
"type" : "object",
"properties" : { }
},
"values" : {
"type" : "array",
"items" : { }
}
},
"required" : [ "values", "col" ]
},
"metabase.metrics.api.DatasetRequest" : {
"description" : "Schema for POST /dataset request body.",
"type" : "object",
"properties" : {
"definition" : {
"$ref" : "#/components/schemas/metabase.metrics.api.Definition"
}
},
"required" : [ "definition" ],
"additionalProperties" : false
},
"metabase.metrics.api.DatasetResponse" : {
"description" : "Schema for POST /dataset response.",
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"cols" : {
"type" : "array",
"items" : { }
},
"rows" : {
"type" : "array",
"items" : { }
}
},
"required" : [ "cols", "rows" ]
},
"row_count" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
},
"status" : {
"enum" : [ "completed", "completed" ]
}
},
"required" : [ "status", "data", "row_count" ]
},
"metabase.metrics.api.Definition" : {
"description" : "Schema for the definition object within a dataset request.\n Uses expression-based contract for metric math support.",
"type" : "object",
"properties" : {
"expression" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.metric-math-expression"
},
"filters" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.instance-filters"
}, {
"type" : "null"
} ]
},
"projections" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.typed-projections"
}, {
"type" : "null"
} ]
}
},
"required" : [ "expression" ],
"additionalProperties" : false
},
"metabase.metrics.api.Metric" : {
"description" : "Schema for a Metric in list responses (without hydrated dimensions).",
"type" : "object",
"properties" : {
"collection" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
}
},
"required" : [ "id", "name" ]
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
}
},
"required" : [ "id", "name", "description", "collection_id" ]
},
"metabase.metrics.api.MetricWithDimensions" : {
"description" : "Schema for a Metric in list responses (without hydrated dimensions).",
"type" : "object",
"properties" : {
"dimension_mappings" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metrics.dimension.dimension-mapping"
}
},
"collection" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
}
},
"required" : [ "id", "name" ]
}, {
"type" : "null"
} ]
},
"dataset_query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
},
"result_column_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string"
},
"dimensions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metrics.dimension.dimension"
}
},
"database_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "name", "description", "collection_id", "dimensions", "dimension_mappings" ]
},
"metabase.metrics.api.RemappedValueResponse" : {
"description" : "Response schema for dimension remapping endpoint.\n Returns [value] if no remapping, or [value, display-name] if remapped.",
"anyOf" : [ {
"type" : "array",
"prefixItems" : [ { } ]
}, {
"type" : "array",
"prefixItems" : [ { }, {
"type" : "string"
} ]
} ]
},
"metabase.metrics.core.dimension" : {
"description" : "A metric dimension in its internal kebab-case shape, annotated with the rules that convert it to\n and from the snake_case wire shape. See [[metabase.metrics.dimension/dimension]].",
"$ref" : "#/components/schemas/metabase.metrics.dimension.dimension"
},
"metabase.metrics.core.dimension-mapping" : {
"description" : "A dimension mapping in its internal kebab-case shape, annotated with the rules that convert it to\n and from the snake_case wire shape. See [[metabase.metrics.dimension/dimension-mapping]].",
"$ref" : "#/components/schemas/metabase.metrics.dimension.dimension-mapping"
},
"metabase.metrics.dimension.dimension" : {
"description" : "Schema for a persisted dimension definition with status tracking.",
"type" : "object",
"properties" : {
"sources" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.metrics.dimension.source"
}
}, {
"type" : "null"
} ]
},
"group" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.metrics.dimension.group"
}, {
"type" : "null"
} ]
},
"display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
},
"effective-type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"status" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-status"
}, {
"type" : "null"
} ]
},
"has-field-values" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"status-message" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"default-temporal-unit" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"dimension-interestingness" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"default" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"semantic-type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ]
},
"metabase.metrics.dimension.dimension-mapping" : {
"description" : "Schema for a dimension mapping.",
"type" : "object",
"properties" : {
"dimension-id" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
},
"table-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"target" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-mapping.target"
},
"type" : {
"description" : "Type of dimension mapping.",
"type" : "string",
"enum" : [ "table" ]
}
},
"required" : [ "dimension-id", "target" ],
"additionalProperties" : false
},
"metabase.metrics.dimension.group" : {
"description" : "Group descriptor for a dimension, indicating which table it belongs to.",
"type" : "object",
"properties" : {
"display-name" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "main", "connection" ]
}
},
"required" : [ "id", "type", "display-name" ]
},
"metabase.metrics.dimension.source" : {
"description" : "A dimension source annotated with its wire-encoding rules. Quirks preserved from the previous\n hand-rolled shape: entries keep their kebab-case `:field-id` key on the wire (no key renaming),\n `:field-id` is always present (nil when missing), and other keys (e.g. `:binning`) are dropped.",
"type" : "object",
"properties" : {
"field-id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-source.type"
}
},
"required" : [ "type" ]
},
"metabase.notification.api.admin.bulk-response" : {
"type" : "object",
"properties" : {
"updated" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "updated" ]
},
"metabase.notification.api.admin.channel-entry" : {
"description" : "One channel delivery attempt within a tick.",
"type" : "object",
"properties" : {
"channel_type" : {
"type" : "string"
},
"error" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"status" : {
"$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"
}
},
"required" : [ "channel_type", "status", "error" ],
"additionalProperties" : false
},
"metabase.notification.api.admin.detail-response" : {
"type" : "object",
"properties" : {
"last_check" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"
}, {
"type" : "null"
} ]
},
"payload_type" : {
"type" : "string"
},
"payload_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"send_history" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.api.admin.tick-send-entry"
}
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"check_history" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"
}
},
"last_send" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"
}, {
"type" : "null"
} ]
},
"updated_at" : {
"type" : "string",
"format" : "date-time"
},
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"active" : {
"type" : "boolean"
},
"creator_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "active", "creator_id", "created_at", "updated_at", "payload_type", "payload_id", "last_check", "last_send", "check_history", "send_history" ]
},
"metabase.notification.api.admin.list-response" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.api.admin.list-row"
}
},
"limit" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"offset" : {
"oneOf" : [ {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}, {
"type" : "null"
} ]
},
"total" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "data", "total", "limit", "offset" ]
},
"metabase.notification.api.admin.list-row" : {
"type" : "object",
"properties" : {
"last_check" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"
}, {
"type" : "null"
} ]
},
"payload_type" : {
"type" : "string"
},
"payload_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"last_send" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"
}, {
"type" : "null"
} ]
},
"updated_at" : {
"type" : "string",
"format" : "date-time"
},
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"active" : {
"type" : "boolean"
},
"creator_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "active", "creator_id", "created_at", "updated_at", "payload_type", "payload_id", "last_check", "last_send" ]
},
"metabase.notification.api.admin.run-status" : {
"type" : "string",
"enum" : [ "failing", "successful" ]
},
"metabase.notification.api.admin.run-summary" : {
"type" : "object",
"properties" : {
"at" : {
"type" : "string",
"format" : "date-time"
},
"error" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"status" : {
"$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"
}
},
"required" : [ "at", "error", "status" ],
"additionalProperties" : false
},
"metabase.notification.api.admin.sort-column" : {
"type" : "string",
"enum" : [ "id", "last_send", "last_check", "card_name", "creator_name", "updated_at" ]
},
"metabase.notification.api.admin.sort-direction" : {
"type" : "string",
"enum" : [ "asc", "desc" ]
},
"metabase.notification.api.admin.tick-send-entry" : {
"description" : "One tick's worth of sends, rolled up across all channels that fired in that tick.",
"type" : "object",
"properties" : {
"at" : {
"type" : "string",
"format" : "date-time"
},
"channels" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.api.admin.channel-entry"
}
},
"error" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"status" : {
"$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"
}
},
"required" : [ "at", "status", "error", "channels" ],
"additionalProperties" : false
},
"metabase.notification.api.notification.CreateNotificationParams" : {
"description" : "Notification schema for a create request, or for sending one that was never saved. Like\n FullyHydratedNotification but restricts templates to user-provided types only (no handlebars-resource),\n and carries no ids since the body has no row of its own.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"payload_type" : {
"type" : "string",
"enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ]
},
"handlers" : {
"type" : "array",
"items" : {
"description" : "Schema for :model/NotificationHandler on a create request.",
"type" : "object",
"properties" : {
"template_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"channel_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"recipients" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.CreateNotificationRecipientParams"
}
},
"template" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
},
"channel_type" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"channel" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"type" : "null"
} ]
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"required" : [ "channel_type" ],
"additionalProperties" : false
}
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"internal_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"payload" : {
"$ref" : "#/components/schemas/metabase.notification.models.CreateNotificationCardParams"
},
"creator_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"subscriptions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.CreateNotificationSubscriptionParams"
}
}
},
"required" : [ "payload_type", "payload" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"payload_type" : {
"type" : "string",
"enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ]
},
"handlers" : {
"type" : "array",
"items" : {
"description" : "Schema for :model/NotificationHandler on a create request.",
"type" : "object",
"properties" : {
"template_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"channel_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"recipients" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.CreateNotificationRecipientParams"
}
},
"template" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
},
"channel_type" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"channel" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"type" : "null"
} ]
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"required" : [ "channel_type" ],
"additionalProperties" : false
}
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"internal_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"payload" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models..SystemEventPayload.request"
}, {
"type" : "null"
} ]
},
"creator_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"subscriptions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.CreateNotificationSubscriptionParams"
}
}
},
"required" : [ "payload_type" ],
"additionalProperties" : false
} ]
},
"metabase.notification.api.notification.NotificationApiUpdateInput" : {
"description" : "Notification schema for an update request, restricted to what `notification-update-spec` writes. On PUT\n the URL, not the body, identifies the target (RFC 9110 §9.3.4), so a client-sent id is stripped.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"creator_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"handlers" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"template_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"channel_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"recipients" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
}
},
"template" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
},
"channel_type" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"channel" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"type" : "null"
} ]
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"required" : [ "channel_type" ],
"additionalProperties" : false
}
},
"internal_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"payload" : {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationCardUpdate"
},
"payload_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"payload_type" : {
"type" : "string",
"enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ]
},
"subscriptions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
}
}
},
"required" : [ "payload_type", "payload" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"creator_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"handlers" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"template_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"channel_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"recipients" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
}
},
"template" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
},
"channel_type" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"channel" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"type" : "null"
} ]
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"required" : [ "channel_type" ],
"additionalProperties" : false
}
},
"internal_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"payload" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models..SystemEventPayload.request"
}, {
"type" : "null"
} ]
},
"payload_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"payload_type" : {
"type" : "string",
"enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ]
},
"subscriptions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
}
}
},
"required" : [ "payload_type" ],
"additionalProperties" : false
} ]
},
"metabase.notification.models..SystemEventPayload.request" : {
"description" : "The `:payload` of a system event notification as a client may send it: the event topic, plus the `:disable_links`\n `POST /api/notification` stamps on. The event map itself is the server's to supply, so a request carries none.",
"type" : "object",
"properties" : {
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"event_topic" : {
"$ref" : "#/components/schemas/metabase.notification.models.event-topic"
}
},
"additionalProperties" : false
},
"metabase.notification.models..event-info.comment-created" : {
"description" : "The `:event_info` of an `:event/comment-created` system event.",
"type" : "object",
"properties" : {
"parent_author" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"comment_href" : {
"type" : "string"
},
"entity_title" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"author" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"email" : {
"description" : "value must be a valid email address.",
"type" : "string"
},
"style" : {
"type" : "object",
"properties" : {
"color_text_dark" : {
"type" : "string"
},
"color_text_light" : {
"type" : "string"
},
"color_text_medium" : {
"type" : "string"
}
},
"required" : [ "color_text_dark", "color_text_light", "color_text_medium" ],
"additionalProperties" : false
},
"parent_comment" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"entity_href" : {
"type" : "string"
},
"created_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"comment" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"entity_type" : {
"type" : "string"
}
},
"required" : [ "entity_type", "entity_title", "comment_href", "entity_href", "created_at", "author", "comment", "parent_author", "parent_comment", "style", "email" ],
"additionalProperties" : false
},
"metabase.notification.models..event-info.notification-create" : {
"description" : "The `:event_info` of an `:event/notification-create` system event.",
"type" : "object",
"properties" : {
"object" : {
"$ref" : "#/components/schemas/metabase.notification.models.FullyHydratedNotification"
},
"user-id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"required" : [ "object", "user-id" ],
"additionalProperties" : false
},
"metabase.notification.models..event-info.security-advisory-match" : {
"description" : "The `:event_info` of an `:event/security-advisory-match` system event.",
"type" : "object",
"properties" : {
"object" : {
"type" : "object",
"properties" : {
"advisory_id" : {
"type" : "string",
"minLength" : 1
},
"advisory_url" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"affected_versions" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"fixed" : {
"type" : "string",
"pattern" : "^\\d+(?:\\.\\d+)*$"
},
"min" : {
"type" : "string",
"pattern" : "^\\d+(?:\\.\\d+)*$"
}
},
"required" : [ "min", "fixed" ],
"additionalProperties" : false
}
},
"description" : {
"type" : "string"
},
"match_status" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
},
"remediation" : {
"type" : "string"
},
"severity" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
},
"title" : {
"type" : "string"
}
},
"required" : [ "advisory_id", "severity", "title", "description", "match_status", "advisory_url", "remediation", "affected_versions" ],
"additionalProperties" : false
}
},
"required" : [ "object" ],
"additionalProperties" : false
},
"metabase.notification.models..event-info.support-access-grant-created" : {
"description" : "The `:event_info` of an `:event/support-access-grant-created` system event.",
"type" : "object",
"properties" : {
"duration_minutes" : {
"type" : "integer"
},
"grant_end_time" : {
"type" : "string",
"format" : "date-time"
},
"notes" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"password_reset_url" : {
"type" : "string"
},
"support_email" : {
"oneOf" : [ {
"description" : "value must be a valid email address.",
"type" : "string"
}, {
"type" : "null"
} ]
},
"ticket_number" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "support_email", "ticket_number", "duration_minutes", "grant_end_time", "password_reset_url", "notes" ],
"additionalProperties" : false
},
"metabase.notification.models..event-info.transform-failed" : {
"description" : "The `:event_info` of an `:event/transform-failed` system event.",
"type" : "object",
"properties" : {
"email" : {
"description" : "value must be a valid email address.",
"type" : "string"
},
"failure_count" : {
"type" : "integer"
},
"failures" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "object",
"properties" : {
"details" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"first_line" : {
"type" : "string"
}
},
"required" : [ "first_line", "details" ],
"additionalProperties" : false
},
"transform_href" : {
"type" : "string"
},
"transform_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "transform_name", "transform_href", "message" ],
"additionalProperties" : false
}
},
"job_href" : {
"type" : "string"
},
"job_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"skipped_count" : {
"type" : "integer"
}
},
"required" : [ "email", "job_name", "job_href", "failure_count", "skipped_count", "failures" ],
"additionalProperties" : false
},
"metabase.notification.models..event-info.transform-failure-digest" : {
"description" : "The `:event_info` of an `:event/transform-failure-digest` system event.",
"type" : "object",
"properties" : {
"failure_count" : {
"type" : "integer"
},
"job_count" : {
"type" : "integer"
},
"jobs" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"failure_count" : {
"type" : "integer"
},
"first_failed" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"job_href" : {
"type" : "string"
},
"job_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"latest_error" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "job_name", "job_href", "failure_count", "first_failed", "latest_error" ],
"additionalProperties" : false
}
}
},
"required" : [ "job_count", "failure_count", "jobs" ],
"additionalProperties" : false
},
"metabase.notification.models..event-info.user-invited" : {
"description" : "The `:event_info` of an `:event/user-invited` system event: the invited User instance, plus the extra keys\n `create-and-invite-user!` stamps on it. `:object` is typed by instance, not by shape, since the extra keys are\n `assoc`ed onto the real Toucan row rather than replacing it.",
"type" : "object",
"properties" : {
"details" : {
"type" : "object",
"properties" : {
"invitor" : {
"type" : "object",
"properties" : {
"email" : {
"description" : "value must be a valid email address.",
"type" : "string"
},
"first_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "email" ],
"additionalProperties" : false
}
},
"required" : [ "invitor" ],
"additionalProperties" : false
},
"object" : {
"description" : "What an update (or insert) of a User accepts: every column of `:core_user` except `id`, all optional.",
"type" : "object",
"properties" : {
"login_attributes" : {
"oneOf" : [ {
"allOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
}, {
"description" : "Value must be a map."
} ]
}, {
"description" : "login attribute keys must not start with `@`"
} ]
}, {
"type" : "null"
} ]
},
"sso_source" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"jwt_attributes" : {
"oneOf" : [ {
"allOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
}, {
"description" : "Value must be a map."
} ]
}, {
"description" : "login attribute keys must not start with `@`"
} ]
}, {
"type" : "null"
} ]
},
"is_qbnewb" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"user_group_memberships" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"entity_id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"required" : [ "name", "entity_id" ],
"additionalProperties" : false
}
},
"reset_token" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.users.schema..user.settings"
}, {
"type" : "null"
} ]
},
"deactivated_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"is_from_setup" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"is_active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"invite_method" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"last_login" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
},
"email" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"password_salt" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"deactivated_with_tenant" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"is_data_analyst" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"locale" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"is_datasetnewb" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"reset_triggered" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"is_superuser" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"tenant_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"last_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"attributes" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
}, {
"description" : "Value must be a map."
} ]
}, {
"type" : "null"
} ]
},
"first_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"date_joined" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"password" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"invite_target" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"name" : {
"type" : "string",
"minLength" : 1
},
"type" : {
"type" : "string",
"enum" : [ "dashboard", "question" ]
}
},
"required" : [ "type", "id", "name" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"common_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
}
},
"required" : [ "object" ],
"additionalProperties" : false
},
"metabase.notification.models.CreateNotificationCardParams" : {
"description" : "Schema for :model/NotificationCard on a create request.",
"type" : "object",
"properties" : {
"card" : {
"oneOf" : [ {
"description" : "What an update (or insert) of a Card accepts: every column of `:report_card` except `id`, all optional, plus `:verified-result-metadata?` consumed by the model's hooks.",
"type" : "object",
"properties" : {
"enable_embedding" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"visualization_settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.queries.schema..card.visualization-settings"
}, {
"type" : "null"
} ]
},
"dimension_mappings" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.dimension-mapping"
}
}, {
"type" : "null"
} ]
},
"cache_invalidated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"collection_preview" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"initially_published_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"view_count" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dataset_query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.queries.schema..card.dataset-query"
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.parameter-mapping"
}
}, {
"type" : "null"
} ]
},
"metabot_chart_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"embedding_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"verified-result-metadata?" : {
"type" : "boolean"
},
"made_public_by_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"archived" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"collection_position" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "array",
"prefixItems" : [ {
"type" : "string",
"enum" : [ "+", "-" ]
}, {
"const" : "collection_position"
}, {
"const" : 1
} ]
} ]
}, {
"type" : "null"
} ]
},
"dimensions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.dimension"
}
}, {
"type" : "null"
} ]
},
"query_description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"database_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"type" : "null"
} ]
},
"embedding_params" : {
"oneOf" : [ {
"description" : "value must be a valid embedding params map.",
"oneOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"enum" : [ "disabled", "enabled", "locked", "disabled", "enabled", "locked" ]
}
}, {
"description" : "Value must be a map."
} ]
}, {
"type" : "null"
} ]
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"dataset_query_metrics_v2_migration_backup" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"table_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"legacy_query" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"document_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.documents.schema..document.id"
}, {
"type" : "null"
} ]
},
"result_metadata" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata"
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata.model-override"
}
} ]
}, {
"type" : "null"
} ]
},
"source_card_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"query_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"cache_ttl" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"display" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"public_uuid" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"last_used_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.parameter"
}
}, {
"type" : "null"
} ]
},
"creator_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"metabase_version" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"public_uuid_prefix" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"card_schema" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"metabot_conversation_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dashboard_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"card_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"notification_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"send_condition" : {
"type" : "string",
"enum" : [ "goal_below", "has_result", "goal_above" ]
},
"send_once" : {
"type" : "boolean"
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "card_id" ],
"additionalProperties" : false
},
"metabase.notification.models.CreateNotificationHandlerParams" : {
"description" : "Schema for :model/NotificationHandler on a create request.",
"type" : "object",
"properties" : {
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"channel_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"channel_type" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"template_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "channel_type" ],
"additionalProperties" : false
},
"metabase.notification.models.CreateNotificationRecipientParams" : {
"description" : "Schema for :model/NotificationRecipient on a create request.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"details" : { },
"notification_handler_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"permissions_group_id" : { },
"type" : {
"type" : "string",
"enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"user" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models.EchoedUser"
}, {
"type" : "null"
} ]
},
"user_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "type", "user_id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"details" : { },
"notification_handler_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"permissions_group" : {
"oneOf" : [ {
"description" : "What an update (or insert) of a PermissionsGroup accepts: every column of `:permissions_group` except `id`, all optional.",
"type" : "object",
"properties" : {
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"is_tenant_group" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"magic_group_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"members" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.permissions.schema..permissions-group.member"
}
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"permissions_group_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string",
"enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"user_id" : { }
},
"required" : [ "type", "permissions_group_id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"details" : {
"type" : "object",
"properties" : {
"channel_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"value" : {
"type" : "string"
}
},
"required" : [ "value" ],
"additionalProperties" : false
},
"notification_handler_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"permissions_group_id" : { },
"type" : {
"type" : "string",
"enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"user_id" : { }
},
"required" : [ "type", "details" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"details" : {
"type" : "object",
"properties" : {
"is_optional" : {
"type" : "boolean"
},
"pattern" : {
"type" : "string"
}
},
"required" : [ "pattern" ],
"additionalProperties" : false
},
"notification_handler_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"permissions_group_id" : { },
"type" : {
"type" : "string",
"enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"user_id" : { }
},
"required" : [ "type", "details" ],
"additionalProperties" : false
} ]
},
"metabase.notification.models.CreateNotificationSubscriptionParams" : {
"description" : "Schema for :model/NotificationSubscription on a create request.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"cron_schedule" : {
"type" : "null"
},
"event_name" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string",
"enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ]
},
"ui_display_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "type", "event_name" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"cron_schedule" : {
"type" : "string"
},
"event_name" : {
"type" : "null"
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string",
"enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ]
},
"ui_display_type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "cron/raw", "cron/builder" ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "type", "cron_schedule" ],
"additionalProperties" : false
} ]
},
"metabase.notification.models.EchoedUser" : {
"description" : "What an update (or insert) of a User accepts: every column of `:core_user` except `id`, all optional.",
"type" : "object",
"properties" : {
"login_attributes" : {
"oneOf" : [ {
"allOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
}, {
"description" : "Value must be a map."
} ]
}, {
"description" : "login attribute keys must not start with `@`"
} ]
}, {
"type" : "null"
} ]
},
"sso_source" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"jwt_attributes" : {
"oneOf" : [ {
"allOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
}, {
"description" : "Value must be a map."
} ]
}, {
"description" : "login attribute keys must not start with `@`"
} ]
}, {
"type" : "null"
} ]
},
"is_qbnewb" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"user_group_memberships" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"entity_id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"required" : [ "name", "entity_id" ],
"additionalProperties" : false
}
},
"reset_token" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.users.schema..user.settings"
}, {
"type" : "null"
} ]
},
"deactivated_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"is_active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"last_login" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
},
"email" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"password_salt" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"deactivated_with_tenant" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"is_data_analyst" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"locale" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"is_datasetnewb" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"reset_triggered" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"is_superuser" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"tenant_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"last_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"attributes" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
}, {
"description" : "Value must be a map."
} ]
}, {
"type" : "null"
} ]
},
"first_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"date_joined" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"password" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"common_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
},
"metabase.notification.models.FullyHydratedNotification" : {
"description" : "Fully hydrated notification.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"payload_type" : {
"type" : "string",
"enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ]
},
"payload_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"triggering_subscription" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
}, {
"type" : "null"
} ]
},
"handlers" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"template_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"channel_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"recipients" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
}
},
"template" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
}, {
"type" : "null"
} ]
},
"channel_type" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"channel" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"type" : "null"
} ]
},
"attachment_only" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"include_pdf" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"required" : [ "channel_type" ],
"additionalProperties" : false
}
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"creator" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models.EchoedUser"
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"internal_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"payload" : {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
},
"creator_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"subscriptions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
}
}
},
"required" : [ "payload_type", "payload" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"payload_type" : {
"type" : "string",
"enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ]
},
"payload_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"triggering_subscription" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
}, {
"type" : "null"
} ]
},
"handlers" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"template_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"channel_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"recipients" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
}
},
"template" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
}, {
"type" : "null"
} ]
},
"channel_type" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"channel" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"type" : "null"
} ]
},
"attachment_only" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"include_pdf" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"required" : [ "channel_type" ],
"additionalProperties" : false
}
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"creator" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models.EchoedUser"
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"internal_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"payload" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models.SystemEventPayload"
}, {
"type" : "null"
} ]
},
"creator_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"subscriptions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
}
}
},
"required" : [ "payload_type" ],
"additionalProperties" : false
} ]
},
"metabase.notification.models.NotificationCard" : {
"description" : "Schema for :model/NotificationCard.",
"type" : "object",
"properties" : {
"id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"send_condition" : {
"type" : "string",
"enum" : [ "goal_below", "has_result", "goal_above" ]
},
"card_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"card" : {
"oneOf" : [ {
"description" : "What an update (or insert) of a Card accepts: every column of `:report_card` except `id`, all optional, plus `:verified-result-metadata?` consumed by the model's hooks.",
"type" : "object",
"properties" : {
"enable_embedding" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"visualization_settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.queries.schema..card.visualization-settings"
}, {
"type" : "null"
} ]
},
"dimension_mappings" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.dimension-mapping"
}
}, {
"type" : "null"
} ]
},
"cache_invalidated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"collection_preview" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"initially_published_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"view_count" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dataset_query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.queries.schema..card.dataset-query"
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.parameter-mapping"
}
}, {
"type" : "null"
} ]
},
"metabot_chart_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"embedding_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"verified-result-metadata?" : {
"type" : "boolean"
},
"made_public_by_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"archived" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"collection_position" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "array",
"prefixItems" : [ {
"type" : "string",
"enum" : [ "+", "-" ]
}, {
"const" : "collection_position"
}, {
"const" : 1
} ]
} ]
}, {
"type" : "null"
} ]
},
"dimensions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.dimension"
}
}, {
"type" : "null"
} ]
},
"query_description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"database_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"type" : "null"
} ]
},
"embedding_params" : {
"oneOf" : [ {
"description" : "value must be a valid embedding params map.",
"oneOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"enum" : [ "disabled", "enabled", "locked", "disabled", "enabled", "locked" ]
}
}, {
"description" : "Value must be a map."
} ]
}, {
"type" : "null"
} ]
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"dataset_query_metrics_v2_migration_backup" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"table_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"legacy_query" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"document_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.documents.schema..document.id"
}, {
"type" : "null"
} ]
},
"result_metadata" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata"
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata.model-override"
}
} ]
}, {
"type" : "null"
} ]
},
"source_card_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"query_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"cache_ttl" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"display" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"public_uuid" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"last_used_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.parameter"
}
}, {
"type" : "null"
} ]
},
"creator_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"metabase_version" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"public_uuid_prefix" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"card_schema" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"metabot_conversation_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dashboard_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"notification_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"send_once" : {
"type" : "boolean"
}
},
"required" : [ "card_id" ],
"additionalProperties" : false
},
"metabase.notification.models.NotificationCardUpdate" : {
"description" : "::NotificationCard restricted to what the update spec writes - `:id` comes from the URL's notification.",
"type" : "object",
"properties" : {
"card_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"send_condition" : {
"type" : "string",
"enum" : [ "goal_below", "has_result", "goal_above" ]
},
"send_once" : {
"type" : "boolean"
}
},
"required" : [ "card_id" ],
"additionalProperties" : false
},
"metabase.notification.models.NotificationHandler" : {
"type" : "object",
"properties" : {
"active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"channel_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"channel_type" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"template_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "channel_type" ],
"additionalProperties" : false
},
"metabase.notification.models.NotificationRecipient" : {
"description" : "Schema for :model/NotificationRecipient.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"user_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"user" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models.EchoedUser"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"notification_handler_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"permissions_group_id" : { },
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"type" : {
"type" : "string",
"enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
},
"details" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "type", "user_id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"user_id" : { },
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"notification_handler_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"permissions_group_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"type" : {
"type" : "string",
"enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
},
"details" : { },
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"permissions_group" : {
"oneOf" : [ {
"description" : "What an update (or insert) of a PermissionsGroup accepts: every column of `:permissions_group` except `id`, all optional.",
"type" : "object",
"properties" : {
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"is_tenant_group" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"magic_group_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"members" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.permissions.schema..permissions-group.member"
}
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
}, {
"type" : "null"
} ]
}
},
"required" : [ "type", "permissions_group_id" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"details" : {
"type" : "object",
"properties" : {
"channel_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"value" : {
"type" : "string"
}
},
"required" : [ "value" ],
"additionalProperties" : false
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"notification_handler_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"permissions_group_id" : { },
"type" : {
"type" : "string",
"enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"user_id" : { }
},
"required" : [ "type", "details" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"details" : {
"type" : "object",
"properties" : {
"is_optional" : {
"type" : "boolean"
},
"pattern" : {
"type" : "string"
}
},
"required" : [ "pattern" ],
"additionalProperties" : false
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"notification_handler_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"permissions_group_id" : { },
"type" : {
"type" : "string",
"enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"user_id" : { }
},
"required" : [ "type", "details" ],
"additionalProperties" : false
} ]
},
"metabase.notification.models.NotificationSubscription" : {
"description" : "Schema for :model/NotificationSubscription.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"cron_schedule" : {
"type" : "null"
},
"event_name" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
},
"id" : {
"type" : "integer"
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string",
"enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ]
},
"ui_display_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "type", "event_name" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"created_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"cron_schedule" : {
"type" : "string"
},
"event_name" : {
"type" : "null"
},
"id" : {
"type" : "integer"
},
"notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"type" : {
"type" : "string",
"enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ]
},
"ui_display_type" : {
"oneOf" : [ {
"type" : "string",
"enum" : [ "cron/raw", "cron/builder" ]
}, {
"type" : "null"
} ]
}
},
"required" : [ "type", "cron_schedule" ],
"additionalProperties" : false
} ]
},
"metabase.notification.models.SystemEventPayload" : {
"description" : "The `:payload` of a system event notification on its way to being sent: the event topic, plus the `:disable_links`\n `POST /api/notification` stamps on, plus the event map published under the topic, keyed the way\n [[metabase.events.core/publish-event!]] was handed it. A `:notification/testing` notification's payload is empty.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"event_info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models..event-info.user-invited"
}, {
"type" : "null"
} ]
},
"event_topic" : {
"const" : "event/user-invited"
}
},
"required" : [ "event_topic" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"event_info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models..event-info.notification-create"
}, {
"type" : "null"
} ]
},
"event_topic" : {
"const" : "event/notification-create"
}
},
"required" : [ "event_topic" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"event_info" : {
"oneOf" : [ {
"type" : "object",
"properties" : { },
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"event_topic" : {
"const" : "event/slack-token-invalid"
}
},
"required" : [ "event_topic" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"event_info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models..event-info.comment-created"
}, {
"type" : "null"
} ]
},
"event_topic" : {
"const" : "event/comment-created"
}
},
"required" : [ "event_topic" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"event_info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models..event-info.support-access-grant-created"
}, {
"type" : "null"
} ]
},
"event_topic" : {
"const" : "event/support-access-grant-created"
}
},
"required" : [ "event_topic" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"event_info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models..event-info.transform-failed"
}, {
"type" : "null"
} ]
},
"event_topic" : {
"const" : "event/transform-failed"
}
},
"required" : [ "event_topic" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"event_info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models..event-info.transform-failure-digest"
}, {
"type" : "null"
} ]
},
"event_topic" : {
"const" : "event/transform-failure-digest"
}
},
"required" : [ "event_topic" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"event_info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.notification.models..event-info.security-advisory-match"
}, {
"type" : "null"
} ]
},
"event_topic" : {
"const" : "event/security-advisory-match"
}
},
"required" : [ "event_topic" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"disable_links" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"event_info" : {
"oneOf" : [ {
"type" : "object",
"properties" : { },
"additionalProperties" : false
}, {
"type" : "null"
} ]
},
"event_topic" : { }
},
"required" : [ "event_topic" ],
"additionalProperties" : false
} ]
},
"metabase.notification.models.event-topic" : {
"description" : "One of the event topics a `:notification/system-event` notification can be triggered for.",
"type" : "string",
"enum" : [ "event/user-invited", "event/notification-create", "event/slack-token-invalid", "event/comment-created", "event/support-access-grant-created", "event/transform-failed", "event/transform-failure-digest", "event/security-advisory-match" ]
},
"metabase.osi.schema..osi-ai-context.ai-context" : {
"description" : "The `:ai_context` column of a OsiAiContext, decoded.",
"type" : "object",
"properties" : {
"examples" : {
"type" : "array",
"items" : {
"type" : "string",
"maxLength" : 1000
},
"maxItems" : 50
},
"instructions" : {
"oneOf" : [ {
"type" : "string",
"maxLength" : 5000
}, {
"type" : "null"
} ]
},
"synonyms" : {
"type" : "array",
"items" : {
"type" : "string",
"maxLength" : 1000
},
"maxItems" : 50
}
},
"additionalProperties" : false
},
"metabase.parameters.schema..api.parameter-values" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-values"
},
"metabase.parameters.schema.legacy-ref" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-expression-ref"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
} ]
},
"metabase.parameters.schema.parameter" : {
"description" : "parameter must be a map with :id and :type keys",
"type" : "object",
"properties" : {
"filteringParameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
}
}, {
"type" : "null"
} ]
},
"mappings" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
}
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
},
"uniqueItems" : true
} ]
}, {
"type" : "null"
} ]
},
"sectionId" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"values_source_config" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.values-source-config"
}, {
"type" : "null"
} ]
},
"hasVariableTemplateTagTarget" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
},
"position" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"slug" : {
"type" : "string"
},
"value" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
},
"required" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"values_query_type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.values-query-type"
}, {
"type" : "null"
} ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
},
"temporal_units" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}
}, {
"type" : "null"
} ]
},
"target" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
},
"values_source_type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.values-source-type"
}, {
"type" : "null"
} ]
},
"options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.options"
}, {
"type" : "null"
} ]
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
},
"isMultiSelect" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "type" ],
"additionalProperties" : false
},
"metabase.parameters.schema.parameter-mapping" : {
"description" : "parameter_mapping must be a map with :parameter_id and :target keys",
"type" : "object",
"properties" : {
"card_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"parameter_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
},
"target" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
}
},
"required" : [ "parameter_id", "target" ],
"additionalProperties" : false
},
"metabase.parameters.schema.parameter-mappings" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
}
},
"metabase.parameters.schema.parameter-values" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
}
},
"metabase.parameters.schema.parameter-with-value" : {
"description" : "parameter must be a map with an :id key",
"type" : "object",
"properties" : {
"sectionId" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"slug" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
"value" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
},
"type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
}, {
"type" : "null"
} ]
},
"target" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
}, {
"type" : "null"
} ]
},
"options" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.options"
}, {
"type" : "null"
} ]
},
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
},
"required" : [ "id" ],
"additionalProperties" : false
},
"metabase.parameters.schema.parameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
}
},
"metabase.parameters.schema.values-query-type" : {
"type" : "string",
"enum" : [ "none", "list", "search" ]
},
"metabase.parameters.schema.values-source-config" : {
"description" : "Schema for valid source_options within a Parameter",
"type" : "object",
"properties" : {
"card_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"label_field" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.legacy-ref"
},
"value_field" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.legacy-ref"
},
"values" : { }
},
"additionalProperties" : false
},
"metabase.parameters.schema.values-source-type" : {
"type" : "string",
"enum" : [ "static-list", "card" ]
},
"metabase.permissions-rest.schema.attribute-name" : {
"description" : "a user attribute name",
"type" : "string",
"minLength" : 1
},
"metabase.permissions-rest.schema.attribute-remapping" : {
"description" : "a field name, a field id, or a parameter target",
"anyOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
} ]
},
"metabase.permissions-rest.schema.attribute-remappings" : {
"description" : "a map of user attribute name -> the field or parameter target it is remapped onto",
"type" : "object",
"additionalProperties" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.attribute-remapping"
}, { } ]
}
},
"metabase.permissions-rest.schema.data-perms" : {
"type" : "object",
"properties" : {
"native" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.native"
},
"schemas" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.schemas"
}
},
"additionalProperties" : false
},
"metabase.permissions-rest.schema.db-perms" : {
"description" : "the permissions one group has on one database",
"type" : "object",
"properties" : {
"create-queries" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.schemas"
},
"data" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.strict-data-perms"
},
"data-model" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.strict-data-perms"
},
"details" : {
"type" : "string",
"enum" : [ "yes", "no" ]
},
"download" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.strict-data-perms"
},
"transforms" : {
"type" : "string",
"enum" : [ "yes", "no" ]
},
"view-data" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.schemas"
}
},
"additionalProperties" : false
},
"metabase.permissions-rest.schema.decodable-keyword-int" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"metabase.permissions-rest.schema.graph-update-request" : {
"description" : "the permissions graph, plus the sandboxes and connection impersonations to write with it",
"type" : "object",
"properties" : {
"force" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"groups" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.db-perms"
}, { } ]
}
}, {
"anyOf" : [ {
"type" : "null"
}, { } ]
} ]
}
}, { } ]
},
"impersonations" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.impersonation-update"
}
}, {
"type" : "null"
} ]
},
"revision" : {
"oneOf" : [ {
"description" : "value must be an integer.",
"type" : "integer"
}, {
"type" : "null"
} ]
},
"sandboxes" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.sandbox-update"
}
}, {
"type" : "null"
} ]
}
},
"required" : [ "groups" ],
"additionalProperties" : false
},
"metabase.permissions-rest.schema.group-id" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.decodable-keyword-int"
},
"metabase.permissions-rest.schema.id" : {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.decodable-keyword-int"
},
"metabase.permissions-rest.schema.impersonation-update" : {
"description" : "a connection impersonation policy to write alongside a permissions graph update",
"type" : "object",
"properties" : {
"attribute" : {
"type" : "string",
"minLength" : 1
},
"db_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"group_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "group_id", "db_id", "attribute" ],
"additionalProperties" : false
},
"metabase.permissions-rest.schema.native" : {
"description" : "native permissions",
"oneOf" : [ {
"type" : "string",
"enum" : [ "write", "none", "full", "limited" ]
}, {
"type" : "null"
} ]
},
"metabase.permissions-rest.schema.perms" : {
"description" : "Perms that get reused for TablePerms and SchemaPerms",
"type" : "string",
"enum" : [ "all", "blocked", "full", "legacy-no-self-service", "limited", "no", "none", "query-builder", "sandboxed", "segmented", "unrestricted" ]
},
"metabase.permissions-rest.schema.sandbox-update" : {
"description" : "a sandbox to write alongside a permissions graph update",
"type" : "object",
"properties" : {
"attribute_remappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.attribute-remappings"
}, {
"type" : "null"
} ]
},
"card_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"group_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"permission_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"table_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"additionalProperties" : false
},
"metabase.permissions-rest.schema.schema-graph" : {
"type" : "object",
"additionalProperties" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.schema-perms"
}, { } ]
}
},
"metabase.permissions-rest.schema.schema-perms" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.table-perms"
}, { } ]
}
}, {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.perms"
} ]
},
"metabase.permissions-rest.schema.schemas" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.schema-graph"
}, {
"type" : "string",
"enum" : [ "all", "segmented", "none", "block", "blocked", "full", "limited", "impersonated", "unrestricted", "sandboxed", "legacy-no-self-service", "query-builder-and-native", "query-builder", "no" ]
} ]
},
"metabase.permissions-rest.schema.strict-data-perms" : {
"description" : "Data perms that care about how view-data and make-queries are related to one another.\n If you have write access for native queries, you must have data access to all schemas.",
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.data-perms"
},
"metabase.permissions-rest.schema.table-perms" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"query" : {
"type" : "string",
"enum" : [ "all", "none", "segmented" ]
},
"read" : {
"type" : "string",
"enum" : [ "all", "none" ]
}
},
"additionalProperties" : false
}, {
"$ref" : "#/components/schemas/metabase.permissions-rest.schema.perms"
} ]
},
"metabase.permissions.schema..permissions-group.member" : {
"description" : "A member of a PermissionsGroup as `metabase.permissions.db/group-members` selects it: the User columns the group\n member list shows, the membership it comes from, and `:is_group_manager` when advanced permissions are enabled.",
"type" : "object",
"properties" : {
"user_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"group_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"email" : {
"type" : "string"
},
"is_group_manager" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"is_superuser" : {
"type" : "boolean"
},
"last_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"first_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
},
"common_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"membership_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "id", "user_id", "first_name", "last_name", "email", "is_superuser", "type", "group_id", "membership_id" ],
"additionalProperties" : false
},
"metabase.permissions.schema..permissions-group.update" : {
"description" : "What an update (or insert) of a PermissionsGroup accepts: every column of `:permissions_group` except `id`, all optional.",
"type" : "object",
"properties" : {
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"is_tenant_group" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"magic_group_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.permissions.schema.permissions-group" : {
"description" : "What an update (or insert) of a PermissionsGroup accepts: every column of `:permissions_group` except `id`, all optional.",
"type" : "object",
"properties" : {
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"is_tenant_group" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"magic_group_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"members" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"email" : {
"type" : "string"
},
"entity_id" : {
"type" : "string"
}
},
"required" : [ "email", "entity_id" ],
"additionalProperties" : false
}
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id" ],
"additionalProperties" : false
},
"metabase.pulse.schema.email-subject" : {
"description" : "A dashboard subscription email subject: one line, not blank, at most 255 characters.",
"allOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "string",
"maxLength" : 255
}, {
"type" : "string",
"pattern" : "\\A[^\\r\\n]*\\z"
} ]
},
"metabase.queries.schema..card.dataset-query" : {
"description" : "The `:dataset_query` column of a Card, decoded.",
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
},
"metabase.queries.schema..card.dimension" : {
"description" : "One entry of the `:dimensions` column of a Card, decoded.",
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension"
},
"metabase.queries.schema..card.dimension-mapping" : {
"description" : "One entry of the `:dimension_mappings` column of a Card, decoded.",
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-mapping"
},
"metabase.queries.schema..card.parameter" : {
"description" : "One entry of the `:parameters` column of a Card, decoded.",
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
},
"metabase.queries.schema..card.parameter-mapping" : {
"description" : "One entry of the `:parameter_mappings` column of a Card, decoded.",
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
},
"metabase.queries.schema..card.result-metadata" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
}
},
"metabase.queries.schema..card.result-metadata.model-override" : {
"description" : "A model's result metadata column as serialization exports it: only the keys a user can override, which the Card's\n hooks merge onto the metadata computed from its query.",
"type" : "object",
"properties" : {
"settings" : {
"oneOf" : [ {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"visibility_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"semantic_type" : {
"oneOf" : [ {
"description" : "value must be a valid field semantic or relation type."
}, {
"type" : "null"
} ]
},
"display_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"lib/source_display_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"fk_target_field_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
}
},
"required" : [ "name" ],
"additionalProperties" : false
},
"metabase.queries.schema..card.type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
},
"metabase.queries.schema..card.update" : {
"description" : "What an update (or insert) of a Card accepts: every column of `:report_card` except `id`, all optional, plus `:verified-result-metadata?` consumed by the model's hooks.",
"type" : "object",
"properties" : {
"enable_embedding" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"visualization_settings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.queries.schema..card.visualization-settings"
}, {
"type" : "null"
} ]
},
"dimension_mappings" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.dimension-mapping"
}
}, {
"type" : "null"
} ]
},
"cache_invalidated_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"collection_preview" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"initially_published_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"view_count" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dataset_query" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.queries.schema..card.dataset-query"
}, {
"type" : "null"
} ]
},
"parameter_mappings" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.parameter-mapping"
}
}, {
"type" : "null"
} ]
},
"metabot_chart_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"embedding_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"verified-result-metadata?" : {
"type" : "boolean"
},
"made_public_by_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"archived" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"collection_position" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "integer"
}, {
"type" : "array",
"prefixItems" : [ {
"type" : "string",
"enum" : [ "+", "-" ]
}, {
"const" : "collection_position"
}, {
"const" : 1
} ]
} ]
}, {
"type" : "null"
} ]
},
"dimensions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.dimension"
}
}, {
"type" : "null"
} ]
},
"database_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"type" : "null"
} ]
},
"embedding_params" : {
"oneOf" : [ {
"description" : "value must be a valid embedding params map.",
"oneOf" : [ {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"enum" : [ "disabled", "enabled", "locked", "disabled", "enabled", "locked" ]
}
}, {
"description" : "Value must be a map."
} ]
}, {
"type" : "null"
} ]
}, {
"type" : "null"
} ]
},
"updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"const" : "updated_at"
} ]
}, {
"type" : "null"
} ]
},
"dataset_query_metrics_v2_migration_backup" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"table_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
"legacy_query" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"document_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.documents.schema..document.id"
}, {
"type" : "null"
} ]
},
"result_metadata" : {
"oneOf" : [ {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata"
}, {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata.model-override"
}
} ]
}, {
"type" : "null"
} ]
},
"source_card_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
"query_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"collection_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
"cache_ttl" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
}, {
"type" : "null"
} ]
},
"created_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"display" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
"public_uuid" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"last_used_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
}, {
"type" : "null"
} ]
},
"parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.queries.schema..card.parameter"
}
}, {
"type" : "null"
} ]
},
"creator_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
"metabase_version" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"archived_directly" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
"public_uuid_prefix" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"card_schema" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"metabot_conversation_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"dashboard_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false
},
"metabase.queries.schema..card.visualization-settings" : {
"description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
"metabase.query-processor.schema..query-result.data" : {
"description" : "Schema for the :data key of query results.",
"type" : "object",
"properties" : {
"insights" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : { }
}
},
"results_metadata" : {
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.query-processor.schema..result-metadata.column"
}
}
},
"required" : [ "columns" ]
},
"download_perms" : {
"type" : "string"
},
"format-rows?" : {
"type" : "boolean"
},
"is_sandboxed" : {
"type" : "boolean"
},
"cols" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.query-processor.schema..result-metadata.column"
}
},
"sandbox_details" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : { }
}
},
"results_timezone" : {
"type" : "string"
},
"rows" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : { }
}
},
"native_form" : {
"type" : "object",
"properties" : { }
}
},
"required" : [ "cols", "rows" ]
},
"metabase.query-processor.schema..result-metadata.column" : {
"description" : "A single result metadata column as returned by the Query Processor.",
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
},
"metabase.query-processor.schema.export-format" : {
"description" : "Schema for valid export formats for downloading query results.",
"type" : "string",
"enum" : [ "csv", "api", "xlsx", "json" ]
},
"metabase.query-processor.schema.query-result" : {
"description" : "Schema for query execution results returned by the Query Processor.",
"type" : "object",
"properties" : {
"row_count" : {
"type" : "integer"
},
"error" : {
"type" : "string"
},
"started_at" : {
"type" : "string"
},
"database_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
"context" : { },
"status" : {
"type" : "string",
"enum" : [ "completed", "failed" ]
},
"error_type" : {
"type" : "string"
},
"running_time" : {
"type" : "integer"
},
"json_query" : {
"type" : "object",
"properties" : { }
},
"average_execution_time" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"cached" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"data" : {
"$ref" : "#/components/schemas/metabase.query-processor.schema..query-result.data"
}
},
"required" : [ "status", "row_count" ]
},
"metabase.security-center.schema.advisory-id" : {
"type" : "string",
"minLength" : 1
},
"metabase.security-center.schema.affected-versions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.security-center.schema.version-range"
}
},
"metabase.security-center.schema.download-jar-url" : {
"description" : "MetaStore downloadable JAR",
"type" : "object",
"properties" : {
"url" : {
"type" : "string"
},
"version" : {
"$ref" : "#/components/schemas/metabase.security-center.schema.semver"
}
},
"required" : [ "version", "url" ]
},
"metabase.security-center.schema.download-jar-urls" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.security-center.schema.download-jar-url"
}
},
"metabase.security-center.schema.match-status" : {
"type" : "string",
"enum" : [ "unknown", "active", "resolved", "not_affected", "error" ]
},
"metabase.security-center.schema.semver" : {
"type" : "string",
"pattern" : "^\\d+(?:\\.\\d+)*$"
},
"metabase.security-center.schema.severity" : {
"type" : "string",
"enum" : [ "critical", "high", "medium", "low" ]
},
"metabase.security-center.schema.version-range" : {
"description" : "MetaStore affected version range",
"type" : "object",
"properties" : {
"fixed" : {
"$ref" : "#/components/schemas/metabase.security-center.schema.semver"
},
"min" : {
"$ref" : "#/components/schemas/metabase.security-center.schema.semver"
}
},
"required" : [ "min", "fixed" ]
},
"metabase.segments.schema.definition" : {
"description" : "value must be a valid MBQL query with a source table and filters.",
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
},
"metabase.session.schema.end-reason" : {
"type" : "string",
"enum" : [ "admin", "logout", "password-change", "user-deactivated", "tenant-deactivated", "sso-logout", "support-grant-revoked", "expired", "timed-out" ]
},
"metabase.source-swap.schema.column-error" : {
"type" : "string",
"enum" : [ "column-type-mismatch", "missing-primary-key", "missing-foreign-key", "foreign-key-mismatch" ]
},
"metabase.sso.schema.group-mappings" : {
"description" : "Value must be a map.",
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
}
}, {
"description" : "Value must be a map."
} ]
},
"metabase.sync.schedules.ExpandedSchedulesMap" : {
"description" : "value must be a valid map of schedule maps for a DB.",
"type" : "object",
"properties" : {
"cache_field_values" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.util.cron.ScheduleMap"
}, {
"type" : "null"
} ]
},
"metadata_sync" : {
"$ref" : "#/components/schemas/metabase.util.cron.ScheduleMap"
}
},
"additionalProperties" : false
},
"metabase.task-history.api.RunEntity" : {
"type" : "object",
"properties" : {
"entity_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"entity_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"entity_type" : {
"type" : "string",
"enum" : [ "dashboard", "card", "database" ]
}
},
"required" : [ "entity_type", "entity_id" ]
},
"metabase.task-history.api.RunFilterParams" : {
"type" : "object",
"properties" : {
"entity-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"entity-type" : {
"type" : "string",
"enum" : [ "dashboard", "card", "database" ]
},
"run-type" : {
"type" : "string",
"enum" : [ "alert", "sync", "fingerprint", "subscription" ]
},
"started-at" : {
"type" : "string",
"minLength" : 1
},
"status" : {
"type" : "string",
"enum" : [ "started", "success", "failed", "abandoned" ]
}
},
"additionalProperties" : false
},
"metabase.task-history.api.RunSortParams" : {
"type" : "object",
"properties" : {
"sort-column" : {
"default" : "started_at",
"type" : "string",
"enum" : [ "started_at", "run_type", "entity_name", "ended_at", "status", "task_count" ]
},
"sort-direction" : {
"default" : "desc",
"type" : "string",
"enum" : [ "asc", "desc" ]
}
},
"required" : [ ],
"additionalProperties" : false
},
"metabase.task-history.api.TaskHistory" : {
"type" : "object",
"properties" : {
"task_details" : {
"oneOf" : [ {
"type" : "object",
"properties" : { }
}, {
"type" : "null"
} ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"started_at" : { },
"ended_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"status" : {
"type" : "string",
"enum" : [ "started", "success", "failed", "unknown" ]
},
"logs" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"task" : {
"type" : "string"
},
"duration" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"run_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "task", "started_at", "ended_at", "duration", "status" ]
},
"metabase.task-history.api.TaskRun" : {
"type" : "object",
"properties" : {
"run_type" : {
"type" : "string",
"enum" : [ "alert", "sync", "fingerprint", "subscription" ]
},
"entity_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"started_at" : { },
"failed_count" : {
"type" : "integer"
},
"ended_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"entity_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"status" : {
"type" : "string",
"enum" : [ "started", "success", "failed", "abandoned" ]
},
"task_count" : {
"type" : "integer"
},
"success_count" : {
"type" : "integer"
},
"entity_type" : {
"type" : "string",
"enum" : [ "dashboard", "card", "database" ]
}
},
"required" : [ "id", "run_type", "entity_type", "entity_id", "started_at", "ended_at", "status" ]
},
"metabase.task-history.api.TaskRunWithTasks" : {
"type" : "object",
"properties" : {
"run_type" : {
"type" : "string",
"enum" : [ "alert", "sync", "fingerprint", "subscription" ]
},
"tasks" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.task-history.api.TaskHistory"
}
},
"entity_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
"started_at" : { },
"failed_count" : {
"type" : "integer"
},
"ended_at" : {
"oneOf" : [ { }, {
"type" : "null"
} ]
},
"entity_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"status" : {
"type" : "string",
"enum" : [ "started", "success", "failed", "abandoned" ]
},
"task_count" : {
"type" : "integer"
},
"success_count" : {
"type" : "integer"
},
"entity_type" : {
"type" : "string",
"enum" : [ "dashboard", "card", "database" ]
}
},
"required" : [ "id", "run_type", "entity_type", "entity_id", "started_at", "ended_at", "status", "tasks" ]
},
"metabase.task-history.api.TaskRunsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.task-history.api.TaskRun"
}
},
"limit" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
"offset" : {
"oneOf" : [ {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}, {
"type" : "null"
} ]
},
"total" : {
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
}
},
"required" : [ "total", "limit", "offset", "data" ]
},
"metabase.tiles.api.legacy-ref" : {
"description" : "Form-encoded JSON-encoded legacy MBQL :field ref.",
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
},
"metabase.tiles.api.query" : {
"description" : "Form-encoded JSON-encoded MBQL query.",
"$ref" : "#/components/schemas/metabase.lib.schema.query"
},
"metabase.timeline.api.timeline.Timeline" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "id" ]
},
"metabase.timeline.api.timeline.include" : {
"type" : "string",
"enum" : [ "events" ]
},
"metabase.transforms-base.util.source-table-entry" : {
"description" : "A source table entry in the array format. Combines alias with table reference. Callers may supply just\n `:table_id` (looked up to fill in `:database_id`/`:schema`/`:table`) or just\n `:database_id`/`:schema`/`:table` (looked up to fill in `:table_id`), so only `:alias` is required.",
"type" : "object",
"properties" : {
"alias" : {
"type" : "string"
},
"database_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
"table" : {
"type" : "string"
},
"table_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
}
},
"required" : [ "alias" ],
"additionalProperties" : false
},
"metabase.transforms-rest.api.transform.run-trigger" : {
"type" : "string",
"enum" : [ "none", "global-schedule" ]
},
"metabase.transforms.schema.append-config" : {
"type" : "object",
"properties" : {
"type" : {
"const" : "append"
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.transforms.schema.checkpoint-strategy" : {
"type" : "object",
"properties" : {
"checkpoint-filter-field-id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"lookback" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.transforms.schema.lookback"
}, {
"type" : "null"
} ]
},
"type" : {
"const" : "checkpoint"
}
},
"required" : [ "type" ],
"additionalProperties" : false
},
"metabase.transforms.schema.lookback" : {
"description" : "A lookback window: each run re-reads source rows up to `value` `unit`s behind the checkpoint,\n so late-arriving rows older than the watermark still get picked up. Only supported for\n temporal checkpoint columns.",
"type" : "object",
"properties" : {
"unit" : {
"type" : "string",
"enum" : [ "day", "hour", "millisecond", "minute", "month", "quarter", "second", "week", "year" ]
},
"value" : {
"type" : "integer",
"minimum" : 1
}
},
"required" : [ "value", "unit" ],
"additionalProperties" : false
},
"metabase.transforms.schema.merge-config" : {
"type" : "object",
"properties" : {
"type" : {
"const" : "merge"
},
"unique-key" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.transforms.schema.merge-key-column"
}
}
},
"required" : [ "type", "unique-key" ],
"additionalProperties" : false
},
"metabase.transforms.schema.merge-key-column" : {
"description" : "One column of a merge unique key. Carries a resolved `:field-id` when the target column is known,\n degrading to a `:name` ref when the target table doesn't exist yet (mirrors `::source-table-entry`).",
"type" : "object",
"properties" : {
"field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string",
"minLength" : 1
}
},
"additionalProperties" : false
},
"metabase.transforms.schema.orphaned-query" : {
"description" : "The MBQL 5 query of a transform whose source database was deleted, kept as a breadcrumb with its `:database` nulled.",
"type" : "object",
"properties" : {
"database" : {
"type" : "null"
},
"lib/metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.metadata-provider"
},
"lib/type" : {
"const" : "mbql/query"
},
"stages" : {
"$ref" : "#/components/schemas/metabase.lib.schema.stages"
}
},
"required" : [ "lib/type", "database", "stages" ],
"additionalProperties" : false
},
"metabase.transforms.schema.source-incremental-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.transforms.schema.checkpoint-strategy"
} ]
},
"metabase.transforms.schema.table-incremental-target" : {
"type" : "object",
"properties" : {
"database" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"schema" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"target-incremental-strategy" : {
"$ref" : "#/components/schemas/metabase.transforms.schema.target-incremental-strategy"
},
"type" : {
"const" : "table-incremental"
}
},
"required" : [ "type", "name", "target-incremental-strategy" ],
"additionalProperties" : false
},
"metabase.transforms.schema.table-target" : {
"type" : "object",
"properties" : {
"database" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
"type" : "string"
},
"schema" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
},
"type" : {
"const" : "table"
}
},
"required" : [ "type", "name" ],
"additionalProperties" : false
},
"metabase.transforms.schema.target-incremental-strategy" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.transforms.schema.append-config"
}, {
"$ref" : "#/components/schemas/metabase.transforms.schema.merge-config"
} ]
},
"metabase.transforms.schema.transform-source" : {
"oneOf" : [ {
"type" : "object",
"properties" : {
"query" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.transforms.schema.orphaned-query"
}, {
"$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
} ]
},
"source-incremental-strategy" : {
"$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
},
"type" : {
"const" : "query"
}
},
"required" : [ "type", "query" ],
"additionalProperties" : false
}, {
"type" : "object",
"properties" : {
"body" : {
"type" : "string"
},
"source-database" : {
"type" : "integer"
},
"source-incremental-strategy" : {
"$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
},
"source-tables" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/metabase.transforms-base.util.source-table-entry"
}
},
"type" : {
File truncated at 1 MB.