Skip to content

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

Auto-update documentation for master (#82532)

github-automation-metabasec19c1bfdebdc
diff --git a/docs/api.json b/docs/api.json
index 6edf7c3d0a0..ecdb090243c 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -1034,45 +1034,72 @@
"description" : "Options for `:time-interval` operator. Note that `:relative-time-interval` does not support these options.",
"type" : "object",
"properties" : {
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "metabase.query-processor.util.add-alias-info/source-table" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
- "base-type" : {
+ "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.base-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "effective-type" : {
+ "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.base-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "semantic-type" : {
+ "effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "database-type" : {
+ "base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "name" : {
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "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"
}, {
@@ -1082,32 +1109,24 @@
"lib/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "case-sensitive" : {
- "type" : "boolean"
+ "metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
- "include-current" : {
+ "metabase.driver.sqlserver/optimized-bucketing?" : {
"type" : "boolean"
},
- "lib/source-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "default" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
- },
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- },
- "qp/ignore-coercion" : {
- "type" : "boolean"
+ "metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
- "qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
+ "case-sensitive" : {
"type" : "boolean"
},
- "qp/native-sandbox-column.force-coercion-strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
- },
- "metabase.query-processor.util.add-alias-info/source-table" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
+ "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" : [ {
@@ -1116,6 +1135,9 @@
"type" : "null"
} ]
},
+ "metabase.driver.sql.query-processor/wrap-in-case" : {
+ "type" : "boolean"
+ },
"metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
@@ -1123,43 +1145,44 @@
"type" : "null"
} ]
},
- "metabase.query-processor.util.add-alias-info/nfc-path" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "metabase.query-processor.util.add-alias-info/resolved" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
+ "qp/ignore-coercion" : {
"type" : "boolean"
},
- "metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "source-field" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
- "metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
- "metabase.driver.sql.query-processor/forced-alias" : {
- "type" : "boolean"
+ "metabase.driver.mongo.query-processor/join-local" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
- "metabase.driver.sql.query-processor/add-cast" : {
- "type" : "string"
+ "qp/native-sandbox-column.force-coercion-strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
- "metabase.driver.sql.query-processor/wrap-in-case" : {
- "type" : "boolean"
+ "metabase.query-processor.util.add-alias-info/resolved" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
},
- "metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
+ "include-current" : {
"type" : "boolean"
},
- "metabase.driver.sqlserver/optimized-bucketing?" : {
- "type" : "boolean"
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
- "metabase.driver.mongo.query-processor/join-local" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "default" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
- "metabase.mcp.v2.query/keyset" : {
+ "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"
}
},
@@ -1935,7 +1958,7 @@
"dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
@@ -2003,7 +2026,7 @@
"dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
@@ -2045,7 +2068,7 @@
"dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
@@ -2059,6 +2082,28 @@
},
"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" : [ {
+ "type" : "object",
+ "properties" : {
+ "detail" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.validate.validate-error-type"
+ }
+ },
+ "required" : [ "type" ],
+ "additionalProperties" : false
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ } ]
+ },
"metabase-enterprise.dependencies.api.document-entity" : {
"type" : "object",
"properties" : {
@@ -2084,7 +2129,7 @@
"dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
@@ -2177,7 +2222,7 @@
"dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
@@ -2211,7 +2256,7 @@
"dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
@@ -2261,7 +2306,7 @@
"dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
@@ -2300,7 +2345,7 @@
"dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
@@ -2343,7 +2388,7 @@
"dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
@@ -2383,7 +2428,7 @@
"dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dependent-error"
},
"uniqueItems" : true
},
@@ -2455,7 +2500,8 @@
} ]
}
},
- "required" : [ "id", "analyzed_entity_type", "analyzed_entity_id", "error_type" ]
+ "required" : [ "id", "analyzed_entity_type", "analyzed_entity_id", "error_type" ],
+ "additionalProperties" : false
},
"metabase-enterprise.erd.impl.erd-edge" : {
"type" : "object",
@@ -2667,7 +2713,39 @@
"properties" : {
"data" : {
"type" : "object",
- "properties" : { }
+ "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",
@@ -2701,7 +2779,8 @@
}
}
},
- "required" : [ "model-type", "model-id", "decision", "segment", "message", "data", "suggestions" ]
+ "required" : [ "model-type", "model-id", "decision", "segment", "message", "data", "suggestions" ],
+ "additionalProperties" : false
},
"metabase-enterprise.replacement.schema.check-replace-source-response" : {
"type" : "object",
@@ -3020,7 +3099,8 @@
"$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" ]
+ "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).",
@@ -3297,7 +3377,8 @@
} ]
}
},
- "required" : [ "id", "name", "base_type" ]
+ "required" : [ "id", "name", "base_type" ],
+ "additionalProperties" : false
},
"metabase-enterprise.transforms-inspector.schema.field-stats" : {
"description" : "Statistics for a field from fingerprints.",
@@ -3330,7 +3411,8 @@
"q3" : {
"type" : "number"
}
- }
+ },
+ "additionalProperties" : false
},
"metabase-enterprise.transforms-inspector.schema.group-role" : {
"description" : "Role of a card within a comparison group.",
@@ -3531,7 +3613,8 @@
"type" : "string"
}
},
- "required" : [ "table_id", "table_name", "db_id", "column_count", "fields" ]
+ "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.",
@@ -7272,9 +7355,24 @@
} ]
},
"metabase.channel.schema.email-details" : {
- "description" : "The connection `:details` of a `:channel/email` channel: there are none, email is configured by settings.",
+ "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" : { },
+ "properties" : {
+ "host" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "port" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
"additionalProperties" : false
},
"metabase.channel.schema.http-details" : {
@@ -7511,6 +7609,131 @@
},
"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" ]
@@ -7850,7 +8073,7 @@
"required" : [ "id", "email", "first_name", "last_name", "timestamp" ]
},
"metabase.collections.schema.collection" : {
- "description" : "A Collection as selected from the app DB: every column of `: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" : {
@@ -7861,7 +8084,11 @@
} ]
},
"entity_id" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"authority_level" : {
"oneOf" : [ {
@@ -7875,11 +8102,22 @@
} ]
},
"is_sample" : {
- "type" : "boolean"
+ "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"
@@ -7888,16 +8126,35 @@
} ]
},
"name" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"slug" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"archived" : {
- "type" : "boolean"
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
"location" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_write" : {
+ "type" : "boolean"
},
"type" : {
"oneOf" : [ {
@@ -7911,8 +8168,12 @@
} ]
},
"created_at" : {
- "type" : "string",
- "format" : "date-time"
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
"namespace" : {
"oneOf" : [ {
@@ -7925,6 +8186,13 @@
"type" : "null"
} ]
},
+ "is_personal" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"personal_owner_id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.user"
@@ -7947,7 +8215,165 @@
} ]
}
},
- "required" : [ "id", "name", "description", "archived", "location", "personal_owner_id", "slug", "namespace", "authority_level", "entity_id", "created_at", "type", "is_sample", "archive_operation_id", "archived_directly", "is_remote_synced" ],
+ "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" : {
@@ -8027,3971 +8453,3291 @@
"required" : [ "type" ],
"additionalProperties" : false
},
- "metabase.data-studio.api.table.bulk-table-info" : {
- "description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.",
+ "metabase.content-verification.schema..moderation-review.update" : {
+ "description" : "What an update (or insert) of a ModerationReview accepts: every column of `:moderation_review` except `id`, all optional.",
"type" : "object",
"properties" : {
- "db_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "display_name" : {
- "type" : "string"
+ "moderated_item_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
+ "moderated_item_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "is_published" : {
- "type" : "boolean"
+ "moderator_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "type" : "string"
+ "most_recent" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "schema" : {
+ "status" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "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" : {
+ "text" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "unpublished_upstream_tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
- }
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "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" ]
+ "additionalProperties" : false
},
- "metabase.data-studio.api.table.table-selectors" : {
+ "metabase.content-verification.schema.moderation-review" : {
+ "description" : "What an update (or insert) of a ModerationReview accepts: every column of `:moderation_review` except `id`, all optional.",
"type" : "object",
"properties" : {
- "database_ids" : {
- "type" : "array",
- "items" : {
+ "moderator_id" : {
+ "oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "schema_ids" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
+ "user" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.users.schema.user"
+ }, {
+ "type" : "null"
+ } ]
},
- "table_ids" : {
- "type" : "array",
- "items" : {
+ "moderated_item_id" : {
+ "oneOf" : [ {
"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"
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "operator" : {
- "type" : "string"
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "value" : {
+ "status" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
- "type" : "number"
- }, {
- "type" : "boolean"
+ "type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "values" : {
- "type" : "array",
- "prefixItems" : [ {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "number"
- }, {
- "type" : "boolean"
- } ]
- }, {
- "type" : "null"
- } ]
+ "text" : {
+ "oneOf" : [ {
+ "type" : "string"
}, {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "number"
- }, {
- "type" : "boolean"
- } ]
+ "type" : "null"
+ } ]
+ },
+ "moderated_item_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
}, {
- "type" : "null"
+ "type" : "string"
} ]
+ }, {
+ "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" : {
+ },
+ "most_recent" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.documents.prose-mirror..card-embed.explore-filter"
- }
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "query_ids" : {
+ "created_at" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "integer"
- }
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
}
},
+ "required" : [ "id" ],
"additionalProperties" : false
},
- "metabase.documents.prose-mirror..node.attrs" : {
- "description" : "Value must be a map.",
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
- }, {
- "description" : "Value must be a map."
- } ],
+ "metabase.dashboards.schema..dashboard-card.parameter-mapping" : {
+ "description" : "One entry of the `:parameter_mappings` column of a DashboardCard, decoded.",
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
+ },
+ "metabase.dashboards.schema..dashboard-card.update" : {
+ "description" : "What an update (or insert) of a DashboardCard accepts: every column of `:report_dashboardcard` except `id`, all optional.",
"type" : "object",
"properties" : {
- "model" : {
+ "inline_parameters" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
}, {
"type" : "null"
} ]
},
- "stored_result_id" : {
+ "visualization_settings" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.dashboards.schema..dashboard-card.visualization-settings"
}, {
"type" : "null"
} ]
},
- "label" : {
+ "dashboard_tab_id" : {
"oneOf" : [ {
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "id" : {
+ "entity_id" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "string"
- } ]
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "chart_href" : {
+ "parameter_mappings" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.dashboards.schema..dashboard-card.parameter-mapping"
+ }
}, {
"type" : "null"
} ]
},
- "_id" : {
+ "card_id" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string",
- "format" : "uuid"
- } ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
- "entityId" : {
+ "size_x" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "string"
- } ]
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "child_target_id" : {
+ "updated_at" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "host_data" : {
+ "size_y" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.documents.prose-mirror..card-embed.host-data"
+ "type" : "integer"
}, {
"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" : {
+ },
+ "col" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.documents.prose-mirror..node.attrs"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "content" : {
+ "row" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
- }
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "marks" : {
+ "created_at" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
- }
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "text" : {
+ "action_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.action"
}, {
"type" : "null"
} ]
},
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "type" ],
- "additionalProperties" : false
- },
- "metabase.documents.schema..document.id" : {
- "description" : "Valid Document ID",
- "type" : "integer",
- "minimum" : 1
- },
- "metabase.driver..native-query-deps.table-dep" : {
- "type" : "object",
- "properties" : {
- "schema" : {
- "type" : "string"
- },
- "table" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
}, {
- "type" : "string"
+ "type" : "null"
} ]
}
},
- "required" : [ "table" ],
"additionalProperties" : false
},
- "metabase.driver..native-query-deps.transform-dep" : {
+ "metabase.dashboards.schema..dashboard-card.visualization-settings" : {
+ "description" : "Value must be a map.",
"type" : "object",
- "properties" : {
- "transform" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
- }
- },
- "required" : [ "transform" ],
- "additionalProperties" : false
- },
- "metabase.driver.connection.connection-type" : {
- "type" : "string",
- "enum" : [ "default", "write-data", "admin", "transform" ]
+ "properties" : { }
},
- "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.",
+ "metabase.dashboards.schema..dashboard-tab.update" : {
+ "description" : "What an update (or insert) of a DashboardTab accepts: every column of `:dashboard_tab` except `id`, all optional.",
"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"
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
- }
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ }, {
+ "type" : "null"
+ } ]
},
- "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" : { }
+ "type" : "string"
}, {
- "description" : "Value must be a map."
+ "type" : "null"
} ]
},
- "updated_at" : { }
- },
- "required" : [ "id", "entity_id", "name", "settings", "is_default", "created_at", "updated_at" ]
- },
- "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
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "kind" : {
- "const" : "sortkey"
+ "position" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "style" : {
- "type" : "string",
- "enum" : [ "compound", "interleaved" ]
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "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.dashboards.schema..dashboard.parameter" : {
+ "description" : "One entry of the `:parameters` column of a Dashboard, decoded.",
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
},
- "metabase.legacy-mbql.schema..legacy-column-metadata.qualified-keys" : {
+ "metabase.dashboards.schema..dashboard.update" : {
+ "description" : "What an update (or insert) of a Dashboard accepts: every column of `:report_dashboard` except `id`, all optional.",
"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" : {
+ "points_of_interest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.lib.metadata.result-metadata/field-ref" : {
+ "enable_embedding" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "metabase.lib.metadata.result-metadata/remove-join-alias?" : {
- "type" : "boolean"
- },
- "lib/external-remap" : {
+ "auto_apply_filters" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "metabase.driver.mongo.query-processor/source-alias" : {
+ "width" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/source-column-alias" : {
+ "last_viewed_at" : {
"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" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "lib/temporal-unit" : {
+ "initially_published_at" : {
"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" ]
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "lib/type" : {
- "default" : "metadata/column",
- "const" : "metadata/column"
- },
- "lib/source-uuid" : {
+ "view_count" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "metabase.driver.mongo.query-processor/join-field" : {
+ "entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "qp/implicit-field?" : {
+ "embedding_type" : {
"oneOf" : [ {
- "type" : "boolean"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "lib/ref-name" : {
+ "show_in_getting_started" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "dimension/id" : {
+ "position" : {
"oneOf" : [ {
- "description" : "Valid Dimension ID",
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "metabase.lib.underlying/binning" : {
+ "made_public_by_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"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.",
+ "name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/transformation-added-base-type" : {
+ "archived" : {
"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" : {
+ "collection_position" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "lib/from-model?" : {
+ "embedding_params" : {
"oneOf" : [ {
- "type" : "boolean"
+ "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"
} ]
},
- "lib/original-fk-join-alias" : {
+ "updated_at" : {
"oneOf" : [ {
"type" : "string",
- "minLength" : 1
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "lib/original-fk-field-name" : {
+ "collection_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
- "lib/card-id" : {
+ "cache_ttl" : {
"oneOf" : [ {
- "description" : "Valid Card ID",
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "metabase.lib.underlying/temporal-unit" : {
+ "created_at" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "lib/expression-name" : {
+ "public_uuid" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/breakout?" : {
+ "caveats" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "values/human-readable-values" : {
+ "parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ "$ref" : "#/components/schemas/metabase.dashboards.schema..dashboard.parameter"
}
}, {
"type" : "null"
} ]
},
- "lib/original-effective-type" : {
+ "creator_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
- "lib/join-alias" : {
+ "archived_directly" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "lib/source-display-name" : {
+ "public_uuid_prefix" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "dimension/human-readable-field-id" : {
+ "description" : {
"oneOf" : [ {
- "description" : "Valid Field ID",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
- },
- "lib/original-fk-field-id" : {
+ }
+ },
+ "additionalProperties" : false
+ },
+ "metabase.dashboards.schema.dashboard" : {
+ "description" : "What an update (or insert) of a Dashboard accepts: every column of `:report_dashboard` except `id`, all optional.",
+ "type" : "object",
+ "properties" : {
+ "points_of_interest" : {
"oneOf" : [ {
- "description" : "Valid Field ID",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "qp/native-sandbox-column.propagate-coercion?" : {
- "type" : "boolean"
- },
- "metabase.lib.join/HACK-from-incomplete-join?" : {
+ "enable_embedding" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "lib/internal-remap" : {
+ "auto_apply_filters" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "lib/options" : {
+ "width" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.lib-options"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/original-binning" : {
+ "collection_authority_level" : {
"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
+ "anyOf" : [ {
+ "type" : "string"
}, {
- "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" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "lib/original-join-alias" : {
+ "last-edit-info" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "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",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "timestamp", "id", "first_name", "last_name", "email" ],
+ "additionalProperties" : false
}, {
"type" : "null"
} ]
},
- "lib/original-display-name" : {
+ "last_viewed_at" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "metabase.lib.field.resolution/fallback-metadata?" : {
+ "can_delete" : {
"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" : {
+ "initially_published_at" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "lib/source" : {
+ "view_count" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "lib/ref-display-name" : {
+ "entity_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "dimension/type" : {
+ "collection" : {
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "internal", "external" ]
+ "$ref" : "#/components/schemas/metabase.collections.schema.collection-or-root"
}, {
"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.",
+ "can_set_cache_policy" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ },
+ "embedding_type" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "lib/original-ref-style-for-result-metadata-purposes" : {
- "type" : "string",
- "enum" : [ "original-ref-style/id", "original-ref-style/name" ]
+ "moderation_reviews" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.content-verification.schema.moderation-review"
+ }
},
- "metabase.driver.mongo.query-processor/inherited?" : {
+ "show_in_getting_started" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "dimension/name" : {
+ "resolved-params" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.resolved-parameter"
+ }
}, {
"type" : "null"
} ]
},
- "lib/simple-display-name" : {
+ "position" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "lib/desired-column-alias" : {
+ "creator" : {
"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"
+ "$ref" : "#/components/schemas/metabase.users.schema.user"
}, {
"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" : {
+ "is_remote_synced" : {
"type" : "boolean"
},
- "database-type" : {
+ "made_public_by_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"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" : {
+ "name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "base-type" : {
+ "archived" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "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"
- },
- "metabase.query-processor.util.add-alias-info/source-alias" : {
+ "collection_position" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "metabase.driver.sql.query-processor/wrap-in-case" : {
- "type" : "boolean"
- },
- "metabase.query-processor.util.add-alias-info/desired-alias" : {
+ "embedding_params" : {
"oneOf" : [ {
- "type" : "string"
+ "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"
} ]
},
- "lib/source-name" : {
- "type" : "string",
- "minLength" : 1
- },
- "qp/ignore-coercion" : {
- "type" : "boolean"
- },
- "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"
- },
- "default" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
- },
- "semantic-type" : {
+ "tabs" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.dashboards.schema.dashboard-tab"
+ }
}, {
"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"
- },
- "database-type" : {
+ "updated_at" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "metabase.driver.sql.query-processor/forced-alias" : {
- "type" : "boolean"
+ "moderation_status" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
+ "can_write" : {
"type" : "boolean"
},
- "display-name" : {
+ "collection_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
- "effective-type" : {
+ "cache_ttl" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "base-type" : {
+ "param_fields" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.param-field"
+ }
+ }
}, {
"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
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
+ "public_uuid" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/expression-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "can_restore" : {
+ "type" : "boolean"
},
- "metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "last_used_param_values" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.users.schema..user-parameter-value.value"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.driver.sqlserver/optimized-bucketing?" : {
- "type" : "boolean"
+ "caveats" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "parameters" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.dashboards.schema..dashboard.parameter"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "case-sensitive" : {
- "type" : "boolean"
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib/original-effective-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "archived_directly" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.util.add-alias-info/source-alias" : {
+ "public_uuid_prefix" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.driver.sql.query-processor/wrap-in-case" : {
- "type" : "boolean"
+ "dashcards" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.dashboards.schema.dashboard-card"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.util.add-alias-info/desired-alias" : {
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
+ },
+ "metabase.dashboards.schema.dashboard-card" : {
+ "description" : "What an update (or insert) of a DashboardCard accepts: every column of `:report_dashboardcard` except `id`, all optional.",
+ "type" : "object",
+ "properties" : {
+ "collection_authority_level" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "lib/source-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "inline_parameters" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "qp/ignore-coercion" : {
- "type" : "boolean"
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.dashboards.schema..dashboard-card.visualization-settings"
+ }, {
+ "type" : "null"
+ } ]
},
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "dashboard_tab_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.driver.mongo.query-processor/join-local" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "qp/native-sandbox-column.force-coercion-strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.dashboards.schema..dashboard-card.parameter-mapping"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.util.add-alias-info/resolved" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashcard"
},
- "include-current" : {
- "type" : "boolean"
+ "card_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
},
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "size_x" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "default" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "semantic-type" : {
+ "size_y" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "type" : "integer"
}, {
"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" : {
- "$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"
- } ]
- },
- "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" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "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" : {
- "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" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "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" : {
+ "col" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "action" : {
+ "oneOf" : [ {
"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" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "response_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_enabled_actions" : {
+ "type" : "boolean"
+ },
+ "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"
+ } ]
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.type"
+ },
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.template"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "error_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "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" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "disabled" : {
+ "type" : "boolean"
+ },
+ "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"
+ } ]
+ },
+ "public_uuid_prefix" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
}, {
- "type" : "null"
- } ]
- },
- "base_type" : {
- "default" : "type/*",
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "source_alias" : {
- "oneOf" : [ {
- "type" : "string"
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_enabled_actions" : {
+ "type" : "boolean"
+ },
+ "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"
+ } ]
+ },
+ "kind" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
+ }, {
+ "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" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "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"
+ } ]
+ },
+ "public_uuid_prefix" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
}, {
- "type" : "null"
- } ]
- },
- "lib/source-uuid" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_enabled_actions" : {
+ "type" : "boolean"
+ },
+ "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"
+ } ]
+ },
+ "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" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "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"
+ } ]
+ },
+ "public_uuid_prefix" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
}, {
- "type" : "null"
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "response_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_enabled_actions" : {
+ "type" : "boolean"
+ },
+ "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"
+ } ]
+ },
+ "kind" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.type"
+ },
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.template"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "error_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "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" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "disabled" : {
+ "type" : "boolean"
+ },
+ "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"
+ } ]
+ },
+ "public_uuid_prefix" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
} ]
- },
- "custom_position" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "metabase.driver.mongo.query-processor/join-field" : {
- "oneOf" : [ {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "row" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "series" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.card"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "card" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.card"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "action_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.action"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
+ },
+ "metabase.dashboards.schema.dashboard-tab" : {
+ "description" : "What an update (or insert) of a DashboardTab accepts: every column of `:dashboard_tab` except `id`, all optional.",
+ "type" : "object",
+ "properties" : {
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "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"
+ } ]
+ },
+ "position" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ],
+ "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" : "null"
+ "type" : "number"
+ }, {
+ "type" : "boolean"
} ]
- },
- "special_type" : {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "values" : {
+ "type" : "array",
+ "prefixItems" : [ {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
}, {
- "type" : "string"
+ "type" : "number"
+ }, {
+ "type" : "boolean"
} ]
}, {
"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
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
}, {
"type" : "null"
} ]
- },
- "position" : {
- "oneOf" : [ {
+ } ]
+ }
+ },
+ "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"
- } ]
- },
- "fingerprint_version" : {
- "oneOf" : [ {
+ }
+ }, {
+ "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" : "null"
+ "type" : "string"
} ]
- },
- "name" : {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "chart_href" : {
+ "oneOf" : [ {
"type" : "string"
- },
- "lib/original-fk-field-name" : {
- "oneOf" : [ {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "_id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
"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"
+ "format" : "uuid"
} ]
- },
- "database_position" : {
- "oneOf" : [ {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entityId" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
"type" : "integer"
}, {
- "type" : "null"
+ "type" : "string"
} ]
- },
- "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" : "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.document" : {
+ "description" : "The `:document` column of a Document, decoded.",
+ "$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
+ },
+ "metabase.documents.schema..document.id" : {
+ "description" : "Valid Document ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.documents.schema..document.update" : {
+ "description" : "What an update (or insert) of a Document accepts: every column of `:document` except `id`, all optional.",
+ "type" : "object",
+ "properties" : {
+ "last_viewed_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_placeholder" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "view_count" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "document" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.documents.schema..document.document"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "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" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "exploration_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "public_uuid" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "archived_directly" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "public_uuid_prefix" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "content_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
"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" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ },
+ "metabase.documents.schema.document" : {
+ "description" : "What an update (or insert) of a Document accepts: every column of `:document` except `id`, all optional.",
+ "type" : "object",
+ "properties" : {
+ "last_viewed_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_delete" : {
+ "type" : "boolean"
+ },
+ "is_placeholder" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "view_count" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
"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" : "null"
+ } ]
+ },
+ "collection" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.collections.schema.collection-or-root"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "document" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.documents.schema..document.document"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.users.schema.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_remote_synced" : {
+ "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"
- },
- "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" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_write" : {
+ "type" : "boolean"
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "exploration_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "public_uuid" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_restore" : {
+ "type" : "boolean"
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "archived_directly" : {
+ "oneOf" : [ {
"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" : "null"
+ } ]
+ },
+ "public_uuid_prefix" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "content_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
"type" : "string"
}, {
- "type" : "null"
- } ]
- },
- "binning_info" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..legacy-column-metadata.binning-info"
- }, {
- "type" : "null"
+ "type" : "string"
} ]
- },
- "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.empty-query" : {
- "const" : { }
- },
- "metabase.lib-be.schema.internal-query" : {
- "type" : "object",
- "properties" : {
- "args" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "number"
- }, {
- "type" : "boolean"
- } ]
- }, {
- "type" : "null"
- } ]
- }
}, {
"type" : "null"
} ]
- },
- "fn" : {
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
+ },
+ "metabase.driver..native-query-deps.table-dep" : {
+ "type" : "object",
+ "properties" : {
+ "schema" : {
"type" : "string"
},
- "limit" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "middleware" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
- },
- "offset" : {
- "oneOf" : [ {
- "type" : "integer"
+ "table" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
- "type" : "null"
+ "type" : "string"
} ]
- },
- "type" : {
- "const" : "internal"
}
},
- "required" : [ "type", "fn" ],
+ "required" : [ "table" ],
"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" : {
- "description" : "Target field reference for a dimension mapping, e.g. [:field {:source-field 1} 2].",
- "$ref" : "#/components/schemas/mbql.clause.field"
- },
- "metabase.lib-metric.schema..dimension-mapping.type" : {
- "description" : "Type of dimension mapping.",
- "type" : "string",
- "enum" : [ "table" ]
- },
- "metabase.lib-metric.schema..dimension-reference.options" : {
- "description" : "Options map for dimension references.",
+ "metabase.driver..native-query-deps.transform-dep" : {
"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"
- } ]
+ "transform" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
}
},
+ "required" : [ "transform" ],
"additionalProperties" : false
},
- "metabase.lib-metric.schema..dimension-source.type" : {
+ "metabase.driver.connection.connection-type" : {
"type" : "string",
- "enum" : [ "field" ]
+ "enum" : [ "default", "write-data", "admin", "transform" ]
},
- "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" : { },
+ "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" : {
- "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" : {
+ "description" : { },
+ "directions" : {
"type" : "boolean"
},
- "qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
- "type" : "boolean"
+ "display-name" : { },
+ "name" : {
+ "type" : "string"
},
- "database-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
+ "options" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "name" : { },
+ "value" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name", "value" ]
+ }
},
- "metabase.driver.sql.query-processor/forced-alias" : {
+ "required" : {
"type" : "boolean"
},
- "metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
- "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"
+ }
},
- "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"
- } ]
- },
- "metabase.query-processor.util.add-alias-info/nfc-path" : {
+ "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
},
- "metabase.driver.sql.query-processor/add-cast" : {
- "type" : "string"
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "is_default" : {
+ "type" : "boolean"
},
"name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "settings" : {
+ "description" : "Value must be a map.",
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "object",
+ "additionalProperties" : { }
}, {
- "type" : "null"
+ "description" : "Value must be a map."
} ]
},
- "lib/expression-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "updated_at" : { }
+ },
+ "required" : [ "id", "entity_id", "name", "settings", "is_default", "created_at", "updated_at" ]
+ },
+ "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"
},
- "metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "health" : {
+ "type" : "number"
},
- "metabase.driver.sqlserver/optimized-bucketing?" : {
- "type" : "boolean"
+ "message" : {
+ "type" : "string"
},
- "metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "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
},
- "case-sensitive" : {
- "type" : "boolean"
+ "include" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.indexes.schema.column-name"
+ }
},
- "metabase.query-processor.util.add-alias-info/source-alias" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "kind" : {
+ "type" : "string",
+ "enum" : [ "btree", "hash", "gin", "gist", "brin", "spgist", "fulltext", "spatial", "clustered", "nonclustered", "columnstore" ]
},
- "offset-value" : {
- "type" : "integer"
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.indexes.schema.index-name"
},
- "metabase.driver.sql.query-processor/wrap-in-case" : {
+ "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
},
- "offset-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "kind" : {
+ "const" : "clustering"
},
- "metabase.query-processor.util.add-alias-info/desired-alias" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "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" ]
},
- "lib/source-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "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
},
- "qp/ignore-coercion" : {
- "type" : "boolean"
+ "kind" : {
+ "const" : "distkey"
},
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "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
},
- "metabase.driver.mongo.query-processor/join-local" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "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
},
- "qp/native-sandbox-column.force-coercion-strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
+ "granularity" : {
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.query-processor.util.add-alias-info/resolved" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
+ "kind" : {
+ "const" : "skip-index"
},
- "include-current" : {
- "type" : "boolean"
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.indexes.schema.index-name"
},
- "default" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
+ "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
},
- "semantic-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
+ "kind" : {
+ "const" : "sortkey"
},
- "metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
- "type" : "boolean"
+ "style" : {
+ "type" : "string",
+ "enum" : [ "compound", "interleaved" ]
}
},
- "required" : [ "lib/uuid" ],
+ "required" : [ "kind", "style", "columns" ],
"additionalProperties" : false
},
- "metabase.lib-metric.schema.binning" : {
- "description" : "Schema for `:binning` options passed to a `:dimension` clause.",
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "const" : "default"
- }
+ "metabase.legacy-mbql.schema..legacy-column-metadata.binning-info" : {
+ "type" : "object",
+ "properties" : {
+ "bin_width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
- "required" : [ "strategy" ],
- "additionalProperties" : false
- }, {
- "type" : "object",
- "properties" : {
- "bin-width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.positive-number"
- },
- "strategy" : {
- "const" : "bin-width"
- }
+ "binning_strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
},
- "required" : [ "strategy", "bin-width" ],
- "additionalProperties" : false
- }, {
- "type" : "object",
- "properties" : {
- "num-bins" : {
- "type" : "integer",
- "minimum" : 1
- },
- "strategy" : {
- "const" : "num-bins"
- }
+ "max_value" : {
+ "type" : "number"
},
- "required" : [ "strategy", "num-bins" ],
- "additionalProperties" : false
- } ]
+ "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.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.",
+ "metabase.legacy-mbql.schema..legacy-column-metadata.qualified-keys" : {
"type" : "object",
"properties" : {
- "sources" : {
+ "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" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-source"
- }
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "group" : {
+ "metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-group"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "metabase.lib.metadata.result-metadata/remove-join-alias?" : {
+ "type" : "boolean"
+ },
+ "lib/external-remap" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
}, {
"type" : "null"
} ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
- },
- "effective-type" : {
+ "metabase.driver.mongo.query-processor/source-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "name" : {
+ "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"
} ]
},
- "status" : {
+ "lib/temporal-unit" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
+ "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"
} ]
},
- "has-field-values" : {
+ "lib/type" : {
+ "default" : "metadata/column",
+ "const" : "metadata/column"
+ },
+ "lib/source-uuid" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}, {
"type" : "null"
} ]
},
- "status-message" : {
+ "metabase.driver.mongo.query-processor/join-field" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "default-temporal-unit" : {
+ "qp/implicit-field?" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "lib/source" : {
+ "lib/ref-name" : {
"oneOf" : [ {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
- }, {
- "type" : "string"
- } ]
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "dimension-interestingness" : {
+ "dimension/id" : {
"oneOf" : [ {
- "type" : "number"
+ "description" : "Valid Dimension ID",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "default" : {
+ "metabase.lib.underlying/binning" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
}, {
"type" : "null"
} ]
},
- "semantic-type" : {
+ "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" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "id" ],
- "additionalProperties" : false
- },
- "metabase.lib-metric.schema.dimension-group" : {
- "description" : "Group descriptor for a dimension, indicating which table it belongs to.",
- "type" : "object",
- "properties" : {
- "display-name" : {
- "type" : "string"
},
- "id" : {
- "type" : "string"
+ "values/values" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "type" : "string",
- "enum" : [ "main", "connection" ]
- }
- },
- "required" : [ "id", "type", "display-name" ],
- "additionalProperties" : false
- },
- "metabase.lib-metric.schema.dimension-id" : {
- "description" : "UUID string identifying a dimension.",
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- },
- "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" : {
+ "lib/original-expression-name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ "type" : "string",
+ "minLength" : 1
}, {
"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" : {
- "type" : "object",
- "properties" : {
- "binning" : {
+ "lib/from-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "field-id" : {
+ "lib/original-fk-join-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-source.type"
- }
- },
- "required" : [ "type" ],
- "additionalProperties" : false
- },
- "metabase.lib-metric.schema.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-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/original-fk-field-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "lib/card-id" : {
+ "oneOf" : [ {
+ "description" : "Valid Card ID",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "projection" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-reference"
- }
+ "metabase.lib.underlying/temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
+ "lib/expression-name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "refresh_automatically" : {
+ "lib/breakout?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "type" : {
- "const" : "duration"
+ "values/human-readable-values" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "unit" : {
- "type" : "string",
- "enum" : [ "hours", "minutes", "seconds", "days" ]
- }
- },
- "required" : [ "type", "duration", "unit" ],
- "additionalProperties" : false
- },
- "metabase.lib.schema..cache-strategy.nocache" : {
- "type" : "object",
- "properties" : {
- "name" : {
+ "lib/original-effective-type" : {
"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" : {
+ "lib/join-alias" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, { } ]
+ "type" : "string",
+ "minLength" : 1
}, {
"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" : {
+ },
+ "lib/source-display-name" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"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"
+ "dimension/human-readable-field-id" : {
+ "oneOf" : [ {
+ "description" : "Valid Field ID",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "const" : "ttl"
- }
- },
- "required" : [ "type", "multiplier", "min_duration_ms" ],
- "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.\n\n Deliberately NOT `[:ref ::query]`: [[malli.util/merge]] recurses into the entries that the two schemas being merged\n share, so a self-referential `::query` entry makes `[:merge ::query [:map [<same key> ::query]]]` -- which\n [[metabase.query-processor.util.add-alias-info]] uses -- recur until the stack blows. This shallow shape says what\n the value is without reintroducing the cycle.",
- "type" : "object",
- "properties" : {
- "lib/type" : {
- "const" : "mbql/query"
+ "lib/original-fk-field-id" : {
+ "oneOf" : [ {
+ "description" : "Valid Field ID",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "stages" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.stages"
- }
- },
- "required" : [ "lib/type", "stages" ]
- },
- "metabase.lib.schema..sandboxing.original-metadata" : {
- "description" : "The columns a query was expected to return *before* sandboxes replaced its source tables, stashed on the query by\n the enterprise sandboxing middleware (see `expected-cols` in\n `metabase-enterprise.sandbox.query-processor.middleware.sandboxing`) and compared against the sandboxed results\n afterwards.\n\n In production these are legacy, `snake_cased` column metadata maps (i.e.\n `:metabase.legacy-mbql.schema/legacy-column-metadata`), but this key is a verbatim snapshot that must survive\n normalization untouched -- pointing at that schema here would rewrite its keys and drop deprecated ones, which\n breaks round-tripping (see `metabase.lib.convert-test/round-trip-preserve-metadata-test`). So the elements are\n declared as plain maps, which carry no decoders.",
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
- },
- "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"
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "type" : "boolean"
},
- "source-query/native-model?" : {
+ "metabase.lib.join/HACK-from-incomplete-join?" : {
"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.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
+ "lib/internal-remap" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
+ }, {
+ "type" : "null"
+ } ]
},
- "qp/skip-persisted-cache" : {
- "type" : "boolean"
+ "lib/options" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.lib-options"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase-enterprise.sandbox.query-processor.middleware.sandboxing/sandbox?" : {
- "type" : "boolean"
+ "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"
+ } ]
},
- "source-query/model?" : {
- "type" : "boolean"
+ "lib/original-join-alias" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "parameters" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
+ "lib/original-display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "qp/added-implicit-fields?" : {
+ "metabase.lib.field.resolution/fallback-metadata?" : {
"type" : "boolean"
},
- "qp/stage-is-from-source-card" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ "qp/native-sandbox-column.force-coercion-strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
- "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?" : {
+ "lib/binning" : {
+ "oneOf" : [ {
+ "description" : "Schema for `:binning` options passed to a `:field` clause.",
"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"
- },
- "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"
- },
- "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"
- } ]
- },
- "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" : "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" : "null"
- } ]
- },
- "source-query/model?" : {
- "type" : "boolean"
- },
- "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"
+ "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"
+ }
},
- "uniqueItems" : true
+ "required" : [ "strategy", "bin-width" ],
+ "additionalProperties" : false
}, {
- "type" : "null"
+ "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
} ]
- },
- "template-tags" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tags"
- },
- "qp/added-implicit-fields?" : {
+ }, {
+ "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"
- },
- "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"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
+ "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.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"
- }
+ "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"
},
- "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"
- }
+ "metabase.mcp.v2.query/keyset" : {
+ "type" : "boolean"
},
- "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"
- }
+ "qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
+ "type" : "boolean"
},
- "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.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" : [ {
@@ -12007,22 +11753,26 @@
"type" : "boolean"
},
"display-name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "effective-type" : {
+ "base-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "base-type" : {
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -12037,14 +11787,13 @@
"type" : "string"
},
"lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "type" : "string",
+ "minLength" : 36,
+ "maxLength" : 36
},
"name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
+ "type" : "string",
+ "minLength" : 1
},
"lib/expression-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -12061,6 +11810,13 @@
"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"
@@ -12079,11 +11835,15 @@
} ]
},
"lib/source-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "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"
},
@@ -12099,6 +11859,9 @@
"include-current" : {
"type" : "boolean"
},
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
"default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
},
@@ -12113,148 +11876,13 @@
"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" : "A native query compiled from this query by [[metabase.query-processor.compile]], ready to hand to the driver.\n `:query` is whatever native form the driver uses -- a string for SQL drivers, a map for Mongo -- so it is only\n constrained to be non-`nil`.\n\n Deliberately NOT closed: drivers add their own keys, e.g. Mongo adds `:collection`, `:projections` and `:mbql?`\n (see `:metabase.driver.mongo.query-processor/compiled-pipeline`), and for a query that was already native the\n compiled form is the native stage itself, carrying every key a `::stage.native` has.",
- "type" : "object",
- "properties" : {
- "params" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.param-value"
- }
- }, {
- "type" : "null"
- } ]
- },
- "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.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.legacy-mbql.schema.ExpressionName" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "metabase.lib.schema.expression.temporal..absolute-datetime.options" : {
+ "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" : {
@@ -12267,6 +11895,9 @@
"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"
@@ -12295,7 +11926,18 @@
} ]
},
"base-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.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",
@@ -12307,7 +11949,9 @@
"type" : "string"
},
"lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "type" : "string",
+ "minLength" : 36,
+ "maxLength" : 36
},
"name" : {
"oneOf" : [ {
@@ -12331,6 +11975,9 @@
"case-sensitive" : {
"type" : "boolean"
},
+ "lib/original-effective-type" : {
+ "type" : "string"
+ },
"metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
@@ -12354,6 +12001,9 @@
"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"
},
@@ -12369,6 +12019,10 @@
"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"
},
@@ -12383,1028 +12037,1333 @@
"type" : "boolean"
}
},
- "required" : [ "lib/uuid" ],
"additionalProperties" : false
},
- "metabase.lib.schema.expression.temporal..relative-datetime.amount" : {
+ "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" : [ {
- "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"
- }
- }
- },
- "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"
- }
- }
- },
- "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", "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"
- } ]
- },
- "card-id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }, {
- "type" : "null"
- } ]
- },
- "pivot/result-metadata" : {
- "oneOf" : [ {
- "oneOf" : [ {
- "const" : "none"
- }, {
+ "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" : {
- "$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"
- } ]
+ "type" : "string"
}
},
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "metadata/model-metadata" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
+ "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"
}
- }, {
- "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
+ },
+ "additionalProperties" : false
+ }, {
+ "allOf" : [ ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "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.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.lib.schema.join.condition" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
+ "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.lib.schema.join.conditions" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.condition"
- },
- "minItems" : 1
+ "metabase.legacy-mbql.schema.aggregation" : {
+ "description" : "schema for a valid MBQL 4 :aggregation clause",
+ "allOf" : [ ]
},
- "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" ]
+ "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" : [ ]
}, {
- "allOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/mbql.clause.field"
- },
- "minItems" : 1
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
- } ]
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.require-base-type-for-field-name"
} ]
},
- "metabase.lib.schema.join.join" : {
+ "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" : [ {
- "default" : { },
"type" : "object",
"properties" : {
- "fk-join-alias" : {
+ "points_of_interest" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/type" : {
- "default" : "mbql/join",
- "const" : "mbql/join"
+ "metabase.query-processor.pivot/idx" : {
+ "type" : "integer",
+ "minimum" : 0
},
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.strategy"
+ "preview_display" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "fk-field-name" : {
+ "database_partitioned" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "metabase.lib.join/replace-alias" : {
- "type" : "boolean"
+ "metabase.lib.underlying/original" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
- "metabase.query-processor.util.add-alias-info/alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "lib/original-join-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.middleware.add-implicit-joins/original-position" : {
- "type" : "integer",
- "minimum" : 0
+ "aggregation_index" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "stages" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.stages"
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
},
- "fk-field-id" : {
+ "field_ref" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
- "fields" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.fields"
+ "metabase.lib.metadata.result-metadata/remove-join-alias?" : {
+ "type" : "boolean"
},
- "alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "lib/external-remap" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
+ }, {
+ "type" : "null"
+ } ]
},
- "qp/is-implicit-join" : {
- "type" : "boolean"
+ "metabase.driver.mongo.query-processor/source-alias" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "qp/keep-default-join-alias" : {
- "type" : "boolean"
+ "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"
+ } ]
},
- "conditions" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.conditions"
+ "remapped_from" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
- },
- "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" : [ {
+ "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"
- }, {
- "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"
- },
- "metabase.query-processor.util.add-alias-info/source-alias" : {
- "oneOf" : [ {
+ },
+ "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"
- }, {
- "type" : "null"
- } ]
- },
- "metabase.driver.sql.query-processor/wrap-in-case" : {
- "type" : "boolean"
- },
- "metabase.query-processor.util.add-alias-info/desired-alias" : {
- "oneOf" : [ {
+ },
+ "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"
- }, {
- "type" : "null"
- } ]
- },
- "lib/source-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "qp/ignore-coercion" : {
- "type" : "boolean"
- },
- "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"
- },
- "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"
- } ]
+ },
+ "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"
+ } ]
+ }
},
- "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"
+ "required" : [ "display_name", "name" ],
+ "additionalProperties" : false
+ }, {
+ "allOf" : [ ]
} ]
},
- "metabase.lib.schema.literal.datetime" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.datetime"
- }, { }, { }, { } ]
- },
- "metabase.lib.schema.literal.integer" : {
- "anyOf" : [ {
- "type" : "integer"
- }, { } ]
+ "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.schema.literal.jvm.big-decimal" : { },
- "metabase.lib.schema.literal.jvm.float" : { },
- "metabase.lib.schema.literal.literal" : {
+ "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" : "null"
- }, {
- "type" : "boolean"
+ "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" : "string"
+ "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
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.integer"
+ "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
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.non-integer-real"
+ "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
}, {
- "$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"
+ "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
}, {
- "$ref" : "#/components/schemas/mbql.clause.value"
+ "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
}, {
- "$ref" : "#/components/schemas/mbql.clause.var"
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string"
+ },
+ "unknown" : {
+ "type" : "string",
+ "enum" : [ "model-action" ]
+ }
+ },
+ "required" : [ "type", "unknown" ],
+ "additionalProperties" : false
} ]
},
- "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-be.schema.empty-query" : {
+ "const" : { }
},
- "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.",
+ "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" : {
- "max-value" : {
+ "action-id" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "strategy" : {
+ "offset" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "max_value" : {
+ "args" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "array",
+ "items" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
}, {
"type" : "null"
} ]
},
- "bin_width" : {
+ "info" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase.lib.schema.info.info"
}, {
"type" : "null"
} ]
},
- "num_bins" : {
+ "fn" : {
+ "type" : "string"
+ },
+ "limit" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
- "bin-width" : {
+ "middleware" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
+ },
+ "database" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "num-bins" : {
+ "scope" : {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema..internal-query.scope"
+ },
+ "action" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ },
+ "type" : {
+ "const" : "internal"
+ }
+ },
+ "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" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.binning"
}, {
"type" : "null"
} ]
},
- "min_value" : {
+ "display-name" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "binning_strategy" : {
+ "effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "binning-strategy" : {
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "semantic-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
- "min-value" : {
+ "temporal-unit" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
@@ -13412,300 +13371,904 @@
},
"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-metric.schema..dimension-source.type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..dimension-source.type"
},
- "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.",
+ "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" : [ {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
+ "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.id.dimension"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
+ "effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "metabase.query-processor.util.add-alias-info/source-alias" : {
+ "base-type" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "qp/native-sandbox-column.propagate-coercion?" : {
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "metabase.query-processor.util.add-alias-info/desired-alias" : {
- "oneOf" : [ {
+ "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"
} ]
},
- "qp/ignore-coercion" : {
+ "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"
},
- "qp/native-sandbox-column.force-coercion-strategy" : {
+ "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.coercion-strategy"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "metabase.query-processor.util.transformations.nest-breakouts/externally-remapped-field" : {
+ "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.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.",
+ "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" : {
- "field-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "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.schema.id.dimension"
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
},
- "lib/type" : {
- "const" : "metadata.column.remapping/external"
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
},
"name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "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" : [ "lib/type", "id", "name", "field-id" ],
+ "required" : [ "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.",
+ "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" : {
- "human-readable-values" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- }
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "dimension-id" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
},
- "lib/type" : {
- "const" : "metadata.column.remapping/internal"
+ "table-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "target" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-mapping.target"
},
- "values" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- }
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-mapping.type"
}
},
- "required" : [ "lib/type", "id", "name", "values", "human-readable-values" ],
+ "required" : [ "type", "dimension-id", "target" ],
"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.\n\n Deliberately NOT `[:ref ::column]`: [[malli.util/merge]] recurses into the entries that the two schemas being merged\n share, so a self-referential `::column` entry makes any `[:merge ...]` of two column-bearing maps -- for instance\n `:metabase.lib.schema.drill-thru/drill-thru.column-filter`, which merges two maps that both have a `:column` --\n recur until the stack blows. This shallow shape says what the value is without reintroducing the cycle.",
+ "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" : {
- "base-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "lib/type" : {
- "const" : "metadata/column"
+ "filter" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.filter-clause"
},
- "name" : {
- "type" : "string"
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
- "required" : [ "lib/type", "name" ]
- },
- "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" ]
+ "required" : [ "lib/uuid", "filter" ],
+ "additionalProperties" : false
},
- "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-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.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"
+ "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"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-table-defaults"
+ "type" : "object",
+ "properties" : {
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "lib/uuid" ],
+ "additionalProperties" : false
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-aggregations"
+ "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"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-joins"
+ "type" : "object",
+ "properties" : {
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "lib/uuid" ],
+ "additionalProperties" : false
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-expressions"
+ "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"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable"
+ "type" : "number"
}, {
- "$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" : [ ]
+ "type" : "array"
+ } ]
},
- "metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable" : {
- "allOf" : [ ]
+ "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.schema.metadata..column.validate-for-source-joins" : {
- "allOf" : [ ]
+ "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.schema.metadata..column.validate-for-source-native" : {
- "allOf" : [ ]
+ "metabase.lib.metadata.protocols.metadata-provider" : {
+ "description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol."
},
- "metabase.lib.schema.metadata..column.validate-for-source-pivot-grouping" : {
- "allOf" : [ ]
+ "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.metadata..column.validate-for-source-previous-stage" : {
- "allOf" : [ ]
+ "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.metadata..column.validate-for-source-table-defaults" : {
- "allOf" : [ ]
+ "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.metadata..column.visibility-type" : {
- "type" : "string",
- "enum" : [ "retired", "sensitive", "normal", "hidden", "details-only" ]
+ "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.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" : {
+ "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"
+ } ]
+ },
+ "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"
+ } ]
+ },
+ "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
- },
- "remapped-from-index" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "remapped-to" : {
+ }
+ },
+ "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.original-metadata" : {
+ "description" : "The columns a query was expected to return *before* sandboxes replaced its source tables, stashed on the query by\n the enterprise sandboxing middleware (see `expected-cols` in\n `metabase-enterprise.sandbox.query-processor.middleware.sandboxing`) and compared against the sandboxed results\n afterwards.\n\n In production these are legacy, `snake_cased` column metadata maps (i.e.\n `:metabase.legacy-mbql.schema/legacy-column-metadata`), but some callers stash kebab-case, lib-flavored columns\n here instead (see `metabase.lib.convert-test/round-trip-preserve-metadata-test`); this key is a verbatim snapshot\n that must survive normalization untouched, so the elements mirror both key spellings without pointing at either\n source schema, which would rewrite keys and drop deprecated ones on decode.",
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "points_of_interest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.lib.underlying/original" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
- },
- "lib/original-join-name" : {
+ "visibility-type" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "fk-join-alias" : {
+ "preview_display" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "database-default" : {
+ "database_partitioned" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "metabase.lib.metadata.result-metadata/field-ref" : {
+ "aggregation_index" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "database-partitioned" : {
+ "field_ref" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$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"
@@ -13713,28 +14276,14 @@
"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" : "string"
}, {
"type" : "null"
} ]
},
- "database-type" : {
+ "remapped_from" : {
"oneOf" : [ {
"type" : "string"
}, {
@@ -13743,46 +14292,43 @@
},
"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"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "binning-info" : {
+ "remapped_from_index" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.binning-info"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "coercion-strategy" : {
+ "settings" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.visualization-settings"
}, {
"type" : "null"
} ]
},
- "settings" : {
+ "fingerprint" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.visualization-settings"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
}, {
"type" : "null"
} ]
},
- "fingerprint" : {
+ "visibility_type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
@@ -13794,9 +14340,13 @@
"type" : "null"
} ]
},
- "converted-timezone" : {
+ "base_type" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
@@ -13808,2197 +14358,2645 @@
"type" : "null"
} ]
},
- "lib/source-uuid" : {
+ "source_alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.driver.mongo.query-processor/join-field" : {
+ "custom_position" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "order-by-position" : {
+ "special_type" : {
"oneOf" : [ {
- "type" : "integer"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "data-sensitivity" : {
+ "expression_name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.data-sensitivity"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "qp/implicit-field?" : {
+ "id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
- "lib/ref-name" : {
+ "effective-type" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "dimension/id" : {
+ "lib/deduplicated-name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.lib.underlying/binning" : {
+ "base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "metabase.lib.join/target" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
- },
- "id" : {
+ "coercion_strategy" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "effective-type" : {
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "boolean"
}, {
"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" : {
+ "lib/from-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "breakout-positions" : {
+ "position" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "integer"
- }
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "fingerprint-version" : {
+ "fingerprint_version" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
- "values/values" : {
+ "name" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- }
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/original-expression-name" : {
+ "lib/card-id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
- "fk-field-name" : {
+ "lib/expression-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/from-model?" : {
+ "lib/breakout?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "updated-at" : {
+ "data_sensitivity" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "lib/original-fk-join-alias" : {
+ "database_position" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "position" : {
+ "semantic_type" : {
"oneOf" : [ {
- "type" : "integer"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "name" : {
- "type" : "string"
- },
- "lib/original-fk-field-name" : {
+ "fk_field_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/card-id" : {
+ "lib/join-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.lib.underlying/temporal-unit" : {
+ "table_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
- "lib/expression-name" : {
+ "has_field_values" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "lib/breakout?" : {
+ "display_name" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "values/human-readable-values" : {
+ "remapping" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
+ "type" : "object",
+ "additionalProperties" : {
"$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
}, {
"type" : "null"
} ]
},
- "last-analyzed" : {
+ "lib/original-fk-field-id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
- "database-is-pk" : {
+ "converted_timezone" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "json-unfolding" : {
+ "selected?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "lib/original-effective-type" : {
+ "fk_join_alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/join-alias" : {
+ "source" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "created-at" : {
+ "fk_field_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
- "lib/source-display-name" : {
+ "remapped_to" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "nfc-path" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }, {
- "type" : "null"
- } ]
- },
- "remapping" : {
+ "binning_info" : {
"oneOf" : [ {
"type" : "object",
- "additionalProperties" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- }
- }, {
- "type" : "null"
- } ]
- },
- "preview-display" : {
- "oneOf" : [ {
- "type" : "boolean"
+ "properties" : {
+ "bin_width" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "binning_strategy" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "max_value" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "min_value" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "num_bins" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "strategy" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
}, {
"type" : "null"
} ]
},
- "dimension/human-readable-field-id" : {
+ "fk-field-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
- "lib/original-fk-field-id" : {
+ "nfc_path" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
}, {
"type" : "null"
} ]
},
- "qp/native-sandbox-column.propagate-coercion?" : {
- "type" : "boolean"
- },
- "has-field-values" : {
+ "target" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ } ]
}, {
"type" : "null"
} ]
},
- "metabase.lib.join/HACK-from-incomplete-join?" : {
+ "effective_type" : {
"oneOf" : [ {
- "type" : "boolean"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "lib/internal-remap" : {
+ "lib/original-join-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "selected?" : {
- "type" : "boolean"
- },
- "database-is-generated" : {
+ "parent_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
- "lib/options" : {
+ "lib/original-display-name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.lib-options"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "fk-field-id" : {
+ "unit" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "target" : {
+ "inherited_temporal_unit" : {
"oneOf" : [ {
"anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "type" : "string"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
+ "type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "lib/original-binning" : {
+ "caveats" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/original-join-alias" : {
+ "lib/source" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
}, {
"type" : "null"
} ]
},
- "lib/original-display-name" : {
+ "active" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "metabase.lib.field.resolution/fallback-metadata?" : {
- "type" : "boolean"
- },
- "unit" : {
+ "options" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.options"
}, {
"type" : "null"
} ]
},
- "remapped-from" : {
+ "lib/original-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "qp/native-sandbox-column.force-coercion-strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
- },
- "lib/binning" : {
+ "database_type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.lib.metadata.result-metadata/source" : {
+ "semantic-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "database-indexed" : {
+ "description" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "caveats" : {
+ "lib/simple-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/source" : {
+ "field-ref" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
- "database-is-auto-increment" : {
+ "fk_target_field_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
- "active" : {
- "type" : "boolean"
- },
- "points-of-interest" : {
+ "lib/desired-column-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
+ }
+ },
+ "additionalProperties" : false
+ }
+ },
+ "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.query-processor.middleware.cumulative-aggregations/replaced-indexes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 0
},
- "filter-positions" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "integer"
- }
- }, {
- "type" : "null"
- } ]
+ "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"
},
- "options" : {
+ "uniqueItems" : true
+ },
+ "qp/skip-persisted-cache" : {
+ "type" : "boolean"
+ },
+ "metabase-enterprise.sandbox.query-processor.middleware.sandboxing/sandbox?" : {
+ "type" : "boolean"
+ },
+ "source-query/model?" : {
+ "type" : "boolean"
+ },
+ "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" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.options"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "lib/ref-display-name" : {
- "oneOf" : [ {
+ "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"
- }, {
- "type" : "null"
- } ]
+ }
},
- "dimension-interestingness" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "lib/type" : {
+ "const" : "mbql.stage/mbql"
},
- "dimension/type" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "internal", "external" ]
- }, {
- "type" : "null"
- } ]
+ "lib/stage-metadata" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
},
- "lib/original-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
+ "pivot" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.pivot"
},
- "name-field" : {
+ "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"
+ },
+ "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" : [ {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
- } ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "database-position" : {
+ "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" : "integer"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.param-value"
+ }
}, {
"type" : "null"
} ]
},
- "lib/original-ref-style-for-result-metadata-purposes" : {
- "type" : "string",
- "enum" : [ "original-ref-style/id", "original-ref-style/name" ]
- },
- "semantic-type" : {
+ "projections" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
}, {
"type" : "null"
} ]
},
- "metabase.driver.mongo.query-processor/inherited?" : {
+ "mbql?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "description" : {
- "oneOf" : [ {
+ "collection" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "native" : {
+ "anyOf" : [ {
"type" : "string"
}, {
- "type" : "null"
+ "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"
} ]
},
- "fk-target-field-id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- }, {
- "type" : "null"
- } ]
+ "metabase.query-processor.middleware.cumulative-aggregations/replaced-indexes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "uniqueItems" : true
},
- "custom-position" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "metabase.query-processor.util.add-alias-info/desired-alias->escaped" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
+ }
},
- "dimension/name" : {
+ "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"
} ]
},
- "parent-id" : {
+ "source-query/model?" : {
+ "type" : "boolean"
+ },
+ "parameters" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
+ },
+ "query-permissions/referenced-card-ids" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "uniqueItems" : true
}, {
"type" : "null"
} ]
},
- "lib/simple-display-name" : {
+ "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" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, { } ]
}, {
"type" : "null"
} ]
},
- "database-is-nullable" : {
+ "name" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/desired-column-alias" : {
+ "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" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
+ "anyOf" : [ {
+ "type" : "string"
+ }, { } ]
}, {
"type" : "null"
} ]
+ },
+ "min_duration_ms" : {
+ "type" : "number"
+ },
+ "multiplier" : {
+ "type" : "number"
+ },
+ "type" : {
+ "const" : "ttl"
}
},
- "required" : [ "name" ],
+ "required" : [ "type", "multiplier", "min_duration_ms" ],
"additionalProperties" : false
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
+ "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
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
+ "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"
}, {
- "allOf" : [ ]
+ "$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.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.",
+ "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" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ }, {
+ "type" : "string",
+ "format" : "uuid"
+ }, { } ]
}, {
"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.common.kebab-cased-map" : { },
+ "metabase.lib.schema.common.non-blank-string" : {
+ "type" : "string",
+ "minLength" : 1
},
- "metabase.lib.schema.metadata.fingerprint..fingerprint.global" : {
- "description" : "Fingerprint values that Fields of all types should have.",
+ "metabase.lib.schema.common.options" : {
+ "default" : { },
"type" : "object",
"properties" : {
- "distinct-count" : {
- "type" : "integer"
+ "metabase.query-processor.util.add-alias-info/source-table" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common..add-alias-info.source-table"
},
- "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"
- } ]
+ "metabase.mcp.v2.query/keyset" : {
+ "type" : "boolean"
},
- "min" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
+ "type" : "boolean"
},
- "q1" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "inherited-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
- "max" : {
+ "database-type" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "avg" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "metabase.driver.sql.query-processor/forced-alias" : {
+ "type" : "boolean"
},
- "sd" : {
+ "metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
+ "type" : "boolean"
+ },
+ "display-name" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "skewness" : {
+ "effective-type" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "q3" : {
+ "base-type" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "top-3-fraction" : {
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "excess-kurtosis" : {
+ "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" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "zero-fraction" : {
+ "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.metadata.fingerprint.percent"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"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" : {
+ },
+ "metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "hour-distribution" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
- }
- }, {
- "type" : "null"
- } ]
+ "metabase.driver.sql.query-processor/wrap-in-case" : {
+ "type" : "boolean"
},
- "latest" : {
+ "metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "mode-fraction" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
- }, {
- "type" : "null"
- } ]
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "skewness" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "qp/ignore-coercion" : {
+ "type" : "boolean"
},
- "top-3-fraction" : {
+ "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.metadata.fingerprint.percent"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
- "weekday-distribution" : {
+ "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.metadata.fingerprint.percent"
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.param-value"
}
}, {
"type" : "null"
} ]
+ },
+ "query" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.driver-native-query"
}
},
- "additionalProperties" : false
+ "required" : [ "query" ]
},
- "metabase.lib.schema.metadata.fingerprint..fingerprint.text" : {
- "description" : "Schema for fingerprint information for Fields deriving from `:type/Text`.",
+ "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" : {
- "mode-fraction" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
- }, {
- "type" : "null"
- } ]
+ "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
},
- "percent-json" : {
+ "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.metadata.fingerprint.percent"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "percent-blank" : {
+ "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.metadata.fingerprint.percent"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "percent-url" : {
+ "effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "percent-state" : {
+ "base-type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "percent-email" : {
+ "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.metadata.fingerprint.percent"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "max-length" : {
+ "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" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "average-length" : {
+ "metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "min-length" : {
+ "metabase.driver.sql.query-processor/wrap-in-case" : {
+ "type" : "boolean"
+ },
+ "metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "top-3-fraction" : {
+ "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.metadata.fingerprint.percent"
+ "$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.metadata.fingerprint..fingerprint.type-specific" : {
- "description" : "Schema for type-specific fingerprint information.",
+ "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" : {
- "type/Date" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.temporal"
+ "field-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
- "type/DateTime" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.temporal"
+ "field-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "type/Number" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.number"
+ "human-readable-field-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
- "type/Text" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.text"
+ "human-readable-field-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "type/Time" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.temporal"
+ "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.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.",
+ "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" : {
- "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"
+ "case-sensitive" : {
+ "type" : "boolean"
}
},
"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.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.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
- },
- "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" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
- }, {
- "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" : {
+ "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", "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"
+ } ]
+ },
+ "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"
- } ]
- },
- "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"
- } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "name" : {
+ "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"
- },
- "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"
- } ]
- }
+ }, {
+ "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.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
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
+ "allOf" : [ ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.validate-field-aliases-match-join-alias"
} ]
},
- "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.join.joins" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.join"
+ },
+ "minItems" : 1
},
- "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"
+ "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" : "null"
+ "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.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.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.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.literal..string.year" : {
+ "type" : "string",
+ "pattern" : "^\\d{4}$"
},
- "metabase.lib.schema.middleware-options.middleware-options" : {
- "description" : "Additional options that can be used to toggle middleware on or off.",
+ "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" : {
- "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`.",
+ "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" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"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.)",
+ "metabase.driver.sql.query-processor/forced-alias" : {
"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.",
+ "coercion-strategy" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
}, {
"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`.",
+ "metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
"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`.",
+ "display-name" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"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`.",
+ "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"
} ]
},
- "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"
+ "metabase.query-processor.util.add-alias-info/nfc-path" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
},
- "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.",
+ "metabase.driver.sql.query-processor/add-cast" : {
+ "type" : "string"
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
"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
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"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`.",
+ "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" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"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`.",
+ "metabase.query-processor.util.add-alias-info/source-alias" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"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.",
+ "metabase.driver.sql.query-processor/wrap-in-case" : {
"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`.",
+ "metabase.query-processor.util.add-alias-info/desired-alias" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"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.",
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "qp/ignore-coercion" : {
"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.",
+ "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" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
- }
- },
- "additionalProperties" : false
- },
- "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
+ "qp/native-sandbox-column.force-coercion-strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
- "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"
+ "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.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.literal..value.value" : {
+ "description" : "The value slot of a `:value` clause: a single literal that is not a Clojure collection."
},
- "metabase.lib.schema.parameter..parameter.value.scalar" : {
- "description" : "A single scalar parameter value."
+ "metabase.lib.schema.literal.date" : {
+ "anyOf" : [ { }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.date"
+ } ]
},
- "metabase.lib.schema.parameter..target.legacy-expression-ref" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.expression"
+ "metabase.lib.schema.literal.datetime" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.datetime"
+ }, { }, { }, { } ]
},
- "metabase.lib.schema.parameter..target.legacy-field-ref" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
+ "metabase.lib.schema.literal.integer" : {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, { } ]
},
- "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
+ "metabase.lib.schema.literal.jvm.big-decimal" : { },
+ "metabase.lib.schema.literal.jvm.float" : { },
+ "metabase.lib.schema.literal.literal" : {
+ "anyOf" : [ {
+ "type" : "null"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "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.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.",
+ "metabase.lib.schema.literal.non-integer-real" : {
"anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
+ "type" : "number"
}, {
- "type" : "array",
- "prefixItems" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
- } ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.jvm.float"
}, {
- "type" : "array",
- "prefixItems" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
- }, {
- "type" : "string"
- } ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.jvm.big-decimal"
} ]
},
- "metabase.lib.schema.parameter..variable.target" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
+ "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"
}, {
- "$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"
+ "type" : "string",
+ "format" : "uuid"
+ }, { } ]
},
- "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
+ "metabase.lib.schema.literal.temporal" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.date"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.time"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.datetime"
} ]
},
- "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.literal.time" : {
+ "description" : "time literal",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.time"
+ }, { }, { } ]
},
- "metabase.lib.schema.parameter.target" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.dimension"
+ "metabase.lib.schema.mbql-clause.clause" : {
+ "oneOf" : [ { }, {
+ "$ref" : "#/components/schemas/mbql.clause._BANG__EQ_"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.variable"
+ "$ref" : "#/components/schemas/mbql.clause._STAR_"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.text-tag"
+ "$ref" : "#/components/schemas/mbql.clause._PLUS_"
}, {
- "$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/mbql.clause.-"
}, {
- "$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"
+ "$ref" : "#/components/schemas/mbql.clause._SLASH_"
}, {
- "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" ]
+ "$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.parameter.values-source-config" : {
- "description" : "The configuration of a filter widget's value source. Its keys are the frontend's snake_case names.",
+ "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" : {
- "card_id" : {
+ "max-value" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "label_field" : {
+ "strategy" : {
"oneOf" : [ {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-expression-ref"
- } ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
}, {
"type" : "null"
} ]
},
- "value_field" : {
+ "max_value" : {
"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" : "number"
}, {
"type" : "null"
} ]
},
- "values" : {
+ "bin_width" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..values-source-config.value"
- }
+ "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"
} ]
@@ -16006,2013 +17004,6959 @@
},
"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.",
+ "metabase.lib.schema.metadata..column.data-sensitivity" : {
"type" : "string",
- "enum" : [ "static-list", "card" ]
+ "enum" : [ "SEC_KEY", "SYS_TELEMETRY", "PHI", "BIO_GEN", "PCI_FIN", "SENS_PERS", "PII", "CORP_IP", "BIZ_CONF", "PUBLIC" ]
},
- "metabase.lib.schema.parameter.variable" : {
- "type" : "array",
- "prefixItems" : [ {
- "const" : "variable"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..variable.target"
- } ]
+ "metabase.lib.schema.metadata..column.has-field-values" : {
+ "type" : "string",
+ "enum" : [ "auto-list", "list", "none", "search" ]
},
- "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.",
+ "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" : [ "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/=" ]
+ "enum" : [ "aggregation", "fields", "breakout", "native" ]
},
- "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.",
+ "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" : {
- "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"
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "show-row-totals" : {
- "type" : "boolean"
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}
},
- "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"
- } ]
- },
- "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"
- } ]
- },
- "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" : {
+ "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" : {
- "type" : "integer",
- "minimum" : 0
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.field-value"
}
- },
- "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"
- } ]
- }
+ }, {
+ "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"
+ "remapped-from-index" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.mcp.v2.query/keyset" : {
- "type" : "boolean"
+ "remapped-to" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
- "type" : "boolean"
+ "metabase.lib.underlying/original" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
- "database-type" : {
+ "lib/original-join-name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.driver.sql.query-processor/forced-alias" : {
- "type" : "boolean"
+ "fk-join-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
+ "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"
},
- "display-name" : {
+ "lib/external-remap" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
}, {
"type" : "null"
} ]
},
- "effective-type" : {
+ "inherited-temporal-unit" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
- "base-type" : {
+ "metabase.driver.mongo.query-processor/source-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.query-processor.util.add-alias-info/nfc-path" : {
- "type" : "array",
- "items" : {
+ "lib/source-column-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.source-column-alias"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database-type" : {
+ "oneOf" : [ {
"type" : "string"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.driver.sql.query-processor/add-cast" : {
- "type" : "string"
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "lib/type" : {
+ "default" : "metadata/column",
+ "const" : "metadata/column"
},
- "name" : {
+ "database-required" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "lib/expression-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "binning-info" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.binning-info"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "coercion-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.driver.sqlserver/optimized-bucketing?" : {
- "type" : "boolean"
+ "settings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.visualization-settings"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "fingerprint" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
+ }, {
+ "type" : "null"
+ } ]
},
- "case-sensitive" : {
- "type" : "boolean"
+ "table-id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
+ "type" : "string",
+ "pattern" : "^card__\\d+$"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "lib/original-effective-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "converted-timezone" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.util.add-alias-info/source-alias" : {
+ "display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.driver.sql.query-processor/wrap-in-case" : {
- "type" : "boolean"
+ "lib/source-uuid" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.util.add-alias-info/desired-alias" : {
+ "metabase.driver.mongo.query-processor/join-field" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/source-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "qp/ignore-coercion" : {
- "type" : "boolean"
+ "order-by-position" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "data-sensitivity" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.data-sensitivity"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.driver.mongo.query-processor/join-local" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "qp/implicit-field?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "qp/native-sandbox-column.force-coercion-strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
+ "lib/ref-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.util.add-alias-info/resolved" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
+ "dimension/id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ }, {
+ "type" : "null"
+ } ]
},
- "include-current" : {
- "type" : "boolean"
+ "metabase.lib.underlying/binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ }, {
+ "type" : "null"
+ } ]
},
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "metabase.lib.join/target" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
- "default" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
+ "id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
},
- "semantic-type" : {
+ "effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-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" : {
- "$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?" : {
+ "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"
- },
- "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" : "null"
+ } ]
+ },
+ "breakout-positions" : {
+ "oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "string"
+ "type" : "integer"
}
- },
- "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" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "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" : "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"
- },
- "qp/ignore-coercion" : {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk-field-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/from-model?" : {
+ "oneOf" : [ {
"type" : "boolean"
- },
- "source-field" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "join-alias" : {
- "type" : "string",
- "minLength" : 1
- },
- "lib/original-binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "metabase.driver.mongo.query-processor/join-local" : {
+ }, {
+ "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"
- },
- "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" : "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"
- },
- "source-field-join-alias" : {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/expression-name" : {
+ "oneOf" : [ {
"$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"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "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" : {
- "$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?" : {
+ "lib/breakout?" : {
+ "oneOf" : [ {
"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" : "null"
+ } ]
+ },
+ "values/human-readable-values" : {
+ "oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
- },
- "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" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "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" : {
- "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" : "null"
+ } ]
+ },
+ "last-analyzed" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database-is-pk" : {
+ "oneOf" : [ {
"type" : "boolean"
- },
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "source-field-join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "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" : "null"
+ } ]
+ },
+ "json-unfolding" : {
+ "oneOf" : [ {
"type" : "boolean"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
+ "lib/original-effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.mcp.v2.query/keyset" : {
- "type" : "boolean"
+ "lib/join-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ }, {
+ "type" : "null"
+ } ]
},
- "qp/allow-coercion-for-columns-without-integer-qp.add.source-table" : {
- "type" : "boolean"
+ "created-at" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.timestamp"
+ }, {
+ "type" : "null"
+ } ]
},
- "database-type" : {
+ "lib/source-display-name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.driver.sql.query-processor/forced-alias" : {
- "type" : "boolean"
+ "nfc-path" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.driver.sql.parameters.substitution/compiling-field-filter?" : {
- "type" : "boolean"
+ "remapping" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "display-name" : {
- "type" : "string",
- "minLength" : 1
+ "preview-display" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "effective-type" : {
+ "dimension/human-readable-field-id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
- "base-type" : {
+ "lib/original-fk-field-id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
},
- "metabase.query-processor.util.add-alias-info/nfc-path" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "type" : "boolean"
},
- "metabase.driver.sql.query-processor/add-cast" : {
- "type" : "string"
+ "has-field-values" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "metabase.lib.join/HACK-from-incomplete-join?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "type" : "string",
- "minLength" : 1
+ "lib/internal-remap" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib/expression-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "selected?" : {
+ "type" : "boolean"
},
- "metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "database-is-generated" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.driver.sqlserver/optimized-bucketing?" : {
- "type" : "boolean"
+ "lib/options" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.lib-options"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ "fk-field-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
},
- "case-sensitive" : {
- "type" : "boolean"
+ "target" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.util.add-alias-info/source-alias" : {
+ "lib/original-binning" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
}, {
"type" : "null"
} ]
},
- "metabase.driver.sql.query-processor/wrap-in-case" : {
- "type" : "boolean"
+ "lib/original-join-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.query-processor.util.add-alias-info/desired-alias" : {
+ "lib/original-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/source-name" : {
- "type" : "string",
- "minLength" : 1
- },
- "qp/ignore-coercion" : {
+ "metabase.lib.field.resolution/fallback-metadata?" : {
"type" : "boolean"
},
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.driver.mongo.query-processor/join-local" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "remapped-from" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "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"
+ "lib/binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ }, {
+ "type" : "null"
+ } ]
},
- "include-current" : {
- "type" : "boolean"
+ "metabase.lib.metadata.result-metadata/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ }, {
+ "type" : "null"
+ } ]
},
- "default" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
+ "database-indexed" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "semantic-type" : {
+ "caveats" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "type" : "string"
}, {
"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.",
+ "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"
},
- "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"
+ "points-of-interest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
+ "filter-positions" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "integer"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "include-current" : {
- "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-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.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" : {
+ "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" : {
- "default" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ "metabase.query-processor.util.add-alias-info/source-table" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "metabase.query-processor.middleware.add-remaps/original-field-dimension-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "metabase.query-processor.middleware.add-remaps/new-field-dimension-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib.walk/template-tag-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "metabase.query-processor.util.add-alias-info/source-alias" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : {
+ "metabase.query-processor.util.add-alias-info/desired-alias" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "qp/ignore-coercion" : {
"type" : "boolean"
},
- "sectionid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "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"
}
},
- "required" : [ "name", "display-name" ],
"additionalProperties" : false
},
- "metabase.lib.schema.template-tag.common" : {
+ "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" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "field-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
"id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
- "lib.walk/template-tag-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "lib/type" : {
+ "const" : "metadata.column.remapping/external"
},
"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" ],
+ "required" : [ "lib/type", "id", "name", "field-id" ],
"additionalProperties" : false
},
- "metabase.lib.schema.template-tag.disallow-dimension" : { },
- "metabase.lib.schema.template-tag.distinct-template-tags" : { },
- "metabase.lib.schema.template-tag.field-filter" : {
+ "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" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "human-readable-values" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ }
},
"id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
},
- "lib.walk/template-tag-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "lib/type" : {
+ "const" : "metadata.column.remapping/internal"
},
"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"
+ "values" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ }
}
},
- "required" : [ "name", "display-name", "type", "widget-type" ],
+ "required" : [ "lib/type", "id", "name", "values", "human-readable-values" ],
"additionalProperties" : false
},
- "metabase.lib.schema.template-tag.id" : {
+ "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" : [ {
- "type" : "string",
- "format" : "uuid"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-card"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- } ]
+ "$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.template-tag.name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "metabase.lib.schema.metadata..column.validate-for-source-aggregations" : {
+ "allOf" : [ ]
},
- "metabase.lib.schema.template-tag.raw-value" : {
+ "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" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "visibility-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib.walk/template-tag-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "metabase.query-processor.pivot/idx" : {
+ "type" : "integer",
+ "minimum" : 0
},
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "field-values" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.field-value"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "sectionid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "remapped-from-index" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : {
- "type" : "boolean"
+ "remapped-to" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag..raw-value.type"
+ "metabase.lib.underlying/original" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.snapshot"
},
- "default" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ "lib/original-join-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "widget-type" : {
+ "fk-join-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.widget-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"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"
+ "database-default" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib.walk/template-tag-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "database-partitioned" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "metabase.lib.metadata.result-metadata/remove-join-alias?" : {
+ "type" : "boolean"
},
- "database" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ "lib/external-remap" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
+ }, {
+ "type" : "null"
+ } ]
},
- "sectionid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "inherited-temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "const" : "snippet"
+ "metabase.driver.mongo.query-processor/source-alias" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
+ "lib/source-column-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.source-column-alias"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "database-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib.walk/template-tag-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
},
- "card-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ "lib/type" : {
+ "default" : "metadata/column",
+ "const" : "metadata/column"
},
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "database-required" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "sectionid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "binning-info" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.binning-info"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : {
- "type" : "boolean"
+ "coercion-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "const" : "card"
+ "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"
+ } ]
},
- "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"
+ "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" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "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" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib.walk/template-tag-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "lib/deduplicated-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.deduplicated-name"
},
- "sectionid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "base-type" : {
+ "default" : "type/*",
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
- "source-filters" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-filter"
- }
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : {
- "type" : "boolean"
+ "breakout-positions" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "integer"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "const" : "table"
+ "fingerprint-version" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "emit-alias" : {
- "type" : "boolean"
+ "values/values" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "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.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.logger.api.log-level" : {
- "type" : "string",
- "enum" : [ "off", "fatal", "error", "warn", "info", "debug", "trace" ]
- },
- "metabase.logger.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" : {
+ "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"
- },
- "can_create_queries" : {
+ }, {
+ "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"
+ } ]
},
- "required" : [ "can_create_queries", "can_create_native_queries" ],
- "additionalProperties" : false
+ "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"
+ } ]
+ }
},
- "personal_collection_id" : {
+ "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" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "tenant_id" : {
+ "field-id" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..dimension-source.type"
}
},
- "required" : [ "id", "locale", "is_superuser", "is_data_analyst", "is_qbnewb", "tenant_id", "personal_collection_id", "permissions" ],
+ "required" : [ "type" ],
"additionalProperties" : false
},
- "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.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.measures.api.measure" : {
- "description" : "Schema for a Measure entity as returned from the API.",
+ "metabase.lib.schema.metadata.fingerprint..fingerprint.global" : {
+ "description" : "Fingerprint values that Fields of all types should have.",
"type" : "object",
"properties" : {
- "dimension_mappings" : {
+ "distinct-count" : {
+ "type" : "integer"
+ },
+ "nil%" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
- },
- "entity_id" : {
+ }
+ },
+ "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" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
- "result_column_name" : {
+ "min" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "creator" : {
+ "q1" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : { }
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "archived" : {
- "type" : "boolean"
- },
- "dimensions" : {
+ "max" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "updated_at" : { },
- "table_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "avg" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "definition" : {
- "$ref" : "#/components/schemas/metabase.measures.schema.definition"
+ "sd" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "created_at" : { },
- "creator_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "skewness" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "description" : {
+ "q3" : {
"oneOf" : [ {
- "type" : "string"
+ "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"
} ]
}
},
- "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"
+ "additionalProperties" : false
},
- "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.",
+ "metabase.lib.schema.metadata.fingerprint..fingerprint.temporal" : {
+ "description" : "Schema for fingerprint information for Fields deriving from `:type/Temporal`.",
"type" : "object",
"properties" : {
- "capabilities" : {
+ "earliest" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- }, {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- } ]
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "first_day_of_week" : {
+ "hour-distribution" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
+ }
}, {
"type" : "null"
} ]
},
- "slack_channel_id" : {
+ "latest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "user_recently_viewed" : {
+ "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.metabot.context.recently-viewed-item"
+ "$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"
+ } ]
},
- "research_plan" : {
+ "percent-json" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.metabot.context.research-plan"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
- "code_editor" : {
+ "percent-blank" : {
"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
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
- "user_is_viewing" : {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "table" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.warehouse-schema.schema.table"
- }, {
- "type" : "null"
- } ]
- },
- "owner" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "first_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "can_read" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "source_type" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "entity_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "last_run" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "user_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "checkpoint_hi_value" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "is_active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "transform_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "run_method" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "checkpoint_lo_value" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "status" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "transform_entity_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "checkpoint_filter_field_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "end_time" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "metered_as" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "dag_run_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "transform_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "start_time" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "job_run_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- },
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "scheduled" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "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" : [ {
+ "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.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"
+ } ]
+ },
+ "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"
+ } ]
+ },
+ "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.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.api.log-level" : {
+ "type" : "string",
+ "enum" : [ "off", "fatal", "error", "warn", "info", "debug", "trace" ]
+ },
+ "metabase.logger.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.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" : {
+ "table" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_read" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_hi_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_lo_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_filter_field_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "end_time" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dag_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "start_time" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "scheduled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "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
+ } ]
+ },
+ "collection" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.collections.schema.collection"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_database_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "error" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_db_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "is_qbnewb" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_login" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "is_data_analyst" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_superuser" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tenant_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dependency" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_readable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tag_ids" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "integer"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_dependencies" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.driver..native-query-deps.table-dep"
+ }, {
+ "$ref" : "#/components/schemas/metabase.driver..native-query-deps.transform-dep"
+ } ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_write" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_execute" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : {
+ "oneOf" : [ {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "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
+ } ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source-incremental-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
+ }, {
+ "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-incremental-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source-tables" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "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
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "anyOf" : [ {
+ "const" : "python"
+ }, {
+ "const" : "python"
+ } ]
+ }
+ },
+ "required" : [ "type" ],
+ "additionalProperties" : false
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "model", "question", "metric", "adhoc" ]
+ },
+ "deleted" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "requestable_indexes" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "description" : "Value must be a map."
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_checkpoint_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target" : {
+ "oneOf" : [ {
+ "oneOf" : [ {
+ "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
+ }, {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target-incremental-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.target-incremental-strategy"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "anyOf" : [ {
+ "const" : "table-incremental"
+ }, {
+ "const" : "table-incremental"
+ } ]
+ }
+ },
+ "required" : [ "type" ],
+ "additionalProperties" : false
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "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"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_table_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "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" : {
+ "table" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_read" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_hi_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_lo_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_filter_field_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "end_time" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dag_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "start_time" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "scheduled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "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"
@@ -18021,2575 +23965,8482 @@
"type" : "null"
} ]
},
- "query" : {
- "oneOf" : [ {
+ "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
+ } ]
+ },
+ "collection" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.collections.schema.collection"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_database_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "error" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_db_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "is_qbnewb" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_login" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "is_data_analyst" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_superuser" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tenant_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dependency" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_readable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tag_ids" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "integer"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_dependencies" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.driver..native-query-deps.table-dep"
+ }, {
+ "$ref" : "#/components/schemas/metabase.driver..native-query-deps.transform-dep"
+ } ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_write" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_execute" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : {
+ "oneOf" : [ {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "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
+ } ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source-incremental-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
+ }, {
+ "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-incremental-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source-tables" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "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
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "anyOf" : [ {
+ "const" : "python"
+ }, {
+ "const" : "python"
+ } ]
+ }
+ },
+ "required" : [ "type" ],
+ "additionalProperties" : false
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "dashboard", "model", "transform", "code_editor", "document", "question", "metric", "adhoc" ]
+ },
+ "deleted" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "requestable_indexes" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "description" : "Value must be a map."
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_checkpoint_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target" : {
+ "oneOf" : [ {
+ "oneOf" : [ {
+ "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
+ }, {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target-incremental-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.target-incremental-strategy"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "anyOf" : [ {
+ "const" : "table-incremental"
+ }, {
+ "const" : "table-incremental"
+ } ]
+ }
+ },
+ "required" : [ "type" ],
+ "additionalProperties" : false
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "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"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_table_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "buffers" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "cursor" : {
"type" : "object",
"properties" : {
- "source-table" : {
+ "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" : [ {
- "anyOf" : [ {
- "type" : "integer"
+ "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" : "string"
+ "type" : "null"
} ]
- }, {
- "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
}
- },
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "stages" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.stage"
- }
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
}, {
+ "type" : "null"
+ } ]
+ },
+ "title" : {
+ "oneOf" : [ {
"type" : "string"
+ }, {
+ "type" : "null"
} ]
- }, {
- "type" : "null"
- } ]
- }
- },
- "additionalProperties" : false
+ }
+ },
+ "additionalProperties" : false
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "type" ],
+ "additionalProperties" : false
+ } ]
+ }
+ },
+ "current_user_time" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "default_database_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "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"
} ]
- },
- "collection" : {
+ }, {
+ "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" : {
+ "error" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "object",
+ "properties" : {
+ "data" : { },
+ "message" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.collections.schema.collection"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "source_database_id" : {
+ "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 state.",
+ "$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"
+ }
+ },
+ "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" : "One todo item of persisted turn state; only `:id` is guaranteed, since state can hold a partial item\n between the turn that creates it and the turn that fills in its details.",
+ "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.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" : [ {
- "type" : "integer"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "error" : {
+ "channel_id" : {
"oneOf" : [ {
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "id" : {
+ "updated_at" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "integer"
+ "type" : "string",
+ "format" : "date-time"
}, {
+ "description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "owner_email" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "target_db_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "is_qbnewb" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "last_login" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer"
- },
- "email" : {
- "type" : "string"
- },
- "is_data_analyst" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "is_superuser" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "tenant_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "first_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "date_joined" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "email" ],
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "owner_user_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "updated_at" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "dependency" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "source_readable" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "tag_ids" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "integer"
- }
- }, {
- "type" : "null"
- } ]
- },
- "table_dependencies" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.driver..native-query-deps.table-dep"
- }, {
- "$ref" : "#/components/schemas/metabase.driver..native-query-deps.transform-dep"
- } ]
- }
- }, {
- "type" : "null"
- } ]
- },
- "can_write" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "can_execute" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "source" : {
- "oneOf" : [ {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "query" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "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
- } ]
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "source-incremental-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "anyOf" : [ {
- "const" : "query"
- }, {
- "const" : "query"
- } ]
- }
- },
- "required" : [ "type" ],
- "additionalProperties" : false
+ "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"
}, {
- "type" : "object",
- "properties" : {
- "body" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "source-database" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "source-incremental-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
- }, {
- "type" : "null"
- } ]
- },
- "source-tables" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "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
- }
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "anyOf" : [ {
- "const" : "python"
- }, {
- "const" : "python"
- } ]
- }
- },
- "required" : [ "type" ],
- "additionalProperties" : false
+ "description" : "value must be a valid date string",
+ "type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "type" : {
- "type" : "string",
- "enum" : [ "model", "question", "metric", "adhoc" ]
+ "channel" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
+ }, {
+ "type" : "null"
+ } ]
},
- "deleted" : {
+ "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
+ }
+ },
+ "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.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"
+ } ]
},
- "requestable_indexes" : {
+ "channel_id" : {
"oneOf" : [ {
- "description" : "Value must be a map.",
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "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 map."
+ "description" : "value must be a valid date string",
+ "type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "last_checkpoint_value" : {
+ "recipients" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.CreateNotificationRecipientParams"
+ }
+ },
+ "template" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
},
- "target" : {
+ "channel_type" : { },
+ "created_at" : {
"oneOf" : [ {
- "oneOf" : [ {
- "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
+ "anyOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
}, {
- "type" : "object",
- "properties" : {
- "database" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "target-incremental-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms.schema.target-incremental-strategy"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "anyOf" : [ {
- "const" : "table-incremental"
- }, {
- "const" : "table-incremental"
- } ]
- }
- },
- "required" : [ "type" ],
- "additionalProperties" : false
+ "description" : "value must be a valid date string",
+ "type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "database_schema" : {
+ "channel" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"type" : "null"
} ]
},
- "created_at" : {
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "active" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "channel_type" ],
+ "additionalProperties" : false
+ }
+ },
+ "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.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"
} ]
},
- "sql_engine" : {
+ "channel_id" : {
"oneOf" : [ {
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "used_tables" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "updated_at" : {
"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
- }
+ "anyOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "description" : "value must be a valid date string",
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "creator_id" : {
+ "recipients" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ }
+ },
+ "template" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
},
- "run_trigger" : {
+ "channel_type" : { },
+ "created_at" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "string"
+ "type" : "string",
+ "format" : "date-time"
}, {
+ "description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "target_table_id" : {
+ "channel" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"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"
- } ]
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "description" : {
+ "active" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"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
- }
+ }
+ },
+ "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" : [ "type" ],
+ "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" : {
- "table" : {
+ "email" : {
+ "description" : "value must be a valid email address.",
+ "type" : "string"
+ },
+ "first_name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.warehouse-schema.schema.table"
+ "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" ]
+ }
},
- "owner" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "first_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "additionalProperties" : false
+ "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" : [ {
+ "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"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "embedding_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
}, {
- "type" : "null"
+ "type" : "string"
} ]
- },
- "can_read" : {
- "oneOf" : [ {
- "type" : "boolean"
+ }, {
+ "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" : "null"
- } ]
- },
- "source_type" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "prefixItems" : [ {
+ "type" : "string",
+ "enum" : [ "+", "-" ]
}, {
- "type" : "string"
+ "const" : "collection_position"
+ }, {
+ "const" : 1
} ]
- }, {
- "type" : "null"
- } ]
- },
- "entity_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
} ]
- },
- "last_run" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "user_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "checkpoint_hi_value" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "is_active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "transform_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "run_method" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "checkpoint_lo_value" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "status" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "transform_entity_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "checkpoint_filter_field_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "end_time" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "metered_as" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "dag_run_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "transform_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "start_time" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "job_run_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ }, {
+ "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" ]
}
- },
- "additionalProperties" : false
+ }, {
+ "description" : "Value must be a map."
+ } ]
}, {
"type" : "null"
} ]
- },
- "scheduled" : {
- "oneOf" : [ {
- "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
}, {
- "type" : "null"
+ "description" : "value must be a valid date string",
+ "type" : "string"
} ]
- },
- "query" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
+ }, {
+ "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" : "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
+ "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"
} ]
},
- "collection" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_data_app_group" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.collections.schema.collection"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "source_database_id" : {
+ "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" : [ {
- "type" : "integer"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "error" : {
+ "channel_id" : {
"oneOf" : [ {
- "type" : "string"
+ "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" : "integer"
+ "type" : "string",
+ "format" : "date-time"
}, {
+ "description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "owner_email" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "target_db_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "is_qbnewb" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "last_login" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer"
- },
- "email" : {
- "type" : "string"
- },
- "is_data_analyst" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "is_superuser" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "tenant_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "first_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "date_joined" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "email" ],
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "owner_user_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "recipients" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ }
},
- "name" : {
+ "template" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
}, {
"type" : "null"
} ]
},
- "updated_at" : {
+ "channel_type" : { },
+ "created_at" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "description" : "value must be a valid date string",
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "dependency" : {
+ "channel" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"type" : "null"
} ]
},
- "source_readable" : {
+ "attachment_only" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "tag_ids" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "integer"
- }
- }, {
- "type" : "null"
- } ]
- },
- "table_dependencies" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.driver..native-query-deps.table-dep"
- }, {
- "$ref" : "#/components/schemas/metabase.driver..native-query-deps.transform-dep"
- } ]
- }
- }, {
- "type" : "null"
- } ]
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "can_write" : {
+ "active" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "collection_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "can_execute" : {
+ "include_pdf" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
- },
- "source" : {
- "oneOf" : [ {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "query" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "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
- } ]
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "source-incremental-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "anyOf" : [ {
- "const" : "query"
- }, {
- "const" : "query"
- } ]
- }
- },
- "required" : [ "type" ],
- "additionalProperties" : false
+ }
+ },
+ "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"
}, {
- "type" : "object",
- "properties" : {
- "body" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "source-database" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "source-incremental-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
- }, {
- "type" : "null"
- } ]
- },
- "source-tables" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "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
- }
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "anyOf" : [ {
- "const" : "python"
- }, {
- "const" : "python"
- } ]
- }
- },
- "required" : [ "type" ],
- "additionalProperties" : false
+ "description" : "value must be a valid date string",
+ "type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "type" : {
- "type" : "string",
- "enum" : [ "dashboard", "model", "transform", "code_editor", "document", "question", "metric", "adhoc" ]
+ "recipients" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ }
},
- "deleted" : {
+ "template" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
}, {
"type" : "null"
} ]
},
- "requestable_indexes" : {
+ "channel_type" : { },
+ "created_at" : {
"oneOf" : [ {
- "description" : "Value must be a map.",
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "anyOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
}, {
- "description" : "Value must be a map."
+ "description" : "value must be a valid date string",
+ "type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "last_checkpoint_value" : {
+ "channel" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"type" : "null"
} ]
},
- "target" : {
+ "attachment_only" : {
"oneOf" : [ {
- "oneOf" : [ {
- "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
+ "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" : [ {
+ "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"
+ } ]
+ },
+ "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" : [ "+", "-" ]
}, {
- "type" : "object",
- "properties" : {
- "database" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "target-incremental-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms.schema.target-incremental-strategy"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "anyOf" : [ {
- "const" : "table-incremental"
- }, {
- "const" : "table-incremental"
- } ]
- }
- },
- "required" : [ "type" ],
- "additionalProperties" : false
+ "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"
} ]
- },
- "database_schema" : {
- "oneOf" : [ {
+ }, {
+ "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" : "null"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata.model-override"
+ }
} ]
- },
- "created_at" : {
- "oneOf" : [ {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_card_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "query_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
"type" : "string"
}, {
- "type" : "null"
+ "type" : "string"
} ]
- },
- "sql_engine" : {
- "oneOf" : [ {
+ }, {
+ "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" : "null"
+ "type" : "string"
} ]
- },
- "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"
+ } ]
+ },
+ "public_uuid" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_used_at" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
}, {
- "type" : "null"
+ "description" : "value must be a valid date string",
+ "type" : "string"
} ]
- },
- "creator_id" : {
+ }, {
+ "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" : "integer"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "run_trigger" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "target_table_id" : {
+ "is_data_app_group" : {
"oneOf" : [ {
- "type" : "integer"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "buffers" : {
+ "is_tenant_group" : {
"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" : "boolean"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "magic_group_type" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "chart_configs" : {
+ "members" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.permissions.schema..permissions-group.member"
+ }
+ },
+ "name" : {
"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" : "string"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "type" ],
- "additionalProperties" : false
+ "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-mapping-with-dashcard" : {
+ "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"
+ } ]
+ },
+ "dashcard" : {
+ "$ref" : "#/components/schemas/metabase.dashboards.schema.dashboard-card"
+ },
+ "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.resolved-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" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping-with-dashcard"
+ },
+ "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.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_data_app_group" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "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_data_app_group" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "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.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.queries.schema..param-field.name-field" : {
+ "description" : "A Field trimmed to the columns a parameter widget needs, as the `:name_field` hydration attaches it.",
+ "type" : "object",
+ "properties" : {
+ "settings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema..field.settings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "base_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "has_field_values" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk_target_field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "table_id", "display_name", "base_type", "effective_type", "name", "semantic_type", "has_field_values", "fk_target_field_id", "settings" ],
+ "additionalProperties" : false
+ },
+ "metabase.queries.schema..param-field.target" : {
+ "description" : "A Field trimmed to the columns a parameter widget needs, as the `:name_field` hydration attaches it.",
+ "type" : "object",
+ "properties" : {
+ "settings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema..field.settings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "base_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "name_field" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema..param-field.name-field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "has_field_values" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk_target_field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "table_id", "display_name", "base_type", "effective_type", "name", "semantic_type", "has_field_values", "fk_target_field_id", "settings" ],
+ "additionalProperties" : false
+ },
+ "metabase.queries.schema.card" : {
+ "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" : {
+ "dashboard" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.dashboards.schema.dashboard"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "persisted/table_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "enable_embedding" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_authority_level" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last-edit-info" : {
+ "oneOf" : [ {
+ "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",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "timestamp", "id", "first_name", "last_name", "email" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema..card.visualization-settings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_tab_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "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"
+ } ]
+ },
+ "can_manage_db" : {
+ "type" : "boolean"
+ },
+ "dashboard_count" : {
+ "type" : "integer"
+ },
+ "can_delete" : {
+ "type" : "boolean"
+ },
+ "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"
+ } ]
},
- "current_user_time" : {
+ "persisted/state" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "default_database_id" : {
+ "authority_level" : {
"oneOf" : [ {
- "type" : "integer"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "current_time_with_timezone" : {
+ "collection" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.collections.schema.collection-or-root"
}, {
"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" : {
+ },
+ "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"
}, {
@@ -20597,9 +32448,16 @@
} ]
},
"id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "embedding_type" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "integer"
+ "type" : "string"
}, {
"type" : "string"
} ]
@@ -20607,512 +32465,440 @@
"type" : "null"
} ]
},
- "name" : {
+ "moderation_reviews" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.content-verification.schema.moderation-review"
+ }
+ },
+ "verified-result-metadata?" : {
+ "type" : "boolean"
+ },
+ "parameter_usage_count" : {
+ "type" : "integer"
+ },
+ "persisted/definition" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "type" : {
+ "document" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.documents.schema.document"
}, {
"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"
+ "moderated-status" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
+ "creator" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.users.schema.user"
+ }, {
+ "type" : "null"
+ } ]
},
- "dimensions" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.metabot.context.research-plan-ref"
- }
+ "is_remote_synced" : {
+ "type" : "boolean"
},
- "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"
+ "made_public_by_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
- "type" : "string"
+ "type" : "null"
} ]
},
"name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name" ],
- "additionalProperties" : false
- },
- "metabase.metabot.schema.client-message" : {
- "description" : "One persisted message as the client models it.",
- "type" : "object",
- "properties" : {
- "contextTokens" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "externalId" : {
- "type" : "string"
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "type" : "string"
+ "collection_position" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "type" : "string",
+ "enum" : [ "+", "-" ]
+ }, {
+ "const" : "collection_position"
+ }, {
+ "const" : 1
+ } ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "parts" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.metabot.schema.client-message-part"
- }
+ "download_perms" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "none", "limited", "full" ]
+ }, {
+ "type" : "null"
+ } ]
},
- "role" : {
- "type" : "string",
- "enum" : [ "user", "agent" ]
+ "dashboardcard_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashcard"
+ }, {
+ "type" : "null"
+ } ]
},
- "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" : {
+ "dimensions" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema..card.dimension"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "query_description" : {
+ "oneOf" : [ {
"type" : "string"
- },
- "message" : {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "location" : {
+ "oneOf" : [ {
"type" : "string"
- },
- "role" : {
- "type" : "string",
- "enum" : [ "user", "agent" ]
- },
- "type" : {
- "const" : "text"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "id", "role", "type", "message" ]
- }, {
- "type" : "object",
- "properties" : {
- "args" : {
+ "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" : [ {
- "type" : "string"
+ "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"
} ]
- },
- "id" : {
- "type" : "string"
- },
- "is_error" : {
- "type" : "boolean"
- },
- "name" : {
- "type" : "string"
- },
- "result" : {
- "oneOf" : [ {
- "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
}, {
- "type" : "null"
+ "const" : "updated_at"
} ]
- },
- "role" : {
- "const" : "agent"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "started", "ended" ]
- },
- "type" : {
- "const" : "tool_call"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "id", "role", "type", "name", "args", "status" ]
- }, {
- "type" : "object",
- "properties" : {
- "id" : {
+ "dataset_query_metrics_v2_migration_backup" : {
+ "oneOf" : [ {
"type" : "string"
- },
- "part" : {
- "type" : "object",
- "properties" : {
- "data" : { },
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "type", "data" ]
- },
- "role" : {
- "const" : "agent"
- },
- "type" : {
- "const" : "data_part"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
- }
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "type" ]
- }, {
- "type" : "object",
- "properties" : {
- "type" : {
- "const" : "aborted"
- }
+ "legacy_query" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "type" ]
- }, {
- "type" : "object",
- "properties" : {
- "type" : {
- "const" : "in_progress"
- }
+ "document_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "type" ]
- }, {
- "type" : "object",
- "properties" : {
- "error" : {
+ "result_metadata" : {
+ "oneOf" : [ {
"anyOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata"
}, {
- "type" : "object",
- "properties" : {
- "data" : { },
- "message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "type" : "string"
- }
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata.model-override"
}
} ]
- },
- "type" : {
- "const" : "errored"
- }
- },
- "required" : [ "type", "error" ]
- } ]
- },
- "metabase.metabot.schema.state" : {
- "type" : "object",
- "properties" : {
- "chart-configs" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : { }
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "charts" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : { }
- }
+ "source_card_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
},
- "link-registry" : {
- "type" : "object",
- "additionalProperties" : {
+ "dashboard_name" : {
+ "oneOf" : [ {
"type" : "string"
- }
- },
- "queries" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : { }
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "todos" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
+ "query_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "transforms" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : { }
- }
- }
- }
- },
- "metabase.metabot.schema.state-map-key" : {
- "description" : "A dynamic state-map key, normalized to its canonical string representation.",
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
- },
- "metabase.metrics.api.BreakoutValuesResponse" : {
- "type" : "object",
- "properties" : {
- "col" : {
- "type" : "object",
- "properties" : { }
+ "can_write" : {
+ "type" : "boolean"
},
- "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" ]
+ "collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ }, {
+ "type" : "null"
+ } ]
},
- "row_count" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
+ "cache_ttl" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
+ "based_on_upload" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
+ "type" : "null"
+ } ]
},
- "filters" : {
+ "moderated_status" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.instance-filters"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "projections" : {
+ "type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.typed-projections"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
}, {
"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" : {
+ },
+ "in_dashboards" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : {
- "id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "archived" : {
+ "type" : "boolean"
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "enable_embedding" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ },
+ "name" : {
+ "type" : "string"
+ }
},
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name" ]
+ "required" : [ "id", "name", "collection_id", "description", "archived", "enable_embedding" ],
+ "additionalProperties" : false
+ }
}, {
"type" : "null"
} ]
},
- "collection_id" : {
+ "last_query_start" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "persisted/query_hash" : {
"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"
- }
+ "query_average_duration" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "collection" : {
+ "param_fields" : {
"oneOf" : [ {
"type" : "object",
- "properties" : {
- "id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.param-field"
}
- },
- "required" : [ "id", "name" ]
+ }
}, {
"type" : "null"
} ]
},
- "dataset_query" : {
+ "created_at" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "result_column_name" : {
+ "display" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "persisted" : {
+ "type" : "boolean"
+ },
+ "public_uuid" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "can_restore" : {
+ "type" : "boolean"
},
- "name" : {
- "type" : "string"
+ "last_used_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "dimensions" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.metrics.dimension.dimension"
- }
+ "persisted/active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "database_id" : {
+ "parameters" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema..card.parameter"
+ }
}, {
"type" : "null"
} ]
},
- "collection_id" : {
+ "creator_id" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "$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"
+ } ]
+ },
+ "in_library" : {
+ "type" : "boolean"
+ },
+ "entity-coll-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
@@ -21123,232 +32909,536 @@
}, {
"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.dimension.dimension" : {
- "description" : "Schema for a persisted dimension definition with status tracking.\n Persisted dimensions include additional metadata about their status\n and any issues that prevent them from being used.\n Note: target field references are stored in dimension-mappings, not here.",
- "type" : "object",
- "properties" : {
- "sources" : {
+ },
+ "card_schema" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.metrics.dimension.source"
- }
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "group" : {
+ "metabot_conversation_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.metrics.dimension.group"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "dashboard_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "average_query_time" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ },
+ "metabase.queries.schema.param-field" : {
+ "description" : "A Field trimmed to the columns a parameter widget needs, as the `:name_field` hydration attaches it.",
+ "type" : "object",
+ "properties" : {
+ "settings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema..field.settings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "base_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
"id" : {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
- "effective-type" : {
+ "name_field" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.queries.schema..param-field.name-field"
}, {
"type" : "null"
} ]
},
"name" : {
+ "type" : "string"
+ },
+ "dimensions" : {
+ "type" : "array",
+ "items" : {
+ "description" : "What an update (or insert) of a Dimension accepts: every column of `:dimension` except `id`, all optional.",
+ "type" : "object",
+ "properties" : {
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "human_readable_field" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema..param-field.name-field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "human_readable_field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
+ }
+ },
+ "semantic_type" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "status" : {
+ "table_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-status"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
}, {
"type" : "null"
} ]
},
- "has-field-values" : {
+ "has_field_values" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "status-message" : {
+ "display_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "default-temporal-unit" : {
+ "target" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.queries.schema..param-field.target"
}, {
"type" : "null"
} ]
},
- "dimension-interestingness" : {
+ "effective_type" : {
"oneOf" : [ {
- "type" : "number"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "default" : {
+ "fk_target_field_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"type" : "null"
} ]
+ }
+ },
+ "required" : [ "id", "table_id", "display_name", "base_type", "effective_type", "name", "semantic_type", "has_field_values", "fk_target_field_id", "settings" ],
+ "additionalProperties" : false
+ },
+ "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" : { }
+ }
},
- "semantic-type" : {
+ "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"
+ }
+ },
+ "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" : "string"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "cached" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "data" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema..query-result.data"
}
},
- "required" : [ "id" ]
+ "required" : [ "status", "row_count" ]
},
- "metabase.metrics.dimension.dimension-mapping" : {
- "description" : "Schema for a dimension mapping.",
+ "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" : "A downloadable JAR for a given fixed version.",
"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"
+ "url" : {
+ "type" : "string"
},
- "type" : {
- "description" : "Type of dimension mapping.",
- "type" : "string",
- "enum" : [ "table" ]
+ "version" : {
+ "$ref" : "#/components/schemas/metabase.security-center.schema.semver"
}
},
- "required" : [ "dimension-id", "target" ],
+ "required" : [ "version", "url" ],
"additionalProperties" : false
},
- "metabase.metrics.dimension.group" : {
- "description" : "Group descriptor for a dimension, indicating which table it belongs to.",
+ "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" : "A single affected version range with inclusive min and exclusive fixed.",
"type" : "object",
"properties" : {
- "display-name" : {
- "type" : "string"
- },
- "id" : {
- "type" : "string"
+ "fixed" : {
+ "$ref" : "#/components/schemas/metabase.security-center.schema.semver"
},
- "type" : {
- "type" : "string",
- "enum" : [ "main", "connection" ]
+ "min" : {
+ "$ref" : "#/components/schemas/metabase.security-center.schema.semver"
}
},
- "required" : [ "id", "type", "display-name" ]
+ "required" : [ "min", "fixed" ],
+ "additionalProperties" : false
},
- "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.",
+ "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.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" : {
- "field-id" : {
+ "cache_field_values" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.util.cron.ScheduleMap"
}, {
"type" : "null"
} ]
},
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-source.type"
+ "metadata_sync" : {
+ "$ref" : "#/components/schemas/metabase.util.cron.ScheduleMap"
}
},
- "required" : [ "type" ]
+ "additionalProperties" : false
},
- "metabase.notification.api.admin.bulk-response" : {
+ "metabase.task-history.api.RunEntity" : {
"type" : "object",
"properties" : {
- "updated" : {
- "description" : "value must be an integer greater or equal to than zero.",
+ "entity_id" : {
+ "description" : "value must be an integer greater 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"
+ "minimum" : 1
},
- "error" : {
+ "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" : {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"
+ "type" : "string",
+ "enum" : [ "started", "success", "failed", "abandoned" ]
}
},
- "required" : [ "channel_type", "status", "error" ],
"additionalProperties" : false
},
- "metabase.notification.api.admin.detail-response" : {
+ "metabase.task-history.api.RunSortParams" : {
"type" : "object",
"properties" : {
- "last_check" : {
+ "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" : [ {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"
+ "type" : "object",
+ "properties" : { }
}, {
"type" : "null"
} ]
},
- "payload_type" : {
+ "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"
},
- "payload_id" : {
+ "duration" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
@@ -21356,61 +33446,123 @@
}, {
"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" ]
},
- "send_history" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.tick-send-entry"
- }
+ "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
},
- "check_history" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"
- }
+ "started_at" : { },
+ "failed_count" : {
+ "type" : "integer"
},
- "last_send" : {
+ "ended_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "updated_at" : {
+ "status" : {
"type" : "string",
- "format" : "date-time"
+ "enum" : [ "started", "success", "failed", "abandoned" ]
},
- "created_at" : {
+ "task_count" : {
+ "type" : "integer"
+ },
+ "success_count" : {
+ "type" : "integer"
+ },
+ "entity_type" : {
"type" : "string",
- "format" : "date-time"
+ "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" ]
},
- "active" : {
- "type" : "boolean"
+ "tasks" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.task-history.api.TaskHistory"
+ }
},
- "creator_id" : {
+ "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" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "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", "active", "creator_id", "created_at", "updated_at", "payload_type", "payload_id", "last_check", "last_send", "check_history", "send_history" ]
+ "required" : [ "id", "run_type", "entity_type", "entity_id", "started_at", "ended_at", "status", "tasks" ]
},
- "metabase.notification.api.admin.list-response" : {
+ "metabase.task-history.api.TaskRunsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.list-row"
+ "$ref" : "#/components/schemas/metabase.task-history.api.TaskRun"
}
},
"limit" : {
@@ -21437,77 +33589,120 @@
"minimum" : 0
}
},
- "required" : [ "data", "total", "limit", "offset" ]
+ "required" : [ "total", "limit", "offset", "data" ]
},
- "metabase.notification.api.admin.list-row" : {
+ "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" : {
- "last_check" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"
- }, {
- "type" : "null"
- } ]
- },
- "payload_type" : {
+ "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"
},
- "payload_id" : {
+ "database_id" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "last_send" : {
+ "schema" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "updated_at" : {
- "type" : "string",
- "format" : "date-time"
- },
- "created_at" : {
- "type" : "string",
- "format" : "date-time"
- },
- "active" : {
- "type" : "boolean"
+ "table" : {
+ "type" : "string"
},
- "creator_id" : {
+ "table_id" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "id", "active", "creator_id", "created_at", "updated_at", "payload_type", "payload_id", "last_check", "last_send" ]
+ "required" : [ "alias" ],
+ "additionalProperties" : false
},
- "metabase.notification.api.admin.run-status" : {
+ "metabase.transforms-rest.api.transform.run-trigger" : {
"type" : "string",
- "enum" : [ "failing", "successful" ]
+ "enum" : [ "none", "global-schedule" ]
},
- "metabase.notification.api.admin.run-summary" : {
+ "metabase.transforms.schema..transform-run.update" : {
+ "description" : "What an update (or insert) of a TransformRun accepts: every column of `:transform_run` except `id`, all optional.",
"type" : "object",
"properties" : {
- "at" : {
- "type" : "string",
- "format" : "date-time"
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "error" : {
+ "user_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_hi_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_lo_value" : {
"oneOf" : [ {
"type" : "string"
}, {
@@ -21515,1105 +33710,768 @@
} ]
},
"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"
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_filter_field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "end_time" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_heartbeat" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "channels" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.channel-entry"
- }
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "error" : {
+ "dag_run_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "status" : {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"
+ "start_time" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
}
},
- "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
- }
- },
- "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.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
- }
- },
- "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.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"
- }
+ "metabase.transforms.schema..transform.owner" : {
+ "description" : "The `:owner` hydrated onto a Transform: its owning User, or just the `:email` of an owner outside Metabase.",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.users.schema.user"
+ }, {
+ "type" : "object",
+ "properties" : {
+ "email" : {
+ "type" : "string"
}
},
- "required" : [ "payload_type", "payload" ],
+ "required" : [ "email" ],
+ "additionalProperties" : false
+ } ]
+ },
+ "metabase.transforms.schema..transform.source" : {
+ "description" : "The `:source` column of a Transform, decoded.",
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-source"
+ },
+ "metabase.transforms.schema..transform.table-dependency" : {
+ "description" : "One entry of the `:table_dependencies` column of a Transform, decoded.",
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "table" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }
+ },
+ "required" : [ "table" ],
"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
+ "transform" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
+ }
+ },
+ "required" : [ "transform" ],
+ "additionalProperties" : false
+ } ]
+ },
+ "metabase.transforms.schema..transform.target" : {
+ "description" : "The `:target` column of a Transform, decoded.",
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
+ },
+ "metabase.transforms.schema..transform.update" : {
+ "description" : "What an update (or insert) of a Transform accepts: every column of `:transform` except `id`, all optional, plus `:run_trigger` consumed by the model's hooks.",
+ "type" : "object",
+ "properties" : {
+ "source_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
}, {
- "type" : "null"
+ "type" : "string"
} ]
- },
- "handlers" : {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_database_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_db_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_dependencies" : {
+ "oneOf" : [ {
"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
+ "$ref" : "#/components/schemas/metabase.transforms.schema..transform.table-dependency"
}
- },
- "internal_id" : {
- "oneOf" : [ {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema..transform.source"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_checkpoint_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema..transform.target"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
"type" : "string"
}, {
- "type" : "null"
- } ]
- },
- "payload" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.notification.models..SystemEventPayload.request"
- }, {
- "type" : "null"
+ "type" : "string"
} ]
- },
- "payload_id" : {
- "oneOf" : [ {
- "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ },
+ "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" : {
+ "description" : "What an update (or insert) of a Transform accepts: every column of `:transform` except `id`, all optional, plus `:run_trigger` consumed by the model's hooks.",
+ "type" : "object",
+ "properties" : {
+ "table" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema..transform.owner"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_read" : {
+ "type" : "boolean"
+ },
+ "source_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
}, {
- "type" : "null"
+ "type" : "string"
} ]
- },
- "payload_type" : {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-run"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.collections.schema.collection-or-root"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_database_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_db_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.users.schema.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ {
"type" : "string",
- "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ]
- },
- "subscriptions" : {
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tag_ids" : {
+ "oneOf" : [ {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "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" : {
+ "table_dependencies" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema..transform.table-dependency"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_write" : {
+ "type" : "boolean"
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_execute" : {
+ "type" : "boolean"
+ },
+ "source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema..transform.source"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_checkpoint_value" : {
+ "oneOf" : [ {
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "event_topic" : { }
+ "target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema..transform.target"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
+ "required" : [ "id" ],
"additionalProperties" : false
},
- "metabase.notification.models.CreateNotificationCardParams" : {
- "description" : "Schema for :model/NotificationCard on a create request.",
+ "metabase.transforms.schema.transform-run" : {
+ "description" : "What an update (or insert) of a TransformRun accepts: every column of `:transform_run` except `id`, all optional.",
"type" : "object",
"properties" : {
- "card" : {
+ "message" : {
"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" : [ {
- "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"
- } ]
- },
- "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" : [ {
- "type" : "integer"
- }, {
- "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" : {
- "type" : "string",
- "enum" : [ "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" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata"
- }, {
- "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" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_hi_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "card_id" : {
+ "transform_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
- "created_at" : {
+ "run_method" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "string"
}, {
- "description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "disable_links" : {
+ "checkpoint_lo_value" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "notification_id" : {
+ "status" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_filter_field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "end_time" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_heartbeat" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dag_run_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
@@ -22622,42 +34480,487 @@
"type" : "null"
} ]
},
- "send_condition" : {
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "start_time" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
+ },
+ "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" : {
+ "const" : "python"
+ }
+ },
+ "required" : [ "source-tables", "type", "body" ],
+ "additionalProperties" : false
+ } ]
+ },
+ "metabase.transforms.schema.transform-target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.table-target"
+ }, {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.table-incremental-target"
+ } ]
+ },
+ "metabase.users-rest.api.current-user-response" : {
+ "description" : "Response for `GET /api/user/current`.",
+ "type" : "object",
+ "properties" : {
+ "permissions" : {
+ "$ref" : "#/components/schemas/metabase.users-rest.api.user-permissions"
+ },
+ "has_model" : {
+ "type" : "boolean"
+ },
+ "login_attributes" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "sso_source" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "jwt_attributes" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_qbnewb" : {
+ "type" : "boolean"
+ },
+ "is_active" : {
+ "type" : "boolean"
+ },
+ "last_login" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "tenant_collection_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
+ },
+ "email" : {
"type" : "string",
- "enum" : [ "goal_below", "has_result", "goal_above" ]
+ "minLength" : 1
},
- "send_once" : {
+ "group_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "uniqueItems" : true
+ },
+ "is_data_analyst" : {
+ "type" : "boolean"
+ },
+ "locale" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "first_login" : { },
+ "is_superuser" : {
+ "type" : "boolean"
+ },
+ "tenant_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "custom_homepage" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "dashboard_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "dashboard_id" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_installer" : {
+ "type" : "boolean"
+ },
+ "attributes" : {
+ "type" : "object",
+ "additionalProperties" : { }
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : { },
+ "has_invited_second_user" : {
+ "type" : "boolean"
+ },
+ "personal_collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "has_question_and_dashboard" : {
+ "type" : "boolean"
+ },
+ "can_write_any_collection" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "id", "email", "first_name", "last_name", "common_name", "date_joined", "last_login", "updated_at", "first_login", "is_superuser", "is_data_analyst", "is_qbnewb", "is_active", "is_installer", "has_invited_second_user", "has_question_and_dashboard", "has_model", "can_write_any_collection", "sso_source", "locale", "tenant_id", "tenant_collection_id", "personal_collection_id", "group_ids", "login_attributes", "jwt_attributes", "attributes", "permissions", "custom_homepage" ]
+ },
+ "metabase.users-rest.api.user-permissions" : {
+ "description" : "Permission flags for the current user, used by the FE to decide which UI elements to show. The `can_access_*`,\n `is_data_analyst`, and `is_group_manager` flags are only included when `advanced-permissions` is enabled.",
+ "type" : "object",
+ "properties" : {
+ "can_access_subscription" : {
+ "type" : "boolean"
+ },
+ "can_create_native_queries" : {
+ "type" : "boolean"
+ },
+ "can_access_setting" : {
+ "type" : "boolean"
+ },
+ "is_data_analyst" : {
+ "type" : "boolean"
+ },
+ "is_group_manager" : {
+ "type" : "boolean"
+ },
+ "can_access_monitoring" : {
+ "type" : "boolean"
+ },
+ "can_access_data_model" : {
+ "type" : "boolean"
+ },
+ "can_access_db_details" : {
+ "type" : "boolean"
+ },
+ "can_create_queries" : {
+ "type" : "boolean"
+ },
+ "can_access_transforms" : {
"type" : "boolean"
+ }
+ },
+ "required" : [ "can_create_queries", "can_create_native_queries" ]
+ },
+ "metabase.users.schema..user-parameter-value.value" : {
+ "description" : "The `:value` column of a UserParameterValue, decoded.",
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ }, {
+ "type" : "array",
+ "items" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ]
+ },
+ "metabase.users.schema..user.settings" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "metabase.users.schema..user.update" : {
+ "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"
+ } ]
+ },
+ "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" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "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" : [ {
- "anyOf" : [ {
- "type" : "string",
- "format" : "date-time"
- }, {
- "description" : "value must be a valid date string",
- "type" : "string"
- } ]
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_datasetnewb" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "reset_triggered" : {
+ "oneOf" : [ {
+ "type" : "integer"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "card_id" ],
- "additionalProperties" : false
- },
- "metabase.notification.models.CreateNotificationHandlerParams" : {
- "description" : "Schema for :model/NotificationHandler on a create request.",
- "type" : "object",
- "properties" : {
- "active" : {
+ },
+ "is_superuser" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "channel_id" : {
+ "tenant_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
@@ -22666,446 +34969,235 @@
"type" : "null"
} ]
},
- "channel_type" : { },
- "created_at" : {
+ "last_name" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string",
- "format" : "date-time"
- }, {
- "description" : "value must be a valid date string",
- "type" : "string"
- } ]
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "template_id" : {
+ "first_name" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "updated_at" : {
+ "type" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "string"
}, {
- "description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
+ },
+ "date_joined" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "password" : {
+ "oneOf" : [ {
+ "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"
+ "metabase.users.schema.user" : {
+ "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 valid date string",
- "type" : "string"
+ "description" : "Value must be a map."
} ]
}, {
- "type" : "null"
- } ]
- },
- "user" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.notification.models.EchoedUser"
- }, {
- "type" : "null"
+ "description" : "login attribute keys must not start with `@`"
} ]
- },
- "user_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "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"
- } ]
+ "sso_source" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
}, {
- "type" : "null"
+ "type" : "string"
} ]
- },
- "details" : { },
- "notification_handler_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "permissions_group" : {
- "oneOf" : [ {
- "description" : "A PermissionsGroup as selected from the app DB: every column of `:permissions_group`.",
- "type" : "object",
- "properties" : {
- "entity_id" : {
- "type" : "string"
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "is_data_app_group" : {
- "type" : "boolean"
- },
- "is_tenant_group" : {
- "type" : "boolean"
- },
- "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" : {
- "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"
}
- },
- "required" : [ "id", "name", "entity_id", "magic_group_type", "is_tenant_group", "is_data_app_group" ],
- "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"
+ "description" : "Value must be a map."
} ]
}, {
- "type" : "null"
+ "description" : "login attribute keys must not start with `@`"
} ]
- },
- "user_id" : { }
+ }, {
+ "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
- },
- "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" : { }
+ "is_qbnewb" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "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" : {
+ "user_group_memberships" : {
+ "type" : "array",
+ "items" : {
"type" : "object",
"properties" : {
- "is_optional" : {
- "type" : "boolean"
+ "entity_id" : {
+ "type" : "string"
},
- "pattern" : {
+ "name" : {
"type" : "string"
}
},
- "required" : [ "pattern" ],
+ "required" : [ "name", "entity_id" ],
"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" : {
+ "reset_token" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
"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" : {
+ } ]
+ },
+ "settings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.users.schema..user.settings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "deactivated_at" : {
+ "oneOf" : [ {
"type" : "string",
- "enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ]
- },
- "ui_display_type" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
- }
+ "format" : "date-time"
+ }, {
+ "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" : {
+ "entity_id" : {
+ "oneOf" : [ {
"type" : "string"
- },
- "event_name" : {
+ }, {
"type" : "null"
- },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "type" : {
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_login" : {
+ "oneOf" : [ {
"type" : "string",
- "enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ]
- },
- "ui_display_type" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "cron/raw", "cron/builder" ]
- }, {
- "type" : "null"
- } ]
- }
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "type", "cron_schedule" ],
- "additionalProperties" : false
- } ]
- },
- "metabase.notification.models.EchoedUser" : {
- "description" : "A User as selected from the app DB: every column of `:core_user` that the model selects by default, plus `:common_name` added by the model's after-select hook.",
- "type" : "object",
- "properties" : {
- "is_qbnewb" : {
- "type" : "boolean"
+ "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"
+ } ]
},
- "last_login" : {
+ "locale" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string",
- "format" : "date-time"
- }, {
- "description" : "value must be a valid date string",
- "type" : "string"
- } ]
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "email" : {
- "type" : "string"
+ "is_datasetnewb" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "is_data_analyst" : {
- "type" : "boolean"
+ "reset_triggered" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
"is_superuser" : {
- "type" : "boolean"
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
"tenant_id" : {
"oneOf" : [ {
@@ -23123,6 +35215,21 @@
"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"
@@ -23130,19 +35237,32 @@
"type" : "null"
} ]
},
- "date_joined" : {
+ "type" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "string"
}, {
- "description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
+ "date_joined" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "password" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"common_name" : {
"oneOf" : [ {
"type" : "string"
@@ -23151,1970 +35271,796 @@
} ]
}
},
- "required" : [ "id", "email", "first_name", "last_name", "date_joined", "last_login", "is_superuser", "is_qbnewb", "tenant_id", "is_data_analyst" ],
+ "required" : [ "id" ],
"additionalProperties" : false
},
- "metabase.notification.models.FullyHydratedNotification" : {
- "description" : "Fully hydrated notification.",
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "payload_type" : {
+ "metabase.users.schema.user-group-membership" : {
+ "description" : "Group Membership info of a User.\n In which :is_group_manager is only included if `advanced-permissions` is enabled.",
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_group_manager" : {
+ "description" : "Only relevant if `advanced-permissions` is enabled. If it is, you should always include this key.",
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
+ },
+ "metabase.util.cron.CronHour" : {
+ "type" : "integer",
+ "minimum" : 0,
+ "maximum" : 23
+ },
+ "metabase.util.cron.CronMinute" : {
+ "type" : "integer",
+ "minimum" : 0,
+ "maximum" : 59
+ },
+ "metabase.util.cron.CronScheduleString" : {
+ "description" : "value must be a valid Quartz cron schedule string.",
+ "type" : "string",
+ "minLength" : 1
+ },
+ "metabase.util.cron.ScheduleMap" : {
+ "description" : "value must be a valid schedule map. See schema in metabase.util.cron for details.",
+ "type" : "object",
+ "properties" : {
+ "schedule_day" : {
+ "oneOf" : [ {
"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"
- } ]
- },
- "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
- }
- },
- "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"
- }
- }
+ "enum" : [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ]
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "payload_type", "payload" ],
- "additionalProperties" : false
- }, {
- "type" : "object",
- "properties" : {
- "payload_type" : {
+ "schedule_frame" : {
+ "oneOf" : [ {
"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"
- } ]
- },
- "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
- }
- },
- "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"
- }
- }
+ "enum" : [ "first", "mid", "last" ]
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "payload_type" ],
- "additionalProperties" : false
- } ]
+ "schedule_hour" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.util.cron.CronHour"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedule_minute" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.util.cron.CronMinute"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedule_type" : {
+ "type" : "string",
+ "enum" : [ "hourly", "daily", "weekly", "monthly" ]
+ }
+ },
+ "required" : [ "schedule_type" ],
+ "additionalProperties" : false
},
- "metabase.notification.models.NotificationCard" : {
- "description" : "Schema for :model/NotificationCard.",
+ "metabase.warehouse-schema-rest.api.table.data-authority-write" : {
+ "description" : "Schema for writing a valid table data authority.",
+ "type" : "string",
+ "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
+ },
+ "metabase.warehouse-schema-rest.api.table.data-layers" : {
+ "type" : "string",
+ "enum" : [ "final", "internal", "hidden" ]
+ },
+ "metabase.warehouse-schema-rest.api.table.data-sources" : {
+ "type" : "string",
+ "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
+ },
+ "metabase.warehouse-schema.schema..dimension.update" : {
+ "description" : "What an update (or insert) of a Dimension accepts: every column of `:dimension` except `id`, all optional.",
"type" : "object",
"properties" : {
- "id" : {
+ "created_at" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "send_condition" : {
- "type" : "string",
- "enum" : [ "goal_below", "has_result", "goal_above" ]
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "card_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
},
- "updated_at" : {
+ "human_readable_field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "string"
}, {
- "description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "card" : {
+ "updated_at" : {
"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" : [ {
- "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"
- } ]
- },
- "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" : [ {
- "type" : "integer"
- }, {
- "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" : {
- "type" : "string",
- "enum" : [ "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" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata"
- }, {
- "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" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ },
+ "metabase.warehouse-schema.schema..field.settings" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "metabase.warehouse-schema.schema..field.update" : {
+ "description" : "What an update (or insert) of a Field accepts: every column of `:metabase_field` except `id`, all optional.",
+ "type" : "object",
+ "properties" : {
+ "points_of_interest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "preview_display" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_partitioned" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_default" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_required" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_defective_duplicate" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "settings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema..field.settings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fingerprint" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visibility_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "created_at" : {
+ "base_type" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "string"
}, {
- "description" : "value must be a valid date string",
"type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "disable_links" : {
+ "last_analyzed" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "notification_id" : {
+ "custom_position" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
}, {
"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" ]
+ "coercion_strategy" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "send_once" : {
- "type" : "boolean"
- }
- },
- "required" : [ "card_id" ],
- "additionalProperties" : false
- },
- "metabase.notification.models.NotificationHandler" : {
- "type" : "object",
- "properties" : {
- "active" : {
+ "json_unfolding" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "channel_id" : {
+ "position" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "channel_type" : { },
- "created_at" : {
+ "fingerprint_version" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "data_sensitivity" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "string"
}, {
- "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" : {
+ "database_position" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "updated_at" : {
+ "semantic_type" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "string"
}, {
- "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" : "A PermissionsGroup as selected from the app DB: every column of `:permissions_group`.",
- "type" : "object",
- "properties" : {
- "entity_id" : {
- "type" : "string"
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "is_data_app_group" : {
- "type" : "boolean"
- },
- "is_tenant_group" : {
- "type" : "boolean"
- },
- "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" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name", "entity_id", "magic_group_type", "is_tenant_group", "is_data_app_group" ],
- "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" : {
+ "updated_at" : {
+ "oneOf" : [ {
"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" : { }
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "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" : { }
+ "database_is_auto_increment" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "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" : {
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
"type" : "null"
- },
- "event_name" : {
+ } ]
+ },
+ "has_field_values" : {
+ "oneOf" : [ {
"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 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" : {
+ "display_name" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "event_info" : {
+ "database_is_generated" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "event_topic" : { }
- },
- "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" : {
+ "nfc_path" : {
"oneOf" : [ {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}
}, {
"type" : "null"
} ]
},
- "mappings" : {
+ "effective_type" : {
"oneOf" : [ {
"anyOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
- }
+ "type" : "string"
}, {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
- },
- "uniqueItems" : true
+ "type" : "string"
} ]
}, {
"type" : "null"
} ]
},
- "sectionId" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "parent_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "values_source_config" : {
+ "created_at" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.values-source-config"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "hasVariableTemplateTagTarget" : {
+ "database_is_pk" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "caveats" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
- },
- "position" : {
+ "active" : {
"oneOf" : [ {
- "type" : "integer"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "name" : {
- "type" : "string"
- },
- "slug" : {
- "type" : "string"
- },
- "value" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
- },
- "required" : {
+ "dimension_interestingness" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "values_query_type" : {
+ "database_is_nullable" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.values-query-type"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
- },
- "temporal_units" : {
+ "database_type" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "target" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
- },
- "values_source_type" : {
+ "database_indexed" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.values-source-type"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "options" : {
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.options"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "default" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
- },
- "isMultiSelect" : {
+ "fk_target_field_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
"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",
+ "metabase.warehouse-schema.schema..table.update" : {
+ "description" : "What an update (or insert) of a Table accepts: every column of `:metabase_table` except `id`, all optional.",
"type" : "object",
"properties" : {
- "card_id" : {
+ "points_of_interest" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ "type" : "string"
}, {
"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" : {
- "default" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "name" : {
+ "transform_target" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "options" : {
+ "is_writable" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.options"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "slug" : {
+ "is_upload" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "target" : {
+ "is_defective_duplicate" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "type" : {
+ "deactivated_at" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "value" : {
- "$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" : {
+ "visibility_type" : {
"oneOf" : [ {
- "type" : "boolean"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "groups" : {
+ "data_authority" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.permissions-rest.schema.db-perms"
- }, { } ]
- }
- }, {
- "anyOf" : [ {
- "type" : "null"
- }, { } ]
- } ]
- }
- }, { } ]
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "impersonations" : {
+ "view_count" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.permissions-rest.schema.impersonation-update"
- }
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "revision" : {
+ "data_layer" : {
"oneOf" : [ {
- "description" : "value must be an integer.",
- "type" : "integer"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "sandboxes" : {
+ "transform_id" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.permissions-rest.schema.sandbox-update"
- }
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
}, {
"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
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "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" : {
+ "database_require_filter" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.permissions-rest.schema.attribute-remappings"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "card_id" : {
+ "show_in_getting_started" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "group_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
},
- "permission_id" : {
+ "name" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"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" : {
+ "updated_at" : {
+ "oneOf" : [ {
"type" : "string",
- "enum" : [ "all", "none" ]
- }
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "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
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "group_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "archived_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ }, {
+ "type" : "null"
+ } ]
},
- "email" : {
- "type" : "string"
+ "data_source" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "is_group_manager" : {
+ "is_published" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "is_superuser" : {
- "type" : "boolean"
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "last_name" : {
+ "caveats" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "first_name" : {
+ "db_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"type" : "null"
} ]
},
- "type" : {
- "anyOf" : [ {
- "type" : "string"
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
}, {
- "type" : "string"
+ "type" : "null"
} ]
},
- "common_name" : {
+ "estimated_row_count" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "membership_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "initial_sync_status" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "field_order" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "id", "user_id", "first_name", "last_name", "email", "is_superuser", "type", "group_id", "membership_id" ],
"additionalProperties" : false
},
- "metabase.permissions.schema.permissions-group" : {
- "description" : "A PermissionsGroup as selected from the app DB: every column of `:permissions_group`.",
+ "metabase.warehouse-schema.schema.dimension" : {
+ "description" : "What an update (or insert) of a Dimension accepts: every column of `:dimension` except `id`, all optional.",
"type" : "object",
"properties" : {
"entity_id" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "human_readable_field" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema.field"
+ }, {
+ "type" : "null"
+ } ]
},
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
- "is_data_app_group" : {
- "type" : "boolean"
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "is_tenant_group" : {
- "type" : "boolean"
+ "human_readable_field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
},
- "magic_group_type" : {
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
@@ -25125,132 +36071,133 @@
"type" : "null"
} ]
},
- "name" : {
- "type" : "string"
+ "field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "id", "name", "entity_id", "magic_group_type", "is_tenant_group", "is_data_app_group" ],
+ "required" : [ "id" ],
"additionalProperties" : false
},
- "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.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.",
+ "metabase.warehouse-schema.schema.field" : {
+ "description" : "What an update (or insert) of a Field accepts: every column of `:metabase_field` except `id`, all optional.",
"type" : "object",
"properties" : {
- "enable_embedding" : {
+ "points_of_interest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "preview_display" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "visualization_settings" : {
+ "database_partitioned" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema..card.visualization-settings"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "dimension_mappings" : {
+ "database_default" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.queries.schema..card.dimension-mapping"
- }
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "cache_invalidated_at" : {
+ "unique_field_helper" : {
"oneOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "collection_preview" : {
+ "database_required" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "initially_published_at" : {
+ "is_defective_duplicate" : {
"oneOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "view_count" : {
+ "settings" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema..field.settings"
}, {
"type" : "null"
} ]
},
- "entity_id" : {
+ "fingerprint" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
}, {
"type" : "null"
} ]
},
- "dataset_query" : {
+ "visibility_type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema..card.dataset-query"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "parameter_mappings" : {
+ "base_type" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.queries.schema..card.parameter-mapping"
- }
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "metabot_chart_id" : {
+ "last_analyzed" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "embedding_type" : {
+ "custom_position" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "coercion_strategy" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
@@ -25261,72 +36208,75 @@
"type" : "null"
} ]
},
- "verified-result-metadata?" : {
- "type" : "boolean"
- },
- "made_public_by_id" : {
+ "json_unfolding" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "name" : {
+ "name_field" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.queries.schema..param-field.name-field"
}, {
"type" : "null"
} ]
},
- "archived" : {
+ "position" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "collection_position" : {
+ "fingerprint_version" : {
"oneOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"dimensions" : {
"oneOf" : [ {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.queries.schema..card.dimension"
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema.dimension"
}
}, {
"type" : "null"
} ]
},
- "database_id" : {
+ "data_sensitivity" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "embedding_params" : {
+ "database_position" : {
"oneOf" : [ {
- "description" : "value must be a valid embedding params map.",
- "oneOf" : [ {
- "description" : "Value must be a map.",
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string",
- "enum" : [ "disabled", "enabled", "locked" ]
- }
- }, {
- "description" : "Value must be a map."
- } ]
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
}, {
- "type" : "null"
+ "type" : "string"
} ]
}, {
"type" : "null"
@@ -25340,9 +36290,9 @@
"type" : "null"
} ]
},
- "dataset_query_metrics_v2_migration_backup" : {
+ "database_is_auto_increment" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -25354,35 +36304,53 @@
"type" : "null"
} ]
},
- "legacy_query" : {
+ "has_field_values" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "document_id" : {
+ "database_is_generated" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "result_metadata" : {
+ "nfc_path" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata"
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }
}, {
"type" : "null"
} ]
},
- "source_card_id" : {
+ "target" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema.field"
}, {
"type" : "null"
} ]
},
- "query_type" : {
+ "effective_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
@@ -25393,36 +36361,59 @@
"type" : "null"
} ]
},
- "collection_id" : {
+ "parent_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "cache_ttl" : {
+ "created_at" : {
"oneOf" : [ {
- "type" : "integer"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "type" : {
+ "database_is_pk" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "created_at" : {
+ "caveats" : {
"oneOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "display" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dimension_interestingness" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_is_nullable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_type" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
@@ -25433,14 +36424,108 @@
"type" : "null"
} ]
},
- "public_uuid" : {
+ "database_indexed" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "last_used_at" : {
+ "fk_target_field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ],
+ "additionalProperties" : false
+ },
+ "metabase.warehouse-schema.schema.table" : {
+ "description" : "What an update (or insert) of a Table accepts: every column of `:metabase_table` except `id`, all optional.",
+ "type" : "object",
+ "properties" : {
+ "points_of_interest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_target" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_writable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_upload" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_defective_duplicate" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "deactivated_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
@@ -25448,1180 +36533,714 @@
"type" : "null"
} ]
},
- "parameters" : {
+ "visibility_type" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.queries.schema..card.parameter"
- }
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "creator_id" : {
+ "data_authority" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "metabase_version" : {
+ "view_count" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "data_layer" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
}, {
"type" : "null"
} ]
},
- "archived_directly" : {
+ "schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "public_uuid_prefix" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ },
+ "transform" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "unique_table_helper" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "card_schema" : {
+ "database_require_filter" : {
"oneOf" : [ {
- "type" : "integer"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "metabot_conversation_id" : {
+ "show_in_getting_started" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "dashboard_id" : {
+ "owner_email" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ "type" : "string"
}, {
"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"
- }
- },
- "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" : {
+ "owner_user_id" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
- "cached" : {
+ "name" : {
"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" : "A downloadable JAR for a given fixed version.",
- "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" : "A single affected version range with inclusive min and exclusive fixed.",
- "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.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" : {
+ "updated_at" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.util.cron.ScheduleMap"
+ "type" : "string",
+ "format" : "date-time"
}, {
"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" : {
+ "display_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" : {
+ "archived_at" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : { }
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "started_at" : { },
- "ended_at" : {
- "oneOf" : [ { }, {
+ "collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ }, {
"type" : "null"
} ]
},
- "status" : {
- "type" : "string",
- "enum" : [ "started", "success", "failed", "unknown" ]
- },
- "logs" : {
- "oneOf" : [ { }, {
+ "data_source" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
"type" : "null"
} ]
},
- "task" : {
- "type" : "string"
- },
- "duration" : {
+ "fields" : {
"oneOf" : [ {
- "type" : "integer"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema.field"
+ }
}, {
"type" : "null"
} ]
},
- "run_id" : {
+ "is_published" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "boolean"
}, {
"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" : [ { }, {
+ "db" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouses.schema.database"
+ }, {
"type" : "null"
} ]
},
- "entity_name" : {
+ "created_at" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "string",
+ "format" : "date-time"
}, {
"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" : [ { }, {
+ "caveats" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
"type" : "null"
} ]
},
- "entity_name" : {
+ "db_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"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" : {
+ "active" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "offset" : {
+ "estimated_row_count" : {
"oneOf" : [ {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
+ "type" : "integer"
}, {
"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.",
- "type" : "object",
- "properties" : {
- "alias" : {
- "type" : "string"
- },
- "database_id" : {
- "type" : "integer"
+ "initial_sync_status" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "schema" : {
+ "entity_type" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
},
- "table" : {
- "type" : "string"
- },
- "table_id" : {
+ "field_order" : {
"oneOf" : [ {
- "type" : "integer"
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "alias", "database_id", "schema" ],
- "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" : {
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms.schema.lookback"
+ "type" : "string"
}, {
"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" ],
+ "required" : [ "id" ],
"additionalProperties" : false
},
- "metabase.transforms.schema.merge-config" : {
+ "metabase.warehouses-rest.api.available-settings" : {
"type" : "object",
- "properties" : {
- "type" : {
- "const" : "merge"
- },
- "unique-key" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms.schema.merge-key-column"
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : {
+ "enabled" : {
+ "type" : "boolean"
+ },
+ "reasons" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "key" : {
+ "type" : "string"
+ },
+ "message" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, { } ]
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "error", "warning" ]
+ }
+ },
+ "required" : [ "key", "type", "message" ]
+ }
}
- }
- },
- "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
+ "required" : [ "enabled" ]
+ }
},
- "metabase.transforms.schema.source-incremental-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms.schema.checkpoint-strategy"
+ "metabase.warehouses.schema..database.admin-details" : {
+ "description" : "The `:admin_details` column of a Database, decoded.",
+ "anyOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.undecryptable-column"
} ]
},
- "metabase.transforms.schema.table-incremental-target" : {
+ "metabase.warehouses.schema..database.dbms-version" : {
+ "description" : "The `:dbms_version` column of a Database, decoded.",
"type" : "object",
"properties" : {
- "database" : {
- "type" : "integer"
+ "cloud" : {
+ "type" : "boolean"
},
- "name" : {
+ "flavor" : {
"type" : "string"
},
- "schema" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "semantic-version" : {
+ "anyOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "integer"
+ }
}, {
- "type" : "null"
+ "type" : "object",
+ "properties" : {
+ "major" : {
+ "type" : "integer"
+ },
+ "minor" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "major", "minor" ],
+ "additionalProperties" : false
} ]
},
- "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" : {
- "type" : "integer"
- },
- "name" : {
+ "version" : {
"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"
+ "metabase.warehouses.schema..database.details" : {
+ "description" : "The `:details` column of a Database, decoded.",
+ "anyOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
}, {
- "$ref" : "#/components/schemas/metabase.transforms.schema.merge-config"
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.undecryptable-column"
} ]
},
- "metabase.transforms.schema.transform-source" : {
- "oneOf" : [ {
+ "metabase.warehouses.schema..database.settings" : {
+ "description" : "The `:settings` column of a Database, decoded.",
+ "anyOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
- "properties" : {
- "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
+ "properties" : { }
}, {
- "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" : {
- "const" : "python"
- }
- },
- "required" : [ "source-tables", "type", "body" ],
- "additionalProperties" : false
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.undecryptable-column"
} ]
},
- "metabase.transforms.schema.transform-target" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.transforms.schema.table-target"
- }, {
- "$ref" : "#/components/schemas/metabase.transforms.schema.table-incremental-target"
- } ]
+ "metabase.warehouses.schema..database.undecryptable-column" : {
+ "description" : "An encrypted JSON column of a Database read without the key that encrypted it, which the model's transform logs and\n returns as the raw ciphertext string.",
+ "type" : "string"
},
- "metabase.users-rest.api.current-user-response" : {
- "description" : "Response for `GET /api/user/current`.",
+ "metabase.warehouses.schema..database.update" : {
+ "description" : "What an update (or insert) of a Database accepts: every column of `:metabase_database` except `id`, all optional.",
"type" : "object",
"properties" : {
- "permissions" : {
- "$ref" : "#/components/schemas/metabase.users-rest.api.user-permissions"
- },
- "has_model" : {
- "type" : "boolean"
- },
- "login_attributes" : {
+ "points_of_interest" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "sso_source" : {
+ "provider_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "jwt_attributes" : {
+ "cache_field_values_schedule" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "is_qbnewb" : {
- "type" : "boolean"
- },
- "is_active" : {
- "type" : "boolean"
+ "uploads_enabled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "last_login" : {
- "oneOf" : [ { }, {
+ "write_data_details" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.write-data-details"
+ }, {
"type" : "null"
} ]
},
- "tenant_collection_id" : {
+ "settings" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.settings"
}, {
"type" : "null"
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "timezone" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "email" : {
- "type" : "string",
- "minLength" : 1
+ "metadata_sync_schedule" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "group_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "uniqueItems" : true
+ "is_sample" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "is_data_analyst" : {
- "type" : "boolean"
+ "dbms_version" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.dbms-version"
+ }, {
+ "type" : "null"
+ } ]
},
- "locale" : {
+ "name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "updated_at" : {
- "oneOf" : [ { }, {
+ "is_on_demand" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
"type" : "null"
} ]
},
- "first_login" : { },
- "is_superuser" : {
- "type" : "boolean"
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
},
- "tenant_id" : {
+ "uploads_schema_name" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "custom_homepage" : {
+ "cache_ttl" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : {
- "dashboard_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "dashboard_id" ]
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "last_name" : {
+ "is_attached_dwh" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "is_installer" : {
- "type" : "boolean"
+ "engine" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "attributes" : {
- "type" : "object",
- "additionalProperties" : { }
+ "router_database_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "type" : "null"
+ } ]
},
- "first_name" : {
+ "uploads_table_prefix" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "date_joined" : { },
- "has_invited_second_user" : {
- "type" : "boolean"
- },
- "personal_collection_id" : {
+ "details" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.details"
}, {
"type" : "null"
} ]
},
- "common_name" : {
+ "created_at" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "has_question_and_dashboard" : {
- "type" : "boolean"
- },
- "can_write_any_collection" : {
- "type" : "boolean"
- }
- },
- "required" : [ "id", "email", "first_name", "last_name", "common_name", "date_joined", "last_login", "updated_at", "first_login", "is_superuser", "is_data_analyst", "is_qbnewb", "is_active", "is_installer", "has_invited_second_user", "has_question_and_dashboard", "has_model", "can_write_any_collection", "sso_source", "locale", "tenant_id", "tenant_collection_id", "personal_collection_id", "group_ids", "login_attributes", "jwt_attributes", "attributes", "permissions", "custom_homepage" ]
- },
- "metabase.users-rest.api.user-permissions" : {
- "description" : "Permission flags for the current user, used by the FE to decide which UI elements to show. The `can_access_*`,\n `is_data_analyst`, and `is_group_manager` flags are only included when `advanced-permissions` is enabled.",
- "type" : "object",
- "properties" : {
- "can_access_subscription" : {
- "type" : "boolean"
+ "is_full_sync" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "can_create_native_queries" : {
- "type" : "boolean"
+ "auto_run_queries" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "can_access_setting" : {
- "type" : "boolean"
+ "caveats" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "is_data_analyst" : {
- "type" : "boolean"
+ "is_stub" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "is_group_manager" : {
- "type" : "boolean"
+ "admin_details" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.admin-details"
+ }, {
+ "type" : "null"
+ } ]
},
- "can_access_monitoring" : {
- "type" : "boolean"
+ "initial_sync_status" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "can_access_data_model" : {
- "type" : "boolean"
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
},
- "can_access_db_details" : {
- "type" : "boolean"
+ "refingerprint" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "can_create_queries" : {
- "type" : "boolean"
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "can_access_transforms" : {
- "type" : "boolean"
+ "is_audit" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "can_create_queries", "can_create_native_queries" ]
+ "additionalProperties" : false
},
- "metabase.users.schema.user" : {
- "description" : "A User as selected from the app DB: every column of `:core_user` that the model selects by default, plus `:common_name` added by the model's after-select hook.",
+ "metabase.warehouses.schema..database.write-data-details" : {
+ "description" : "The `:write_data_details` column of a Database, decoded.",
+ "anyOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.undecryptable-column"
+ } ]
+ },
+ "metabase.warehouses.schema.database" : {
+ "description" : "What an update (or insert) of a Database accepts: every column of `:metabase_database` except `id`, all optional.",
"type" : "object",
"properties" : {
- "is_qbnewb" : {
- "type" : "boolean"
- },
- "last_login" : {
+ "points_of_interest" : {
"oneOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
- },
- "email" : {
- "type" : "string"
- },
- "is_data_analyst" : {
- "type" : "boolean"
+ "provider_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "is_superuser" : {
- "type" : "boolean"
+ "cache_field_values_schedule" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "tenant_id" : {
+ "native_permissions" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string",
+ "enum" : [ "write", "none" ]
}, {
"type" : "null"
} ]
},
- "last_name" : {
+ "uploads_enabled" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "first_name" : {
+ "write_data_details" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.write-data-details"
}, {
"type" : "null"
} ]
},
- "date_joined" : {
- "type" : "string",
- "format" : "date-time"
+ "settings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.settings"
+ }, {
+ "type" : "null"
+ } ]
},
- "common_name" : {
+ "timezone" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "id", "email", "first_name", "last_name", "date_joined", "last_login", "is_superuser", "is_qbnewb", "tenant_id", "is_data_analyst" ],
- "additionalProperties" : false
- },
- "metabase.users.schema.user-group-membership" : {
- "description" : "Group Membership info of a User.\n In which :is_group_manager is only included if `advanced-permissions` is enabled.",
- "type" : "object",
- "properties" : {
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
},
- "is_group_manager" : {
- "description" : "Only relevant if `advanced-permissions` is enabled. If it is, you should always include this key.",
- "type" : "boolean"
- }
- },
- "required" : [ "id" ],
- "additionalProperties" : false
- },
- "metabase.util.cron.CronHour" : {
- "type" : "integer",
- "minimum" : 0,
- "maximum" : 23
- },
- "metabase.util.cron.CronMinute" : {
- "type" : "integer",
- "minimum" : 0,
- "maximum" : 59
- },
- "metabase.util.cron.CronScheduleString" : {
- "description" : "value must be a valid Quartz cron schedule string.",
- "type" : "string",
- "minLength" : 1
- },
- "metabase.util.cron.ScheduleMap" : {
- "description" : "value must be a valid schedule map. See schema in metabase.util.cron for details.",
- "type" : "object",
- "properties" : {
- "schedule_day" : {
+ "metadata_sync_schedule" : {
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ]
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "schedule_frame" : {
+ "tables" : {
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "first", "mid", "last" ]
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema.schema.table"
+ }
}, {
"type" : "null"
} ]
},
- "schedule_hour" : {
+ "is_sample" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.util.cron.CronHour"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "schedule_minute" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ },
+ "dbms_version" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.util.cron.CronMinute"
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.dbms-version"
}, {
"type" : "null"
} ]
},
- "schedule_type" : {
- "type" : "string",
- "enum" : [ "hourly", "daily", "weekly", "monthly" ]
- }
- },
- "required" : [ "schedule_type" ],
- "additionalProperties" : false
- },
- "metabase.warehouse-schema-rest.api.table.data-authority-write" : {
- "description" : "Schema for writing a valid table data authority.",
- "type" : "string",
- "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
- },
- "metabase.warehouse-schema-rest.api.table.data-layers" : {
- "type" : "string",
- "enum" : [ "final", "internal", "hidden" ]
- },
- "metabase.warehouse-schema-rest.api.table.data-sources" : {
- "type" : "string",
- "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
- },
- "metabase.warehouse-schema.schema.table" : {
- "description" : "A Table as selected from the app DB: every column of `:metabase_table`.",
- "type" : "object",
- "properties" : {
- "points_of_interest" : {
+ "name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "transform_target" : {
- "type" : "boolean"
- },
- "is_writable" : {
+ "is_on_demand" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "is_upload" : {
- "type" : "boolean"
- },
- "is_defective_duplicate" : {
- "type" : "boolean"
- },
- "deactivated_at" : {
+ "updated_at" : {
"oneOf" : [ {
"type" : "string",
"format" : "date-time"
@@ -26629,28 +37248,35 @@
"type" : "null"
} ]
},
- "visibility_type" : {
+ "uploads_schema_name" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "data_authority" : {
- "anyOf" : [ {
- "type" : "string"
+ "cache_ttl" : {
+ "oneOf" : [ {
+ "type" : "integer"
}, {
- "type" : "string"
+ "type" : "null"
} ]
},
- "view_count" : {
- "type" : "integer"
+ "is_attached_dwh" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "data_layer" : {
+ "can-manage" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "engine" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
@@ -26661,84 +37287,86 @@
"type" : "null"
} ]
},
- "transform_id" : {
+ "router_database_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"type" : "null"
} ]
},
- "schema" : {
+ "uploads_table_prefix" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ "details" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.details"
+ }, {
+ "type" : "null"
+ } ]
},
- "unique_table_helper" : {
+ "created_at" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "string",
+ "format" : "date-time"
}, {
"type" : "null"
} ]
},
- "database_require_filter" : {
+ "is_full_sync" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "show_in_getting_started" : {
- "type" : "boolean"
- },
- "owner_email" : {
+ "can_upload" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "owner_user_id" : {
+ "auto_run_queries" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "name" : {
- "type" : "string"
- },
- "updated_at" : {
- "type" : "string",
- "format" : "date-time"
- },
- "display_name" : {
+ "caveats" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "archived_at" : {
+ "transforms_permissions" : {
"oneOf" : [ {
"type" : "string",
- "format" : "date-time"
+ "enum" : [ "write", "none" ]
}, {
"type" : "null"
} ]
},
- "collection_id" : {
+ "is_stub" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "data_source" : {
+ "admin_details" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouses.schema..database.admin-details"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "initial_sync_status" : {
"oneOf" : [ {
"anyOf" : [ {
"type" : "string"
@@ -26749,56 +37377,57 @@
"type" : "null"
} ]
},
- "is_published" : {
- "type" : "boolean"
- },
- "created_at" : {
- "type" : "string",
- "format" : "date-time"
- },
- "caveats" : {
+ "features" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
}, {
"type" : "null"
} ]
},
- "db_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- },
- "active" : {
- "type" : "boolean"
- },
- "estimated_row_count" : {
+ "creator_id" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
- "initial_sync_status" : {
- "anyOf" : [ {
- "type" : "string"
+ "refingerprint" : {
+ "oneOf" : [ {
+ "type" : "boolean"
}, {
- "type" : "string"
+ "type" : "null"
} ]
},
- "entity_type" : {
+ "schedules" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
+ "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"
+ }
+ },
+ "required" : [ "metadata_sync", "cache_field_values" ],
+ "additionalProperties" : false
}, {
"type" : "null"
} ]
},
- "field_order" : {
- "anyOf" : [ {
+ "router_user_attribute" : {
+ "oneOf" : [ {
"type" : "string"
}, {
- "type" : "string"
+ "type" : "null"
} ]
},
"description" : {
@@ -26807,44 +37436,18 @@
}, {
"type" : "null"
} ]
+ },
+ "is_audit" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "id", "created_at", "updated_at", "name", "description", "entity_type", "active", "db_id", "display_name", "visibility_type", "schema", "points_of_interest", "caveats", "show_in_getting_started", "field_order", "initial_sync_status", "is_upload", "database_require_filter", "estimated_row_count", "view_count", "deactivated_at", "archived_at", "is_writable", "data_authority", "data_source", "data_layer", "owner_email", "owner_user_id", "collection_id", "is_published", "transform_id", "transform_target" ],
+ "required" : [ "id" ],
"additionalProperties" : false
},
- "metabase.warehouses-rest.api.available-settings" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : {
- "enabled" : {
- "type" : "boolean"
- },
- "reasons" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "key" : {
- "type" : "string"
- },
- "message" : {
- "anyOf" : [ {
- "type" : "string"
- }, { } ]
- },
- "type" : {
- "type" : "string",
- "enum" : [ "error", "warning" ]
- }
- },
- "required" : [ "key", "type", "message" ]
- }
- }
- },
- "required" : [ "enabled" ]
- }
- },
"metabase.xrays.api.automagic-dashboards.base-64-encoded-json" : {
"description" : "form-encoded base-64-encoded JSON"
},
@@ -31611,8 +42214,7 @@
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
- "type" : "string",
- "enum" : [ "disabled", "enabled", "locked" ]
+ "enum" : [ "disabled", "enabled", "locked", "disabled", "enabled", "locked" ]
}
}, {
"description" : "Value must be a map."
@@ -32985,21 +43587,6 @@
"summary" : "GET /api/collection/root/items",
"description" : "Fetch objects that the current user should see at their root level. As mentioned elsewhere, the 'Root' Collection\n doesn't actually exist as a row in the application DB: it's simply a virtual Collection where things with no\n `collection_id` exist. It does, however, have its own set of Permissions.\n\n This endpoint will actually show objects with no `collection_id` for Users that have Root Collection\n permissions, but for people without Root Collection perms, we'll just show the objects that have an effective\n location of `/`.\n\n This endpoint is intended to power a 'Root Folder View' for the Current User, so regardless you'll see all the\n top-level objects you're allowed to access.\n\n By default, this will show the 'normal' Collections namespace; to view a different Collections namespace, such as\n `snippets`, you can pass the `?namespace=` parameter.\n\n By default, library collections are excluded from the results; to include them, pass `?include-library=true`.\n\n Pass `?q=` to filter items by name or last editor. Pass `?include-available-models=true` to include the models that\n have at least one visible item in the requested scope.\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
"parameters" : [ {
- "in" : "query",
- "name" : "models",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
- }
- }, {
- "type" : "null"
- } ]
- }
- }, {
"in" : "query",
"name" : "collection-type",
"required" : false,
@@ -33009,7 +43596,7 @@
}
}, {
"in" : "query",
- "name" : "archived",
+ "name" : "include-library",
"required" : false,
"schema" : {
"default" : false,
@@ -33021,19 +43608,30 @@
}
}, {
"in" : "query",
- "name" : "namespace",
+ "name" : "q",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "pinned-state",
"required" : false,
"schema" : {
"oneOf" : [ {
"type" : "string",
- "minLength" : 1
+ "enum" : [ "is_not_pinned", "is_pinned", "all" ]
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "include-library",
+ "name" : "archived",
"required" : false,
"schema" : {
"default" : false,
@@ -33045,45 +43643,44 @@
}
}, {
"in" : "query",
- "name" : "pinned-state",
+ "name" : "sort-direction",
"required" : false,
"schema" : {
"oneOf" : [ {
"type" : "string",
- "enum" : [ "is_not_pinned", "is_pinned", "all" ]
+ "enum" : [ "desc", "asc" ]
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "sort-column",
+ "name" : "show-dashboard-questions",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "model", "name", "last_edited_by", "last_edited_at", "description" ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "sort-direction",
+ "name" : "show-exploration-documents",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "desc", "asc" ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "official-collections-first",
+ "name" : "include-available-models",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
"type" : "boolean"
}, {
@@ -33092,32 +43689,36 @@
}
}, {
"in" : "query",
- "name" : "show-dashboard-questions",
+ "name" : "namespace",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "q",
+ "name" : "models",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
+ }
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "include-available-models",
+ "name" : "official-collections-first",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
"type" : "boolean"
}, {
@@ -33126,11 +43727,12 @@
}
}, {
"in" : "query",
- "name" : "show-exploration-documents",
+ "name" : "sort-column",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "enum" : [ "model", "name", "last_edited_by", "last_edited_at", "description" ]
}, {
"type" : "null"
} ]
@@ -33699,72 +44301,69 @@
}
}, {
"in" : "query",
- "name" : "models",
+ "name" : "q",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
- }
+ "type" : "string"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "archived",
+ "name" : "pinned-state",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "enum" : [ "is_not_pinned", "is_pinned", "all" ]
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "pinned-state",
+ "name" : "archived",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "is_not_pinned", "is_pinned", "all" ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "sort-column",
+ "name" : "sort-direction",
"required" : false,
"schema" : {
"oneOf" : [ {
"type" : "string",
- "enum" : [ "model", "name", "last_edited_by", "last_edited_at", "description" ]
+ "enum" : [ "desc", "asc" ]
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "sort-direction",
+ "name" : "show-dashboard-questions",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "desc", "asc" ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "official-collections-first",
+ "name" : "show-exploration-documents",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
"type" : "boolean"
}, {
@@ -33773,7 +44372,7 @@
}
}, {
"in" : "query",
- "name" : "show-dashboard-questions",
+ "name" : "include-available-models",
"required" : false,
"schema" : {
"default" : false,
@@ -33785,35 +44384,38 @@
}
}, {
"in" : "query",
- "name" : "show-exploration-documents",
+ "name" : "models",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
+ }
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "q",
+ "name" : "official-collections-first",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "include-available-models",
+ "name" : "sort-column",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "enum" : [ "model", "name", "last_edited_by", "last_edited_at", "description" ]
}, {
"type" : "null"
} ]
@@ -35739,8 +46341,7 @@
"oneOf" : [ {
"type" : "object",
"additionalProperties" : {
- "type" : "string",
- "enum" : [ "disabled", "enabled", "locked" ]
+ "enum" : [ "disabled", "enabled", "locked", "disabled", "enabled", "locked" ]
}
}, {
"description" : "Value must be a map."
@@ -36662,17 +47263,16 @@
"description" : "Fetch all `Databases`.\n\n * `include=tables` means we should hydrate the Tables belonging to each DB. Default: `false`.\n\n * `include=schemas` hydrates a `:schemas` list on each DB (only schemas with visible\n tables the current user can read), matching the per-DB `/api/database/:id/schemas`\n response. Lets clients avoid N round-trips when populating a database/schema picker.\n\n * `saved` means we should include the saved questions virtual database. Default: `false`.\n\n * `include_editable_data_model` will only include DBs for which the current user has data model editing\n permissions. (If `include=tables`, this also applies to the list of tables in each DB). Should only be used if\n Enterprise Edition code is available the advanced-permissions feature is enabled.\n\n * `exclude_uneditable_details` will only include DBs for which the current user can edit the DB details. Has no\n effect unless Enterprise Edition code is available and the advanced-permissions feature is enabled.\n\n * `include_only_uploadable` will only include DBs into which Metabase can insert new data.\n\n * `can-query` will only include DBs for which the current user has query permissions. Default: `false`.\n\n * `can-write-metadata` will only include DBs for which the current user has data model editing permissions\n for at least one table in the database. Default: `false`.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for\n `:model/Database` in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user\n lacks permission to change the database details.",
"parameters" : [ {
"in" : "query",
- "name" : "include",
+ "name" : "saved",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "tables", "schemas" ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
- },
- "description" : "include must be either empty, 'tables', or 'schemas'"
+ }
}, {
"in" : "query",
"name" : "include_analytics",
@@ -36687,7 +47287,7 @@
}
}, {
"in" : "query",
- "name" : "saved",
+ "name" : "include_only_uploadable",
"required" : false,
"schema" : {
"default" : false,
@@ -36699,34 +47299,35 @@
}
}, {
"in" : "query",
- "name" : "include_editable_data_model",
+ "name" : "include",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "enum" : [ "tables", "schemas" ]
}, {
"type" : "null"
} ]
- }
+ },
+ "description" : "include must be either empty, 'tables', or 'schemas'"
}, {
"in" : "query",
- "name" : "exclude_uneditable_details",
+ "name" : "router_database_id",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "include_only_uploadable",
+ "name" : "can-write-metadata",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
"type" : "boolean"
}, {
@@ -36735,22 +47336,21 @@
}
}, {
"in" : "query",
- "name" : "router_database_id",
+ "name" : "can-query",
"required" : false,
"schema" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "can-query",
+ "name" : "exclude_uneditable_details",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
"type" : "boolean"
}, {
@@ -36759,9 +47359,10 @@
}
}, {
"in" : "query",
- "name" : "can-write-metadata",
+ "name" : "include_editable_data_model",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
"type" : "boolean"
}, {
@@ -42416,6 +53017,13 @@
"summary" : "GET /api/ee/dependencies/graph/dependents",
"description" : "Returns a list of dependents for the specified entity.\n\n Required parameters:\n - `id`: The ID of the entity\n - `type`: The type of the entity (card, table, dashboard, etc.)\n\n Optional parameters:\n - `dependent-types`: Dependency types to filter by. Can be single value or array.\n If not provided, returns all types. Example: ?dependent-types=card&dependent-types=dashboard\n - `dependent-card-types`: Card types to filter by when dependent-types includes :card.\n Ignored if dependent-types doesn't include :card. Example: ?dependent-card-types=question&dependent-card-types=model\n - `broken`: Return only broken entities (default: false)\n - `query`: Search string to filter results by name or location (case-insensitive)\n - `include-personal-collections`: Include items in personal collections (default: false)\n - `sort-column`: Column to sort by - name, location, or view-count (default: name)\n - `sort-direction`: Sort direction - asc or desc (default: asc)",
"parameters" : [ {
+ "in" : "query",
+ "name" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
"in" : "query",
"name" : "id",
"required" : true,
@@ -42424,6 +53032,21 @@
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "sort-direction",
+ "required" : false,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "desc", "asc" ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "broken",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
}, {
"in" : "query",
"name" : "type",
@@ -42431,6 +53054,13 @@
"schema" : {
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
}
+ }, {
+ "in" : "query",
+ "name" : "include-personal-collections",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
}, {
"in" : "query",
"name" : "dependent-types",
@@ -42461,27 +53091,6 @@
}
} ]
}
- }, {
- "in" : "query",
- "name" : "broken",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "query",
- "required" : false,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "include-personal-collections",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
}, {
"in" : "query",
"name" : "sort-column",
@@ -42490,14 +53099,6 @@
"type" : "string",
"enum" : [ "name", "view-count", "location" ]
}
- }, {
- "in" : "query",
- "name" : "sort-direction",
- "required" : false,
- "schema" : {
- "type" : "string",
- "enum" : [ "desc", "asc" ]
- }
} ],
"responses" : {
"2XX" : {
@@ -50110,7 +60711,7 @@
}, {
"type" : "string",
"format" : "uuid"
- }, { } ]
+ }, { }, { } ]
}, {
"type" : "null"
} ]
@@ -50130,7 +60731,7 @@
}, {
"type" : "string",
"format" : "uuid"
- }, { } ]
+ }, { }, { } ]
}, {
"type" : "null"
} ]
@@ -52536,7 +63137,7 @@
}, {
"type" : "string",
"format" : "uuid"
- }, { } ]
+ }, { }, { } ]
}, {
"type" : "null"
} ]
@@ -52556,7 +63157,7 @@
}, {
"type" : "string",
"format" : "uuid"
- }, { } ]
+ }, { }, { } ]
}, {
"type" : "null"
} ]
@@ -54941,7 +65542,7 @@
}, {
"type" : "string",
"format" : "uuid"
- }, { } ]
+ }, { }, { } ]
}, {
"type" : "null"
} ]
@@ -54961,7 +65562,7 @@
}, {
"type" : "string",
"format" : "uuid"
- }, { } ]
+ }, { }, { } ]
}, {
"type" : "null"
} ]
@@ -55812,27 +66413,23 @@
"description" : "List card-type notifications (alerts) for admin management. Supports pagination (`limit` +\n `offset` query params — handled by the offset-paging middleware), filtering, and sorting.\n\n `last_send_status` filter operates on the latest channel-send task_history row for the\n notification (`successful` = latest channel-send succeeded; `failing` = latest channel-send\n failed).\n\n `last_check_status` filter operates on the latest terminal TaskRun for the notification — the\n whole-run rollup (`successful` = the run succeeded; `failing` = it failed or was abandoned). This\n is a superset of `last_send_status`: it also catches query failures and heartbeat-abandoned runs\n that never reached the send step. The Failing tab uses `?last_check_status=failing`.\n\n `creatorless=true` selects notifications with no creator or a deactivated creator (the Ownerless\n tab). `creatorless=false` selects the inverse.\n\n `channel` accepts a single string or a repeated query param for multi-select (OR logic).",
"parameters" : [ {
"in" : "query",
- "name" : "active",
+ "name" : "recipient_email",
"required" : false,
"schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "type" : "string",
+ "minLength" : 1
}
}, {
"in" : "query",
- "name" : "creator_id",
+ "name" : "query",
"required" : false,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "type" : "string",
+ "minLength" : 1
+ }
}, {
"in" : "query",
- "name" : "creator_active",
+ "name" : "creatorless",
"required" : false,
"schema" : {
"oneOf" : [ {
@@ -55843,7 +66440,14 @@
}
}, {
"in" : "query",
- "name" : "creatorless",
+ "name" : "last_check_status",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"
+ }
+ }, {
+ "in" : "query",
+ "name" : "creator_active",
"required" : false,
"schema" : {
"oneOf" : [ {
@@ -55863,11 +66467,10 @@
"description" : "value must be an integer greater than zero."
}, {
"in" : "query",
- "name" : "recipient_email",
+ "name" : "last_send_status",
"required" : false,
"schema" : {
- "type" : "string",
- "minLength" : 1
+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"
}
}, {
"in" : "query",
@@ -55891,34 +66494,32 @@
}
}, {
"in" : "query",
- "name" : "last_send_status",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"
- }
- }, {
- "in" : "query",
- "name" : "last_check_status",
+ "name" : "active",
"required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "query",
+ "name" : "sort_column",
"required" : false,
"schema" : {
- "type" : "string",
- "minLength" : 1
+ "default" : "last_send",
+ "$ref" : "#/components/schemas/metabase.notification.api.admin.sort-column"
}
}, {
"in" : "query",
- "name" : "sort_column",
+ "name" : "creator_id",
"required" : false,
"schema" : {
- "default" : "last_send",
- "$ref" : "#/components/schemas/metabase.notification.api.admin.sort-column"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
}, {
"in" : "query",
"name" : "sort_direction",
@@ -56578,34 +67179,7 @@
"type" : "object",
"properties" : {
"ai_context" : {
- "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
+ "$ref" : "#/components/schemas/metabase.osi.schema..osi-ai-context.ai-context"
},
"entity_local_id" : {
"type" : "integer"
@@ -56731,34 +67305,7 @@
"type" : "object",
"properties" : {
"ai_context" : {
- "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
+ "$ref" : "#/components/schemas/metabase.osi.schema..osi-ai-context.ai-context"
},
"entity_local_id" : {
"type" : "integer"
@@ -56812,34 +67359,7 @@
"type" : "object",
"properties" : {
"ai_context" : {
- "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
+ "$ref" : "#/components/schemas/metabase.osi.schema..osi-ai-context.ai-context"
},
"entity_local_id" : {
"type" : "integer"
@@ -56867,34 +67387,7 @@
"type" : "object",
"properties" : {
"ai_context" : {
- "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
+ "$ref" : "#/components/schemas/metabase.osi.schema..osi-ai-context.ai-context"
}
},
"required" : [ "ai_context" ],
@@ -57918,7 +68411,7 @@
}, {
"type" : "string",
"format" : "uuid"
- }, { } ]
+ }, { }, { } ]
}, {
"type" : "null"
} ]
@@ -57938,7 +68431,7 @@
}, {
"type" : "string",
"format" : "uuid"
- }, { } ]
+ }, { }, { } ]
}, {
"type" : "null"
} ]
@@ -60439,32 +70932,24 @@
"description" : "Search for items in Metabase.\n For the list of supported models, check [[metabase.search.config/all-models]].\n\n `context` identifies the surface issuing the search; it selects the ranking weights and filter defaults.\n It defaults to `api`, the value for programmatic callers.\n\n Filters:\n - `archived`: set to true to search archived items only, default is false\n - `table_db_id`: search for tables, cards, and models of a certain DB\n - `models`: only search for items of specific models. If not provided, search for all models\n - `filter_items_in_personal_collection`: only search for items in personal collections\n - `created_at`: search for items created at a specific timestamp\n - `created_by`: search for items created by a specific user\n - `last_edited_at`: search for items last edited at a specific timestamp\n - `last_edited_by`: search for items last edited by a specific user\n - `search_native_query`: set to true to search the content of native queries\n - `vector_search_strategy`: for the semantic engine: `hnsw` (approximate index search, default),\n `brute-force` (exact filter-first search), or `hnsw-iterative-relaxed` / `hnsw-iterative-strict`\n (index-backed iterative scans with inline filters); ignored by other engines\n - `vector_search_ef_search`: override pgvector's `hnsw.ef_search` (1-1000) for the iterative strategies; (admin only)\n - `vector_search_max_scan_tuples`: override pgvector's `hnsw.max_scan_tuples` for the iterative strategies; (admin only)\n - `vector_search_explain`: set to true to record vector-scan instrumentation for this search (expensive); (admin only)\n - `verified`: set to true to search for verified items only (requires Content Management or Official Collections premium feature)\n - `ids`: search for items with those ids, works iff single value passed to `models`\n - `display_type`: search for cards/models with specific display types\n\n Note that not all item types support all filters, and the results will include only models that support the provided\n filters. For example:\n\n - The `created-by` filter supports dashboards, models, actions, and cards.\n - The `verified` filter supports models and cards.\n\n A search query that has both filters applied will only return models and cards.",
"parameters" : [ {
"in" : "query",
- "name" : "q",
+ "name" : "vector_search_ef_search",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer",
+ "minimum" : 1,
+ "maximum" : 1000
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "context",
- "required" : false,
- "schema" : {
- "default" : "api",
- "type" : "string",
- "enum" : [ "basic-actions", "browse", "command-palette", "data-picker", "dependencies", "document", "embedding-setup", "entity-picker", "library", "model-migration", "search-app", "search-bar", "type-filter", "api", "metabot" ]
- }
- }, {
- "in" : "query",
- "name" : "archived",
+ "name" : "q",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
@@ -60484,27 +70969,26 @@
}
}, {
"in" : "query",
- "name" : "table_db_id",
+ "name" : "vector_search_explain",
"required" : false,
"schema" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "models",
+ "name" : "created_by",
"required" : false,
"schema" : {
"oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}
}, {
"type" : "null"
@@ -60512,31 +70996,19 @@
}
}, {
"in" : "query",
- "name" : "filter_items_in_personal_collection",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "all", "only", "only-mine", "exclude", "exclude-others" ]
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "created_at",
+ "name" : "include_metadata",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "created_by",
+ "name" : "ids",
"required" : false,
"schema" : {
"oneOf" : [ {
@@ -60552,27 +71024,23 @@
}
}, {
"in" : "query",
- "name" : "display_type",
+ "name" : "archived",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
- }
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "last_edited_at",
+ "name" : "verified",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -60593,6 +71061,27 @@
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "context",
+ "required" : false,
+ "schema" : {
+ "default" : "api",
+ "type" : "string",
+ "enum" : [ "basic-actions", "browse", "command-palette", "data-picker", "dependencies", "document", "embedding-setup", "entity-picker", "library", "model-migration", "search-app", "search-bar", "type-filter", "api", "metabot" ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "vector_search_strategy",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "hnsw", "brute-force", "hnsw-iterative-relaxed", "hnsw-iterative-strict" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
}, {
"in" : "query",
"name" : "model_ancestors",
@@ -60607,60 +71096,65 @@
}
}, {
"in" : "query",
- "name" : "search_engine",
+ "name" : "calculate_available_models",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "vector_search_strategy",
+ "name" : "display_type",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "hnsw", "brute-force", "hnsw-iterative-relaxed", "hnsw-iterative-strict" ]
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "minLength" : 1
+ }
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "vector_search_ef_search",
+ "name" : "created_at",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "integer",
- "minimum" : 1,
- "maximum" : 1000
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "vector_search_max_scan_tuples",
+ "name" : "models",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "integer",
- "minimum" : 1,
- "maximum" : 2147483647
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ }
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "vector_search_explain",
+ "name" : "last_edited_at",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
@@ -60678,62 +71172,61 @@
}
}, {
"in" : "query",
- "name" : "verified",
+ "name" : "table_db_id",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "ids",
+ "name" : "include_dashboard_questions",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "calculate_available_models",
+ "name" : "vector_search_max_scan_tuples",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "integer",
+ "minimum" : 1,
+ "maximum" : 2147483647
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "include_dashboard_questions",
+ "name" : "filter_items_in_personal_collection",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "enum" : [ "all", "only", "only-mine", "exclude", "exclude-others" ]
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "include_metadata",
+ "name" : "search_engine",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
@@ -60760,32 +71253,32 @@
"description" : "Superuser-only. Explain why `expected_result_id` / `expected_result_type` does not appear in the results of\n the given search query. Accepts every `GET /api/search` parameter plus the two expected-result parameters, and\n returns `{:type ..., :details ...}` for the first stage that drops the item: `not-searchable`,\n `missing-from-index`, `not-permitted`, `filtered`, `not-matching`, or the terminal `matched` / `ranked-out`.\n\n - `for_user_id`: diagnose from another user's perspective (defaults to you). Permission and visibility checks run\n as that user, so a `not-permitted` result means *they* can't see the item.\n\n Not supported for `indexed-entity` (its id is compound).",
"parameters" : [ {
"in" : "query",
- "name" : "q",
+ "name" : "vector_search_ef_search",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer",
+ "minimum" : 1,
+ "maximum" : 1000
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "context",
- "required" : false,
+ "name" : "expected_result_type",
+ "required" : true,
"schema" : {
- "default" : "api",
"type" : "string",
- "enum" : [ "basic-actions", "browse", "command-palette", "data-picker", "dependencies", "document", "embedding-setup", "entity-picker", "library", "model-migration", "search-app", "search-bar", "type-filter", "api", "metabot" ]
+ "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
}
}, {
"in" : "query",
- "name" : "archived",
+ "name" : "q",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
@@ -60805,27 +71298,26 @@
}
}, {
"in" : "query",
- "name" : "table_db_id",
+ "name" : "vector_search_explain",
"required" : false,
"schema" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "models",
+ "name" : "created_by",
"required" : false,
"schema" : {
"oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}
}, {
"type" : "null"
@@ -60833,31 +71325,19 @@
}
}, {
"in" : "query",
- "name" : "filter_items_in_personal_collection",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "all", "only", "only-mine", "exclude", "exclude-others" ]
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "created_at",
+ "name" : "include_metadata",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "created_by",
+ "name" : "ids",
"required" : false,
"schema" : {
"oneOf" : [ {
@@ -60873,27 +71353,23 @@
}
}, {
"in" : "query",
- "name" : "display_type",
+ "name" : "archived",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
- }
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "last_edited_at",
+ "name" : "verified",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -60916,121 +71392,144 @@
}
}, {
"in" : "query",
- "name" : "model_ancestors",
+ "name" : "context",
+ "required" : false,
+ "schema" : {
+ "default" : "api",
+ "type" : "string",
+ "enum" : [ "basic-actions", "browse", "command-palette", "data-picker", "dependencies", "document", "embedding-setup", "entity-picker", "library", "model-migration", "search-app", "search-bar", "type-filter", "api", "metabot" ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "vector_search_strategy",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "enum" : [ "hnsw", "brute-force", "hnsw-iterative-relaxed", "hnsw-iterative-strict" ]
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "search_engine",
+ "name" : "model_ancestors",
"required" : false,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "vector_search_strategy",
+ "name" : "calculate_available_models",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "hnsw", "brute-force", "hnsw-iterative-relaxed", "hnsw-iterative-strict" ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "vector_search_ef_search",
+ "name" : "display_type",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "integer",
- "minimum" : 1,
- "maximum" : 1000
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "minLength" : 1
+ }
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "vector_search_max_scan_tuples",
+ "name" : "expected_result_id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "created_at",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "integer",
- "minimum" : 1,
- "maximum" : 2147483647
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "vector_search_explain",
+ "name" : "for_user_id",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "search_native_query",
+ "name" : "models",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ }
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "verified",
+ "name" : "last_edited_at",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "ids",
+ "name" : "search_native_query",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "calculate_available_models",
+ "name" : "table_db_id",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
@@ -61049,42 +71548,36 @@
}
}, {
"in" : "query",
- "name" : "include_metadata",
+ "name" : "vector_search_max_scan_tuples",
"required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "integer",
+ "minimum" : 1,
+ "maximum" : 2147483647
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "expected_result_type",
- "required" : true,
+ "name" : "filter_items_in_personal_collection",
+ "required" : false,
"schema" : {
- "type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "all", "only", "only-mine", "exclude", "exclude-others" ]
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "expected_result_id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "query",
- "name" : "for_user_id",
+ "name" : "search_engine",
"required" : false,
"schema" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
@@ -62723,14 +73216,14 @@
"description" : "Get all `Tables`.\n\n Optional filters:\n - `can-query=true` - filter to only tables the user can execute queries against\n - `can-write=true` - filter to only tables the user can edit metadata for",
"parameters" : [ {
"in" : "query",
- "name" : "term",
+ "name" : "visibility-type",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
- "name" : "visibility-type",
+ "name" : "term",
"required" : false,
"schema" : {
"type" : "string"
@@ -62744,18 +73237,11 @@
}
}, {
"in" : "query",
- "name" : "data-source",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-sources"
- }
- }, {
- "in" : "query",
- "name" : "owner-user-id",
+ "name" : "published-only",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "integer"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -62769,7 +73255,7 @@
}
}, {
"in" : "query",
- "name" : "orphan-only",
+ "name" : "include-transform-targets",
"required" : false,
"schema" : {
"oneOf" : [ {
@@ -62780,18 +73266,25 @@
}
}, {
"in" : "query",
- "name" : "unused-only",
+ "name" : "owner-user-id",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "integer"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "published-only",
+ "name" : "data-source",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-sources"
+ }
+ }, {
+ "in" : "query",
+ "name" : "can-write",
"required" : false,
"schema" : {
"oneOf" : [ {
@@ -62802,7 +73295,7 @@
}
}, {
"in" : "query",
- "name" : "can-query",
+ "name" : "orphan-only",
"required" : false,
"schema" : {
"oneOf" : [ {
@@ -62813,7 +73306,7 @@
}
}, {
"in" : "query",
- "name" : "can-write",
+ "name" : "can-query",
"required" : false,
"schema" : {
"oneOf" : [ {
@@ -62824,7 +73317,7 @@
}
}, {
"in" : "query",
- "name" : "include-transform-targets",
+ "name" : "unused-only",
"required" : false,
"schema" : {
"oneOf" : [ {
@@ -67556,47 +78049,39 @@
"description" : "Get transform runs based on a set of filter params.",
"parameters" : [ {
"in" : "query",
- "name" : "sort-column",
- "required" : false,
- "schema" : {
- "type" : "string",
- "enum" : [ "transform-name", "start-time", "end-time", "status", "run-method", "transform-tags", "duration" ]
- }
- }, {
- "in" : "query",
- "name" : "sort-direction",
+ "name" : "run-methods",
"required" : false,
"schema" : {
- "type" : "string",
- "enum" : [ "asc", "desc" ]
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "manual", "cron" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "transform-ids",
+ "name" : "end-time",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "statuses",
+ "name" : "start-time",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string",
- "enum" : [ "started", "succeeded", "failed", "timeout" ]
- }
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
@@ -67619,38 +78104,35 @@
}
}, {
"in" : "query",
- "name" : "start-time",
+ "name" : "sort-direction",
"required" : false,
"schema" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
+ "type" : "string",
+ "enum" : [ "asc", "desc" ]
}
}, {
"in" : "query",
- "name" : "end-time",
+ "name" : "user-id",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "run-methods",
+ "name" : "statuses",
"required" : false,
"schema" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "manual", "cron" ]
+ "enum" : [ "started", "succeeded", "failed", "timeout" ]
}
}, {
"type" : "null"
@@ -67658,17 +78140,28 @@
}
}, {
"in" : "query",
- "name" : "user-id",
+ "name" : "transform-ids",
"required" : false,
"schema" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
}, {
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "sort-column",
+ "required" : false,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "transform-name", "start-time", "end-time", "status", "run-method", "transform-tags", "duration" ]
+ }
} ],
"responses" : {
"2XX" : {