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

github-automation-metabased225a5f8d0f2
diff --git a/docs/api.json b/docs/api.json
index d82609517cf..b3e5e45ea9d 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -1079,8 +1079,17 @@
"type" : "null"
} ]
},
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
"include-current" : {
"type" : "boolean"
+ },
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
},
"required" : [ "lib/uuid" ]
@@ -1145,7 +1154,7 @@
} ]
},
"metabase-enterprise.action-v2.api.api-action-expression" : {
- "description" : "A more relaxed version of ::action-expression that can still have opaque identifiers inside inside.",
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -2998,15 +3007,49 @@
},
"metabase.actions.schema..action.for-insert" : {
"description" : "Schema for inserting a new Action (REST API or internally).",
- "allOf" : [ {
+ "oneOf" : [ {
"type" : "object",
"properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "response_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
"archived" : {
"type" : "boolean"
},
- "description" : {
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.type"
+ },
+ "template" : {
"oneOf" : [ {
- "type" : "string"
+ "$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"
} ]
@@ -3014,8 +3057,31 @@
"model_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
- "name" : {
- "type" : "string"
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name", "type", "model_id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
},
"parameter_mappings" : {
"oneOf" : [ {
@@ -3024,6 +3090,25 @@
"type" : "null"
} ]
},
+ "name" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "kind" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.type"
+ },
+ "model_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
"parameters" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
@@ -3031,34 +3116,166 @@
"type" : "null"
} ]
},
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name", "type", "model_id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "database_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "type" : "null"
+ } ]
+ },
"type" : {
"$ref" : "#/components/schemas/metabase.actions.schema.type"
},
+ "model_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name", "type", "model_id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
"visualization_settings" : {
"oneOf" : [ {
"type" : "object"
}, {
"type" : "null"
} ]
+ },
+ "response_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "database_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "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"
+ } ]
+ },
+ "model_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
"required" : [ "name", "type", "model_id" ]
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema.http-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.implicit-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.query-action"
- }, {
- "type" : "object",
- "properties" : { }
- } ]
} ]
},
"metabase.actions.schema..action.for-update" : {
"description" : "Schema for updating an Action (REST API or internally).",
- "allOf" : [ {
+ "oneOf" : [ {
"type" : "object",
"properties" : {
"visualization_settings" : {
@@ -3068,6 +3285,13 @@
"type" : "null"
} ]
},
+ "response_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
@@ -3087,6 +3311,20 @@
"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"
+ } ]
+ },
"model_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
@@ -3106,16 +3344,209 @@
}
}
}, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema.http-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.implicit-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.query-action"
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "kind" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.type"
+ },
+ "model_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }, {
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "database_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.type"
+ },
+ "model_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }, {
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "response_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "database_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "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"
+ } ]
+ },
+ "model_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
} ]
},
"metabase.actions.schema..http-action.json-query" : {
@@ -3164,7 +3595,7 @@
},
"metabase.actions.schema.action" : {
"description" : "An Action as it should appear when we `SELECT` it from the app DB.",
- "allOf" : [ {
+ "oneOf" : [ {
"type" : "object",
"properties" : {
"visualization_settings" : {
@@ -3174,6 +3605,13 @@
"type" : "null"
} ]
},
+ "response_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
@@ -3201,6 +3639,20 @@
"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" : [ {
@@ -3238,80 +3690,294 @@
},
"required" : [ "id" ]
}, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema.http-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.implicit-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.query-action"
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- } ]
- },
- "metabase.actions.schema.http-action" : {
- "type" : "object",
- "properties" : {
- "error_handle" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
- }, {
- "type" : "null"
- } ]
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ },
+ "made_public_by_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "updated_at" : { },
+ "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" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "response_handle" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
- }, {
- "type" : "null"
- } ]
+ "required" : [ "id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ },
+ "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" : { },
+ "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" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema..http-action.template"
- }, {
- "type" : "null"
- } ]
- }
- }
+ "required" : [ "id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "response_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ },
+ "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" : { },
+ "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"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ]
+ } ]
},
"metabase.actions.schema.id" : {
"description" : "Valid Action ID",
"type" : "integer",
"minimum" : 1
},
- "metabase.actions.schema.implicit-action" : {
- "type" : "object",
- "properties" : {
- "kind" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
- }, {
- "type" : "null"
- } ]
- }
- }
- },
- "metabase.actions.schema.query-action" : {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- }, {
- "type" : "null"
- } ]
- },
- "dataset_query" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
- }, {
- "type" : "null"
- } ]
- }
- }
- },
"metabase.actions.schema.type" : {
"description" : "Unsupported action type",
"type" : "string",
@@ -3435,7 +4101,7 @@
"additionalProperties" : false
},
"metabase.agent-api.api.construct-query-request" : {
- "description" : "Request body for /v2/construct-query and the fresh-query branch of /v2/query.\n A single `:query` key whose value is a JSON object matching\n [[metabase.lib.schema/external-query]] — the canonical portable MBQL 5 wire format. The\n query is fully self-describing: the database is derived from the first stage's\n `source-table:` or `source-card:`, all field references are portable FKs\n (`[<db-name>, <schema>, <table-name>, <column-name>]`), and there is no auxiliary\n `source_entity` / `referenced_entities` envelope. See\n `resources/metabot/prompts/tools/construct_notebook_query.md` for the full format reference\n (including operators, joins, expressions, multi-stage queries, and FK conventions).\n\n Closed map: any extra top-level keys (notably the legacy `source_entity` /\n `referenced_entities` envelope from before the repr migration) are rejected with a 400 so\n callers don't silently send fields the server ignores.\n\n The inner `:query` value is intentionally typed as a plain `:map` at this boundary rather\n than `::lib.schema/external-query`. Reasons:\n\n 1. Deep MBQL-shape validation runs inside the representations pipeline\n (`metabot.tools.construct/execute-representations-query` calls `repr/validate-query`\n after the repair pass), so the boundary check would be redundant.\n\n 2. The strict-tool manifest lint (`assert-optional-fields-nullable!`) walks every map\n reachable from the tool input schema. `::external-query` references `::query`, which\n carries several `:optional` keys (`:lib/metadata`, `:database`, `:settings`, …) that\n are not `[:maybe ...]` — for sound reasons unrelated to this endpoint. Recursing into\n them would force a wide schema change just to satisfy the lint at the agent boundary.",
+ "description" : "Request body for /v2/construct-query and the fresh-query branch of /v2/query.\n A single `:query` key whose value is a JSON object matching\n [[metabase.lib.schema/external-query]] — the canonical portable MBQL 5 wire format. The\n query is fully self-describing: the database is derived from the first stage's\n `source-table:` or `source-card:`, all field references are portable FKs\n (`[<db-name>, <schema>, <table-name>, <column-name>]`), and there is no auxiliary\n `source_entity` / `referenced_entities` envelope. See\n `resources/metabot/prompts/tools/construct_notebook_query.md` for the full format reference\n (including operators, joins, expressions, multi-stage queries, and FK conventions).\n\n Closed map: any extra top-level keys (notably the legacy `source_entity` /\n `referenced_entities` envelope from before the repr migration) are dropped during request\n decoding, so a caller still sending the old shape is served.\n\n The inner `:query` value is intentionally typed as an open map ([[ms/Map]]) at this boundary\n rather than `::lib.schema/external-query`. Being open matters: a closed map with no declared\n entries would have every key stripped before the handler saw it. Reasons for not naming the\n real schema:\n\n 1. Deep MBQL-shape validation runs inside the representations pipeline\n (`metabot.tools.construct/execute-representations-query` calls `repr/validate-query`\n after the repair pass), so the boundary check would be redundant.\n\n 2. The strict-tool manifest lint (`assert-optional-fields-nullable!`) walks every map\n reachable from the tool input schema. `::external-query` references `::query`, which\n carries several `:optional` keys (`:lib/metadata`, `:database`, `:settings`, …) that\n are not `[:maybe ...]` — for sound reasons unrelated to this endpoint. Recursing into\n them would force a wide schema change just to satisfy the lint at the agent boundary.",
"type" : "object",
"properties" : {
"prompt" : {
@@ -3448,6 +4114,7 @@
} ]
},
"query" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}
@@ -3662,6 +4329,7 @@
},
"visualization_settings" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -3747,6 +4415,7 @@
},
"visualization_settings" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -3849,6 +4518,9 @@
"action" : {
"const" : "add_heading"
},
+ "display_size" : {
+ "type" : "null"
+ },
"tab_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -4014,7 +4686,7 @@
"required" : [ "database_id", "sql" ]
},
"metabase.agent-api.api.query-request" : {
- "description" : "Request body for /v2/query, one of three shapes:\n - `{:continuation_token <string>}` from a prior response (pagination);\n - `{:query <base64-string>}` — a query_handle resolved by the MCP layer to its stored base64\n MBQL; already resolved, so it's executed directly (like /v1/execute) rather than re-run\n through the representations pipeline;\n - `{:query <external-query-object>}` — a fresh portable MBQL 5 payload, same shape as\n /v2/construct-query.\n\n The string-vs-object `:query` distinction is what the `:dispatch` keys on. Each branch is a\n closed map: extra top-level keys (e.g. the legacy `source_entity` / `referenced_entities`\n envelope, or sending `:query` and `:continuation_token` simultaneously) are rejected with a 400.",
+ "description" : "Request body for /v2/query, one of three shapes:\n - `{:continuation_token <string>}` from a prior response (pagination);\n - `{:query <base64-string>}` — a query_handle resolved by the MCP layer to its stored base64\n MBQL; already resolved, so it's executed directly (like /v1/execute) rather than re-run\n through the representations pipeline;\n - `{:query <external-query-object>}` — a fresh portable MBQL 5 payload, same shape as\n /v2/construct-query.\n\n The string-vs-object `:query` distinction is what the `:dispatch` keys on. Each branch is a\n closed map, so top-level keys it doesn't declare (e.g. the legacy `source_entity` /\n `referenced_entities` envelope, or a `:query` sent alongside a `:continuation_token`) are\n dropped before the handler runs.",
"oneOf" : [ {
"type" : "object",
"properties" : {
@@ -4389,6 +5061,7 @@
},
"visualization_settings" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -4490,6 +5163,7 @@
},
"visualization_settings" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -4581,40 +5255,16 @@
"minLength" : 7,
"maxLength" : 7
},
- "metabase.cache.api..cache-strategy.base.ee" : {
- "type" : "object",
- "properties" : {
- "type" : {
- "type" : "string",
- "enum" : [ "nocache", "ttl", "duration", "schedule" ]
- }
- },
- "required" : [ "type" ]
- },
- "metabase.cache.api..cache-strategy.base.oss" : {
- "type" : "object",
- "properties" : {
- "type" : {
- "type" : "string",
- "enum" : [ "nocache", "ttl" ]
- }
- },
- "required" : [ "type" ]
- },
"metabase.cache.api..cache-strategy.ee" : {
- "description" : "Schema for a caching strategy in EE when we have an premium token with `:cache-granular-controls`.",
- "allOf" : [ {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.base.ee"
+ "description" : "cache strategy :type must be one of :nocache, :ttl, :duration, :schedule",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.nocache"
}, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.nocache"
- }, {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ttl"
- }, {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee.duration"
- }, {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee.schedule"
- } ]
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ttl"
+ }, {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee.duration"
+ }, {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee.schedule"
} ]
},
"metabase.cache.api..cache-strategy.ee.duration" : {
@@ -4666,6 +5316,13 @@
"metabase.cache.api..cache-strategy.nocache" : {
"type" : "object",
"properties" : {
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"type" : {
"const" : "nocache"
}
@@ -4673,15 +5330,11 @@
"required" : [ "type" ]
},
"metabase.cache.api..cache-strategy.oss" : {
- "description" : "Schema for a caching strategy (OSS)",
- "allOf" : [ {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.base.oss"
+ "description" : "cache strategy :type must be one of :nocache, :ttl",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.nocache"
}, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.nocache"
- }, {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ttl"
- } ]
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ttl"
} ]
},
"metabase.cache.api..cache-strategy.ttl" : {
@@ -4860,6 +5513,7 @@
} ]
},
"details" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -4880,13 +5534,31 @@
"channel_type" : { },
"details" : {
"$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateEmailDetails"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
}
},
"required" : [ "channel_type", "details" ]
}, {
"type" : "object",
"properties" : {
- "channel_type" : { }
+ "channel_type" : { },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ }
},
"required" : [ "channel_type" ]
} ]
@@ -4955,13 +5627,31 @@
"channel_type" : { },
"details" : {
"$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateEmailDetailsUserProvided"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
}
},
"required" : [ "channel_type", "details" ]
}, {
"type" : "object",
"properties" : {
- "channel_type" : { }
+ "channel_type" : { },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ }
},
"required" : [ "channel_type" ]
} ]
@@ -5569,6 +6259,7 @@
"minLength" : 1
},
"settings" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -5625,29 +6316,58 @@
"oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "object",
- "properties" : {
- "dimension_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_value" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "dimension_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_value" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "field_ref" : {
+ "type" : "array",
+ "items" : { }
+ },
+ "operator" : {
+ "const" : "="
+ },
+ "value" : { }
},
- "field_ref" : {
- "type" : "array",
- "items" : { }
+ "required" : [ "operator", "field_ref", "value", "display_value" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "dimension_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_value" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "field_ref" : {
+ "type" : "array",
+ "items" : { }
+ },
+ "operator" : {
+ "const" : "between"
+ },
+ "values" : {
+ "type" : "array",
+ "prefixItems" : [ { }, { } ]
+ }
},
- "value" : { }
- },
- "required" : [ "field_ref", "value" ]
+ "required" : [ "operator", "field_ref", "values", "display_value" ]
+ } ]
}
}, {
"type" : "null"
@@ -6211,7 +6931,7 @@
},
"status" : {
"type" : "string",
- "enum" : [ "pending", "running", "canceled", "empty", "failed", "completed" ]
+ "enum" : [ "pending", "running", "canceled", "empty", "failed", "completed", "forbidden" ]
},
"source_page_id" : {
"oneOf" : [ {
@@ -6535,266 +7255,6 @@
},
"required" : [ "kind", "style", "columns" ]
},
- "metabase.legacy-mbql.schema.-" : {
- "description" : "schema for a valid MBQL 4 :- clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema..NativeQuery.Common" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "collection" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "template-tags" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagMap"
- }
- }
- }, {
- "allOf" : [ ]
- } ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.Common" : {
- "description" : "Things required by all template tag types.",
- "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"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "type" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagType"
- }
- },
- "required" : [ "type", "name", "display-name" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.FieldFilter" : {
- "description" : "Things required by all template tag types.",
- "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"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "required" : {
- "type" : "boolean"
- },
- "type" : {
- "const" : "dimension"
- },
- "alias" : {
- "type" : "string"
- },
- "options" : {
- "description" : "optional map to be appended to filter clause",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.FieldFilter.Options"
- }, {
- "type" : "null"
- } ]
- },
- "dimension" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
- },
- "default" : { },
- "widget-type" : {
- "default" : "category",
- "description" : "which type of widget the frontend should show for this Field Filter; this also affects which parameter types\n are allowed to be specified for it.",
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.WidgetType"
- }
- },
- "required" : [ "type", "name", "display-name", "dimension" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.FieldFilter.Options" : {
- "type" : "object",
- "additionalProperties" : { }
- },
- "metabase.legacy-mbql.schema..TemplateTag.RawValue" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "default" : { },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "required" : {
- "type" : "boolean"
- },
- "type" : {
- "type" : "string",
- "enum" : [ "date", "number", "boolean", "text" ]
- }
- },
- "required" : [ "type", "name", "display-name" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.Snippet" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "database" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "snippet-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
- },
- "snippet-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "type" : {
- "const" : "snippet"
- }
- },
- "required" : [ "type", "name", "display-name", "snippet-name", "snippet-id" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.SourceFilter" : {
- "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" : { }
- },
- "required" : [ "field-id", "op", "value" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.SourceQuery" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "card-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "type" : {
- "const" : "card"
- }
- },
- "required" : [ "type", "name", "display-name", "card-id" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.SourceTable" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "emit-alias" : {
- "type" : "boolean"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "source-filters" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.SourceFilter"
- }
- },
- "table-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
- },
- "type" : {
- "const" : "table"
- }
- },
- "required" : [ "type", "name", "display-name", "table-id" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.TemporalUnit" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "alias" : {
- "type" : "string"
- },
- "default" : { },
- "dimension" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
- },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "required" : {
- "type" : "boolean"
- },
- "type" : {
- "const" : "temporal-unit"
- }
- },
- "required" : [ "type", "name", "display-name", "dimension" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.Value.Common" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "default" : { },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "required" : {
- "type" : "boolean"
- },
- "type" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagType"
- }
- },
- "required" : [ "type", "name", "display-name" ]
- },
"metabase.legacy-mbql.schema..legacy-column-metadata.binning-info" : {
"type" : "object",
"properties" : {
@@ -6953,46 +7413,36 @@
"lib/original-binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
- "allOf" : [ {
+ "oneOf" : [ {
"type" : "object",
"properties" : {
"strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ "const" : "default"
}
},
"required" : [ "strategy" ]
}, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "const" : "default"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "type" : "object",
- "properties" : {
- "bin-width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
- },
- "strategy" : {
- "const" : "bin-width"
- }
+ "type" : "object",
+ "properties" : {
+ "bin-width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
- "required" : [ "strategy", "bin-width" ]
- }, {
- "type" : "object",
- "properties" : {
- "num-bins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
- },
- "strategy" : {
- "const" : "num-bins"
- }
+ "strategy" : {
+ "const" : "bin-width"
+ }
+ },
+ "required" : [ "strategy", "bin-width" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "num-bins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
- "required" : [ "strategy", "num-bins" ]
- } ]
+ "strategy" : {
+ "const" : "num-bins"
+ }
+ },
+ "required" : [ "strategy", "num-bins" ]
} ]
}, {
"type" : "null"
@@ -7019,46 +7469,36 @@
"lib/binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
- "allOf" : [ {
+ "oneOf" : [ {
"type" : "object",
"properties" : {
"strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ "const" : "default"
}
},
"required" : [ "strategy" ]
}, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "const" : "default"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "type" : "object",
- "properties" : {
- "bin-width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
- },
- "strategy" : {
- "const" : "bin-width"
- }
+ "type" : "object",
+ "properties" : {
+ "bin-width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
- "required" : [ "strategy", "bin-width" ]
- }, {
- "type" : "object",
- "properties" : {
- "num-bins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
- },
- "strategy" : {
- "const" : "num-bins"
- }
+ "strategy" : {
+ "const" : "bin-width"
+ }
+ },
+ "required" : [ "strategy", "bin-width" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "num-bins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
- "required" : [ "strategy", "num-bins" ]
- } ]
+ "strategy" : {
+ "const" : "num-bins"
+ }
+ },
+ "required" : [ "strategy", "num-bins" ]
} ]
}, {
"type" : "null"
@@ -7111,43 +7551,6 @@
}
}
},
- "metabase.legacy-mbql.schema.Addable" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpressionArg"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DateTimeExpressionArg"
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.interval"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.segment"
- } ]
- } ]
- },
- "metabase.legacy-mbql.schema.Aggregation" : {
- "description" : "Schema for anything that is a valid `:aggregation` clause.",
- "allOf" : [ {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation-options"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.UnnamedAggregation"
- } ]
- }, {
- "description" : "Normalization should automatically unwrap :aggregation-options with an empty options map"
- } ]
- },
- "metabase.legacy-mbql.schema.AggregationOptionsOptions" : {
- "description" : "Additional options for any aggregation clause when wrapping it in `:aggregation-options`.",
- "type" : "object",
- "properties" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }
- }
- },
"metabase.legacy-mbql.schema.AggregationRefOptions" : {
"type" : "object",
"properties" : {
@@ -7173,254 +7576,6 @@
}
}
},
- "metabase.legacy-mbql.schema.Aggregations" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregation"
- },
- "minItems" : 1
- },
- "metabase.legacy-mbql.schema.AnyMBQLClause" : {
- "description" : "Schema for ANY valid MBQL clause"
- },
- "metabase.legacy-mbql.schema.ArithmeticDateTimeUnit" : {
- "type" : "string",
- "enum" : [ "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year" ]
- },
- "metabase.legacy-mbql.schema.BooleanExpression" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.and"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.or"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._EQ_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._BANG__EQ_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._LT_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._GT_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._LT__EQ_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._GT__EQ_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.between"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.starts-with"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ends-with"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.contains"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.in"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not-in"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.does-not-contain"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.inside"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.is-empty"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not-empty"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.is-null"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not-null"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.relative-time-interval"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.time-interval"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.during"
- } ]
- },
- "metabase.legacy-mbql.schema.Breakouts" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- },
- "minItems" : 1
- },
- "metabase.legacy-mbql.schema.CaseOptions" : {
- "type" : "object",
- "properties" : {
- "default" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"
- }
- }
- },
- "metabase.legacy-mbql.schema.CaseSubclause" : {
- "type" : "array",
- "prefixItems" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Filter"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"
- } ]
- },
- "metabase.legacy-mbql.schema.CaseSubclauses" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.CaseSubclause"
- },
- "minItems" : 1
- },
- "metabase.legacy-mbql.schema.CheckKeysForQueryType" : {
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.CheckQueryDoesNotHaveSourceMetadata" : {
- "description" : "`:source-metadata` is added to queries when `card__id` source queries are resolved. It contains info about the\n columns in the source query.\n\n Where this is added was changed in Metabase 0.33.0 -- previously, when `card__id` source queries were resolved, the\n middleware would add `:source-metadata` to the top-level; to support joins against source queries, this has been\n changed so it is always added at the same level the resolved `:source-query` is added.\n\n This should automatically be fixed by `normalize`; if we encounter it, it means some middleware is not functioning\n properly."
- },
- "metabase.legacy-mbql.schema.DatabaseID" : {
- "description" : "Schema for a valid `:database` ID, in the top-level 'outer' query. Either a positive integer (referring to an\n actual Database), or the saved questions virtual ID, which is a placeholder used for queries using the\n `:source-table \"card__id\"` shorthand for a source query resolved by middleware (since clients might not know the\n actual DB for that source query.)",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- } ]
- },
- "metabase.legacy-mbql.schema.DateOrDatetimeLiteral" : {
- "description" : "Schema for a valid date or datetime literal.",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.relative-datetime"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.absolute-datetime"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.datetime"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.date"
- } ]
- },
- "metabase.legacy-mbql.schema.DateTimeExpressionArg" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregation"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatetimeExpression"
- }, {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DateOrDatetimeLiteral"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- } ]
- } ]
- },
- "metabase.legacy-mbql.schema.DateTimeUnit" : {
- "description" : "Valid unit for *datetime* bucketing.",
- "type" : "string",
- "enum" : [ "quarter", "day", "hour", "week", "second", "default", "day-of-week", "hour-of-day", "month", "month-of-year", "day-of-month", "year", "day-of-year", "millisecond", "year-of-era", "week-of-year", "quarter-of-year", "minute-of-hour", "minute" ]
- },
- "metabase.legacy-mbql.schema.DateUnit" : {
- "description" : "Valid unit for date bucketing.",
- "type" : "string",
- "enum" : [ "quarter", "day", "week", "default", "day-of-week", "month", "month-of-year", "day-of-month", "year", "day-of-year", "year-of-era", "week-of-year", "quarter-of-year" ]
- },
- "metabase.legacy-mbql.schema.DatetimeDiffUnit" : {
- "description" : "Valid units for a datetime-diff clause.",
- "type" : "string",
- "enum" : [ "second", "minute", "hour", "day", "week", "month", "quarter", "year" ]
- },
- "metabase.legacy-mbql.schema.DatetimeExpression" : {
- "description" : "Schema for the definition of a date function expression.",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._PLUS_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime-add"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime-subtract"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.convert-timezone"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.now"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.date"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.today"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.coalesce"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.case"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.if"
- } ]
- },
- "metabase.legacy-mbql.schema.DatetimeOptions" : {
- "type" : "object",
- "properties" : {
- "mode" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatetimeOptionsMode"
- }
- }
- },
- "metabase.legacy-mbql.schema.DatetimeOptionsMode" : {
- "type" : "string",
- "enum" : [ "simple-bytes", "unix-nanoseconds", "simple", "iso", "iso-bytes", "unix-seconds", "unix-milliseconds", "unix-microseconds" ]
- },
- "metabase.legacy-mbql.schema.Emptyable" : {
- "description" : "Schema for a valid is-empty or not-empty argument.",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.StringExpressionArg"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- } ]
- },
- "metabase.legacy-mbql.schema.EqualityComparable" : {
- "description" : "Schema for things that make sense in a `=` or `!=` filter, i.e. things that can be compared for equality.",
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "number"
- }, {
- "type" : "string"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemporalLiteral"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRefOrRelativeDatetime"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "metabase.legacy-mbql.schema.EqualityFilterFieldArg" : {
- "description" : "Schema for the first arg to `=`, `!=`, and friends.",
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.EqualityComparable"
- },
- "metabase.legacy-mbql.schema.ExpressionArg" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "boolean"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.BooleanExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatetimeExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregation"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation"
- }, {
- "type" : "string"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.StringExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- } ]
- },
"metabase.legacy-mbql.schema.ExpressionName" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
@@ -7429,28 +7584,28 @@
"default" : { },
"type" : "object",
"properties" : {
- "base-type" : {
+ "database-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "database-type" : {
+ "display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "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"
}, {
@@ -7469,71 +7624,30 @@
"type" : "null"
} ]
},
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "include-current" : {
+ "type" : "boolean"
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
- },
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}
}
},
- "metabase.legacy-mbql.schema.Expressions" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionDef"
- }
- },
- "metabase.legacy-mbql.schema.ExtractWeekMode" : {
- "description" : "Valid modes to extract weeks.",
- "type" : "string",
- "enum" : [ "iso", "us", "instance" ]
- },
- "metabase.legacy-mbql.schema.FieldOrExpressionDef" : {
- "description" : "Schema for anything that is accepted as a top-level expression definition, either an arithmetic expression such as a\n `:+` clause or a `:field` or `:value` clause.",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpression"
- }, {
- "type" : "number"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.StringExpression"
- }, {
- "type" : "string"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.BooleanExpression"
- }, {
- "type" : "boolean"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatetimeExpression"
- }, { }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.case"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.if"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.offset"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- } ]
- },
- "metabase.legacy-mbql.schema.FieldOrExpressionRef" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.expression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
- } ]
- },
- "metabase.legacy-mbql.schema.FieldOrExpressionRefOrRelativeDatetime" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.relative-datetime"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- } ]
- },
"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" : [ {
@@ -7578,6 +7692,13 @@
"type" : "null"
} ]
},
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/uuid" : {
"type" : "string",
"minLength" : 36,
@@ -7590,9 +7711,18 @@
"type" : "null"
} ]
},
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
"lib/original-effective-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
@@ -7602,6 +7732,9 @@
"lib/original-binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
+ "include-current" : {
+ "type" : "boolean"
+ },
"temporal-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
@@ -7626,1445 +7759,1048 @@
"type" : "null"
} ]
},
- "metabase.legacy-mbql.schema.Fields" : {
- "allOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- },
- "minItems" : 1
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.helpers.distinct"
- } ]
- },
- "metabase.legacy-mbql.schema.Filter" : {
- "description" : "Schema for a valid MBQL `:filter` clause.",
+ "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.DatetimeExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.StringExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.BooleanExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.segment"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.expression"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
} ]
},
- "metabase.legacy-mbql.schema.IntGreaterThanZeroOrNumericExpression" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
+ "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.NumericExpression"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.require-base-type-for-field-name"
} ]
},
- "metabase.legacy-mbql.schema.Join" : {
- "description" : "Perform the equivalent of a SQL `JOIN` with another Table or nested `:source-query`. JOINs are either explicitly\n specified in the incoming query, or implicitly generated when one uses a `:field` clause with `:source-field`.\n\n In the top-level query, you can reference Fields from the joined table or nested query by including `:source-field`\n in the `:field` options (known as implicit joins); for explicit joins, you *must* specify `:join-alias` yourself; in\n the `:field` options, e.g.\n\n ;; for joins against other Tables/MBQL source queries\n [:field 1 {:join-alias \"my_join_alias\"}]\n\n ;; for joins against native queries\n [:field \"my_field\" {:base-type :field/Integer, :join-alias \"my_join_alias\"}]",
+ "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" : {
- "alias" : {
- "description" : "The name used to alias the joined table or query. This is usually generated automatically and generally looks\n like `table__via__field`. You can specify this yourself if you need to reference a joined field with a `:join-alias`\n in the options.\n\n Driver implementations: This is guaranteed to be present after pre-processing.",
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- },
- "condition" : {
- "description" : "The condition on which to JOIN. Can be anything that is a valid `:filter` clause. For automatically-generated\n JOINs this is usually something like\n\n [:= <source-table-fk-field> [:field <dest-table-pk-field> {:join-alias <join-table-alias>}]]",
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Filter"
- },
- "fields" : {
- "description" : "The Fields from this join to include in parent-level results. This can be either `:none`, `:all`, or a sequence\n 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 Field from the joined table or query\n\n * a sequence of Field clauses: include only the Fields specified. Valid clauses are the same as the top-level\n `:fields` clause. This should be non-empty and all elements should be distinct. The normalizer will automatically\n remove duplicate fields for you, and replace empty clauses with `:none`.\n\n Driver implementations: you can ignore this clause. Relevant fields will be added to top-level `:fields` clause with\n appropriate aliases.",
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.JoinFields"
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
},
- "fk-field-id" : {
- "description" : "Mostly used only internally. When a join is implicitly generated via a `:field` clause with\n `:source-field`, the ID of the foreign key field in the source Table will be recorded here. This information is used\n to add `fk_field_id` information to the `:cols` in the query results, and also for drill-thru. When generating\n explicit joins by hand you can usually omit this information, altho it doesn't hurt to include it if you know it.\n\n Don't set this information yourself. It will have no effect.",
+ "field_ref" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
- "source-metadata" : {
- "description" : "Metadata about the source query being used, if pulled in from a Card via the\n `:source-table \"card__id\"` syntax. added automatically by the `resolve-card-id-source-tables` middleware.",
+ "lib/external-remap" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
- }
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
}, {
"type" : "null"
} ]
},
- "source-query" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.SourceQuery"
+ "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"
+ } ]
},
- "source-table" : {
- "description" : "*What* to JOIN. Self-joins can be done by using the same `:source-table` as in the query where\n this is specified. YOU MUST SUPPLY EITHER `:source-table` OR `:source-query`, BUT NOT BOTH!",
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.SourceTable"
+ "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"
+ } ]
},
- "strategy" : {
- "description" : "Defaults to `:left-join`; used for all automatically-generated JOINs\n\n Driver implementations: this is guaranteed to be present after pre-processing.",
- "$ref" : "#/components/schemas/metabase.lib.schema.join.strategy"
- }
- },
- "required" : [ "condition" ]
- }, {
- "allOf" : [ ]
- } ]
- },
- "metabase.legacy-mbql.schema.JoinFields" : {
- "anyOf" : [ {
- "type" : "string",
- "enum" : [ "all", "none" ]
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Fields"
- } ]
- },
- "metabase.legacy-mbql.schema.Joins" : {
- "description" : "Schema for a valid sequence of `Join`s. Must be a non-empty sequence, and `:alias`, if specified, must be unique.",
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Join"
- },
- "minItems" : 1
- },
- "metabase.legacy-mbql.schema.MBQLInnerQuery" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "breakout" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Breakouts"
+ "lib/type" : {
+ "default" : "metadata/column",
+ "const" : "metadata/column"
},
- "source-metadata" : {
- "description" : "Info about the columns of the source query. Added in automatically by middleware. This metadata is\n primarily used to let power things like binning when used with Field Literals instead of normal Fields.",
+ "settings" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
- }
+ "type" : "object",
+ "properties" : { }
}, {
"type" : "null"
} ]
},
- "source-query" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.SourceQuery"
- },
- "limit" : {
- "type" : "integer",
- "minimum" : 0
+ "fingerprint" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
+ }, {
+ "type" : "null"
+ } ]
},
- "filter" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Filter"
+ "visibility_type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
+ }, {
+ "type" : "null"
+ } ]
},
- "joins" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Joins"
+ "base_type" : {
+ "default" : "type/*",
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
- "aggregation" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregations"
+ "lib/source-uuid" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ }, {
+ "type" : "null"
+ } ]
},
- "fields" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Fields"
+ "qp/implicit-field?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "source-table" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.SourceTable"
+ "lib/ref-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "order-by" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.OrderBys"
+ "id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
},
- "page" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.page"
+ "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"
+ } ]
},
- "expressions" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Expressions"
- }
- }
- }, {
- "type" : "object",
- "properties" : { }
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.RemoveFieldRefsFromFieldsAlreadyInBreakout"
- }, {
- "allOf" : [ ]
- } ]
- },
- "metabase.legacy-mbql.schema.NativeSourceQuery" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "collection" : {
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "native" : { },
- "template-tags" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagMap"
- }
- },
- "required" : [ "native" ]
- }, {
- "allOf" : [ ]
- } ]
- },
- "metabase.legacy-mbql.schema.NumericExpression" : {
- "description" : "Schema for the definition of a numeric expression. All numeric expressions evaluate to numeric values.",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._PLUS_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.-"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._SLASH_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._STAR_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.coalesce"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.length"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.floor"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ceil"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.round"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.abs"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.power"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.sqrt"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.exp"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.log"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.case"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.if"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime-diff"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.integer"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.float"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.temporal-extract"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.get-year"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.get-quarter"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.get-month"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.get-week"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.get-day"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.get-day-of-week"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.get-hour"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.get-minute"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.get-second"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation"
- } ]
- },
- "metabase.legacy-mbql.schema.NumericExpressionArg" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregation"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
- } ]
- },
- "metabase.legacy-mbql.schema.OrderBy" : {
- "description" : "Schema for an `order-by` clause subclause.",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.asc"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.desc"
- } ]
- },
- "metabase.legacy-mbql.schema.OrderBys" : {
- "allOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.OrderBy"
- },
- "minItems" : 1
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.helpers.distinct"
- } ]
- },
- "metabase.legacy-mbql.schema.OrderComparable" : {
- "description" : "Schema for things that make sense in a filter like `>` or `<`, i.e. things that can be sorted.",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
- }, {
- "anyOf" : [ {
- "type" : "number"
- }, {
- "type" : "string"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemporalLiteral"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRefOrRelativeDatetime"
- } ]
- } ]
- },
- "metabase.legacy-mbql.schema.OrderedFilterFieldArg" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.OrderComparable"
- },
- "metabase.legacy-mbql.schema.Query" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.CheckQueryDoesNotHaveSourceMetadata"
- }, {
- "type" : "object",
- "properties" : {
- "update-row" : {
+ "lib/original-expression-name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "settings" : {
+ "lib/from-model?" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.settings.settings"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "constraints" : {
+ "name" : {
+ "type" : "string"
+ },
+ "lib/card-id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.constraints.constraints"
+ "description" : "Valid Card ID",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "query" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.MBQLInnerQuery"
+ "lib/expression-name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "native" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TopLevelNativeInnerQuery"
+ "lib/breakout?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "info" : {
- "description" : "Used when recording info about this run in the QueryExecution log; things like context query was\n ran in and User who ran it.",
+ "semantic_type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.info.info"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
- "middleware" : {
+ "lib/original-effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "database" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatabaseID"
+ "lib/join-alias" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "description" : "Type of query. `:query` = MBQL; `:native` = native.",
- "type" : "string",
- "enum" : [ "query", "native" ]
+ "display_name" : {
+ "type" : "string"
},
- "parameters" : {
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "type" : "boolean"
+ },
+ "lib/internal-remap" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
}, {
"type" : "null"
} ]
},
- "create-row" : {
+ "converted_timezone" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal.timezone-id"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "type" ]
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.CheckKeysForQueryType"
- }, {
- "allOf" : [ ]
- } ]
- },
- "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.RelativeDatetimeUnit" : {
- "type" : "string",
- "enum" : [ "default", "minute", "hour", "day", "week", "month", "quarter", "year" ]
- },
- "metabase.legacy-mbql.schema.RemoveFieldRefsFromFieldsAlreadyInBreakout" : { },
- "metabase.legacy-mbql.schema.SourceQuery" : {
- "description" : "Schema for a valid value for a `:source-query`.",
- "allOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NativeSourceQuery"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.MBQLInnerQuery"
- } ]
- } ]
- },
- "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.StringExpression" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.substring"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.trim"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ltrim"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.rtrim"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.replace"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.lower"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.upper"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.concat"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.regex-match-first"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.coalesce"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.case"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.if"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.host"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.domain"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.subdomain"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.path"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.month-name"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.quarter-name"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.day-name"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.text"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.split-part"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.collate"
- } ]
- },
- "metabase.legacy-mbql.schema.StringExpressionArg" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.StringExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- } ]
- },
- "metabase.legacy-mbql.schema.StringFilterOptions" : {
- "type" : "object",
- "properties" : {
- "case-sensitive" : {
- "type" : "boolean"
- }
- }
- },
- "metabase.legacy-mbql.schema.TemplateTag" : {
- "description" : "Schema for a template tag as specified in a native query. There are four types of template tags, differentiated by\n `:type`.\n\n Template tags are used to specify {{placeholders}} in native queries that are replaced with some sort of value when\n the query itself runs. There are four basic types of template tag for native queries:\n\n 1. Field filters, which are used like\n\n SELECT * FROM table WHERE {{field_filter}}\n\n These reference specific Fields and are replaced with entire conditions, e.g. `some_field > 1000`\n\n 2. Raw values, which are used like\n\n SELECT * FROM table WHERE my_field = {{x}}\n\n These are replaced with raw values.\n\n 3. Native query snippets, which might be used like\n\n SELECT * FROM ({{snippet: orders}}) source\n\n These are replaced with `NativeQuerySnippet`s from the application database.\n\n 4. Source query Card IDs, which are used like\n\n SELECT * FROM ({{#123}}) source\n\n These are replaced with the query from the Card with that ID.\n\n Field filters and raw values usually have their value specified by `:parameters`.",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.FieldFilter"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.Snippet"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.SourceQuery"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.SourceTable"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.TemporalUnit"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.RawValue"
- } ]
- },
- "metabase.legacy-mbql.schema.TemplateTagMap" : {
- "description" : "Schema for the `:template-tags` map passed in as part of a native query.\n\n Map of template tag name -> template tag definition",
- "allOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTag"
- }
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag..template-tag-map.validate-names"
- } ]
- },
- "metabase.legacy-mbql.schema.TemplateTagType" : {
- "description" : "Schema for valid values of template tag `:type`.",
- "type" : "string",
- "enum" : [ "snippet", "card", "dimension", "number", "text", "date", "table" ]
- },
- "metabase.legacy-mbql.schema.TemporalExtractUnit" : {
- "description" : "Valid units to extract from a temporal.",
- "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.legacy-mbql.schema.TemporalLiteral" : {
- "description" : "Schema for valid temporal literals.",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DateOrDatetimeLiteral"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TimeLiteral"
- } ]
- },
- "metabase.legacy-mbql.schema.TimeIntervalOptions" : {
- "type" : "object",
- "properties" : {
- "include-current" : {
- "type" : "boolean"
- }
- }
- },
- "metabase.legacy-mbql.schema.TimeLiteral" : {
- "description" : "Schema for valid time literals.",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.time"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.time"
- } ]
- },
- "metabase.legacy-mbql.schema.TimeUnit" : {
- "description" : "Valid unit for time bucketing.",
- "type" : "string",
- "enum" : [ "hour", "second", "default", "hour-of-day", "millisecond", "minute-of-hour", "minute" ]
- },
- "metabase.legacy-mbql.schema.TopLevelNativeInnerQuery" : {
- "description" : "Schema for a valid, normalized native [inner] query.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "collection" : {
+ },
+ "source" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
}, {
"type" : "null"
} ]
},
- "query" : { },
- "template-tags" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagMap"
+ "fk_field_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "binning_info" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..legacy-column-metadata.binning-info"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-binning" : {
+ "oneOf" : [ {
+ "description" : "Schema for `:binning` options passed to a `:field` clause.",
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "strategy" : {
+ "const" : "default"
+ }
+ },
+ "required" : [ "strategy" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "bin-width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
+ },
+ "strategy" : {
+ "const" : "bin-width"
+ }
+ },
+ "required" : [ "strategy", "bin-width" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "num-bins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
+ },
+ "strategy" : {
+ "const" : "num-bins"
+ }
+ },
+ "required" : [ "strategy", "num-bins" ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective_type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "lib/original-join-alias" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "qp/native-sandbox-column.force-coercion-strategy" : {
+ "type" : "string"
+ },
+ "lib/binning" : {
+ "oneOf" : [ {
+ "description" : "Schema for `:binning` options passed to a `:field` clause.",
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "strategy" : {
+ "const" : "default"
+ }
+ },
+ "required" : [ "strategy" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "bin-width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
+ },
+ "strategy" : {
+ "const" : "bin-width"
+ }
+ },
+ "required" : [ "strategy", "bin-width" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "num-bins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
+ },
+ "strategy" : {
+ "const" : "num-bins"
+ }
+ },
+ "required" : [ "strategy", "num-bins" ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metabase.lib.metadata.result-metadata/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ }, {
+ "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"
+ } ]
+ },
+ "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"
+ } ]
+ },
+ "description" : {
+ "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" : [ "query" ]
+ "required" : [ "display_name", "name" ]
}, {
"allOf" : [ ]
} ]
},
- "metabase.legacy-mbql.schema.UnnamedAggregation" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.AnyMBQLClause"
+ "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-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.legacy-mbql.schema.ValueTypeInfo" : {
- "description" : "Type info about a value in a `:value` clause. Added automatically by `wrap-value-literals` middleware to values in filter clauses based on the Field in the clause.",
+ "metabase.lib-metric.schema..dimension-reference.options" : {
+ "description" : "Options map for dimension references.",
"type" : "object",
"properties" : {
- "base_type" : {
+ "binning" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.binning"
}, {
"type" : "null"
} ]
},
- "database_type" : {
+ "display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "name" : {
+ "effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "semantic_type" : {
+ "semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
- "unit" : {
+ "temporal-unit" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DateTimeUnit"
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
}
}
},
- "metabase.legacy-mbql.schema.WidgetType" : {
- "description" : "Schema for valid values of `:widget-type` for a `::TemplateTag.FieldFilter`.",
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.widget-type"
- },
- "metabase.legacy-mbql.schema._BANG__EQ_" : {
- "description" : "schema for a valid MBQL 4 :!= clause",
- "allOf" : [ ]
+ "metabase.lib-metric.schema..dimension-source.type" : {
+ "type" : "string",
+ "enum" : [ "field" ]
},
- "metabase.legacy-mbql.schema._EQ_" : {
- "description" : "schema for a valid MBQL 4 := clause",
- "allOf" : [ ]
+ "metabase.lib-metric.schema.binning" : {
+ "description" : "Schema for `:binning` options passed to a `:dimension` clause.",
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "strategy" : {
+ "const" : "default"
+ }
+ },
+ "required" : [ "strategy" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "bin-width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.positive-number"
+ },
+ "strategy" : {
+ "const" : "bin-width"
+ }
+ },
+ "required" : [ "strategy", "bin-width" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "num-bins" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "strategy" : {
+ "const" : "num-bins"
+ }
+ },
+ "required" : [ "strategy", "num-bins" ]
+ } ]
},
- "metabase.legacy-mbql.schema._GT_" : {
- "description" : "schema for a valid MBQL 4 :> clause",
- "allOf" : [ ]
+ "metabase.lib-metric.schema.dimension-id" : {
+ "description" : "UUID string identifying a dimension.",
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
},
- "metabase.legacy-mbql.schema._GT__EQ_" : {
- "description" : "schema for a valid MBQL 4 :>= clause",
- "allOf" : [ ]
+ "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.legacy-mbql.schema._LT_" : {
- "description" : "schema for a valid MBQL 4 :< clause",
- "allOf" : [ ]
+ "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.legacy-mbql.schema._LT__EQ_" : {
- "description" : "schema for a valid MBQL 4 :<= clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema._PLUS_" : {
- "description" : "schema for a valid MBQL 4 :+ clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema._SLASH_" : {
- "description" : "schema for a valid MBQL 4 :/ clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema._STAR_" : {
- "description" : "schema for a valid MBQL 4 :* clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.abs" : {
- "description" : "schema for a valid MBQL 4 :abs clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.absolute-datetime" : {
- "description" : "Schema for a valid MBQL 4 :absolute-datetime clause.",
- "oneOf" : [ { }, {
- "description" : "schema for a valid MBQL 4 :absolute-datetime clause",
- "allOf" : [ ]
- }, {
- "description" : "schema for a valid MBQL 4 :absolute-datetime clause",
- "allOf" : [ ]
- } ]
- },
- "metabase.legacy-mbql.schema.aggregation" : {
- "description" : "schema for a valid MBQL 4 :aggregation clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.aggregation-options" : {
- "description" : "schema for a valid MBQL 4 :aggregation-options clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.and" : {
- "description" : "Schema for a valid MBQL 4 :and clause.",
- "oneOf" : [ {
- "description" : "schema for a valid MBQL 4 :and clause",
- "allOf" : [ ]
+ "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.legacy-mbql.schema.Filter"
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.measure-expression-ref"
} ]
},
- "metabase.legacy-mbql.schema.asc" : {
- "description" : "schema for a valid MBQL 4 :asc clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.between" : {
- "description" : "schema for a valid MBQL 4 :between clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.case" : {
- "description" : "schema for a valid MBQL 4 :case clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.ceil" : {
- "description" : "schema for a valid MBQL 4 :ceil clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.coalesce" : {
- "description" : "schema for a valid MBQL 4 :coalesce clause",
- "allOf" : [ ]
+ "metabase.lib-metric.schema.filter-clause" : {
+ "description" : "MBQL filter clause with normalization for API input.\n Handles string operators and dimension references."
},
- "metabase.legacy-mbql.schema.collate" : {
- "description" : "schema for a valid MBQL 4 :collate clause",
- "allOf" : [ ]
+ "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" ]
},
- "metabase.legacy-mbql.schema.concat" : {
- "description" : "schema for a valid MBQL 4 :concat clause",
- "allOf" : [ ]
+ "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.legacy-mbql.schema.contains" : {
- "description" : "Schema for a valid MBQL 4 :metabase.legacy-mbql.schema/contains clause.",
- "anyOf" : [ {
- "description" : "schema for a valid MBQL 4 :contains clause",
- "allOf" : [ ]
+ "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"
}, {
- "description" : "schema for a valid MBQL 4 :contains clause",
- "allOf" : [ ]
+ "type" : "object",
+ "properties" : {
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "lib/uuid" ]
+ }, {
+ "type" : "integer",
+ "minimum" : 1
} ]
},
- "metabase.legacy-mbql.schema.convert-timezone" : {
- "description" : "schema for a valid MBQL 4 :convert-timezone clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.date" : {
- "description" : "schema for a valid MBQL 4 :date clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.datetime" : {
- "description" : "schema for a valid MBQL 4 :datetime clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.datetime-add" : {
- "description" : "schema for a valid MBQL 4 :datetime-add clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.datetime-diff" : {
- "description" : "schema for a valid MBQL 4 :datetime-diff clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.datetime-subtract" : {
- "description" : "schema for a valid MBQL 4 :datetime-subtract clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.day-name" : {
- "description" : "schema for a valid MBQL 4 :day-name clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.desc" : {
- "description" : "schema for a valid MBQL 4 :desc clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.does-not-contain" : {
- "description" : "Schema for a valid MBQL 4 :metabase.legacy-mbql.schema/does-not-contain clause.",
- "anyOf" : [ {
- "description" : "schema for a valid MBQL 4 :does-not-contain clause",
- "allOf" : [ ]
+ "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"
}, {
- "description" : "schema for a valid MBQL 4 :does-not-contain clause",
- "allOf" : [ ]
+ "type" : "object",
+ "properties" : {
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "lib/uuid" ]
+ }, {
+ "type" : "integer",
+ "minimum" : 1
} ]
},
- "metabase.legacy-mbql.schema.domain" : {
- "description" : "schema for a valid MBQL 4 :domain clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.during" : {
- "description" : "schema for a valid MBQL 4 :during clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.ends-with" : {
- "description" : "Schema for a valid MBQL 4 :metabase.legacy-mbql.schema/ends-with clause.",
+ "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" : [ {
- "description" : "schema for a valid MBQL 4 :ends-with clause",
- "allOf" : [ ]
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.expression-leaf"
}, {
- "description" : "schema for a valid MBQL 4 :ends-with clause",
- "allOf" : [ ]
- } ]
- },
- "metabase.legacy-mbql.schema.exp" : {
- "description" : "schema for a valid MBQL 4 :exp 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" : [ ]
+ "type" : "number"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.require-base-type-for-field-name"
+ "type" : "array"
} ]
},
- "metabase.legacy-mbql.schema.float" : {
- "description" : "schema for a valid MBQL 4 :float clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.floor" : {
- "description" : "schema for a valid MBQL 4 :floor clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.get-day" : {
- "description" : "schema for a valid MBQL 4 :get-day clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.get-day-of-week" : {
- "description" : "schema for a valid MBQL 4 :get-day-of-week clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.get-hour" : {
- "description" : "schema for a valid MBQL 4 :get-hour clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.get-minute" : {
- "description" : "schema for a valid MBQL 4 :get-minute clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.get-month" : {
- "description" : "schema for a valid MBQL 4 :get-month clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.get-quarter" : {
- "description" : "schema for a valid MBQL 4 :get-quarter clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.get-second" : {
- "description" : "schema for a valid MBQL 4 :get-second clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.get-week" : {
- "description" : "schema for a valid MBQL 4 :get-week clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.get-year" : {
- "description" : "schema for a valid MBQL 4 :get-year clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.helpers.distinct" : {
- "description" : "values must be distinct"
- },
- "metabase.legacy-mbql.schema.host" : {
- "description" : "schema for a valid MBQL 4 :host clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.if" : {
- "description" : "schema for a valid MBQL 4 :if clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.in" : {
- "description" : "schema for a valid MBQL 4 :in clause",
- "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" ]
},
- "metabase.legacy-mbql.schema.inside" : {
- "description" : "schema for a valid MBQL 4 :inside clause",
- "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.legacy-mbql.schema.integer" : {
- "description" : "schema for a valid MBQL 4 :integer clause",
- "allOf" : [ ]
+ "metabase.lib.metadata.protocols.metadata-provider" : {
+ "description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol."
},
- "metabase.legacy-mbql.schema.interval" : {
- "description" : "schema for a valid MBQL 4 :interval clause",
- "allOf" : [ ]
+ "metabase.lib.schema..stage.additional" : {
+ "oneOf" : [ { }, { } ]
},
- "metabase.legacy-mbql.schema.is-empty" : {
- "description" : "schema for a valid MBQL 4 :is-empty clause",
- "allOf" : [ ]
+ "metabase.lib.schema..stage.common" : {
+ "type" : "object",
+ "properties" : {
+ "lib/stage-metadata" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
+ },
+ "parameters" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
+ }
+ }
},
- "metabase.legacy-mbql.schema.is-null" : {
- "description" : "schema for a valid MBQL 4 :is-null clause",
- "allOf" : [ ]
+ "metabase.lib.schema..stage.initial" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, { } ]
},
- "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`.",
+ "metabase.lib.schema..stage.mbql" : {
"allOf" : [ {
"type" : "object",
"properties" : {
- "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"
- } ]
- },
- "lib/external-remap" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
- }, {
- "type" : "null"
- } ]
- },
- "lib/source-column-alias" : {
- "oneOf" : [ {
- "description" : "Name for a column as returned/projected by the previous stage of the query or source Table/source Card. The\n left-hand side (LHS) of\n\n SELECT lhs AS rhs",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/temporal-unit" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "default", "hour", "hour-of-day", "millisecond", "minute", "minute-of-hour", "month", "month-of-year", "quarter", "quarter-of-year", "second", "second-of-minute", "week", "week-of-year", "year", "year-of-era" ]
- }, {
- "type" : "null"
- } ]
+ "source-card" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"lib/type" : {
- "default" : "metadata/column",
- "const" : "metadata/column"
- },
- "fingerprint" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
- }, {
- "type" : "null"
- } ]
+ "const" : "mbql.stage/mbql"
},
- "visibility_type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
- }, {
- "type" : "null"
- } ]
+ "lib/stage-metadata" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
},
- "base_type" : {
- "default" : "type/*",
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "pivot" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.pivot"
},
- "lib/source-uuid" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- }, {
- "type" : "null"
- } ]
+ "breakout" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.breakouts"
},
- "qp/implicit-field?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "filters" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.filters"
},
- "lib/ref-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "limit" : {
+ "type" : "integer",
+ "minimum" : 0
},
- "id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- }, {
- "type" : "null"
- } ]
+ "joins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.joins"
},
- "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"
- } ]
+ "aggregation" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.aggregation.aggregations"
},
- "lib/transformation-added-base-type" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "fields" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.fields"
},
- "lib/original-expression-name" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
+ "source-table" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
},
- "lib/from-model?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "order-by" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.order-by.order-bys"
},
- "name" : {
- "type" : "string"
+ "page" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.page"
},
- "lib/card-id" : {
- "oneOf" : [ {
- "description" : "Valid Card ID",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
+ "parameters" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
- "lib/expression-name" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
+ "expressions" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.expressions"
+ }
+ },
+ "required" : [ "lib/type" ]
+ }, {
+ "$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" : {
+ "collection" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "lib/breakout?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "lib/stage-metadata" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
},
- "semantic_type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
+ "lib/type" : {
+ "const" : "mbql.stage/native"
},
- "lib/original-effective-type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "native" : { },
+ "parameters" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
- "lib/join-alias" : {
+ "params" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ }, { } ]
+ }
}, {
"type" : "null"
} ]
},
- "display_name" : {
- "type" : "string"
- },
- "qp/native-sandbox-column.propagate-coercion?" : {
- "type" : "boolean"
- },
- "lib/internal-remap" : {
+ "query-permissions/referenced-card-ids" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "uniqueItems" : true
}, {
"type" : "null"
} ]
},
- "converted_timezone" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal.timezone-id"
- }, {
- "type" : "null"
- } ]
+ "template-tags" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tags"
+ }
+ },
+ "required" : [ "lib/type" ]
+ }, {
+ "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" : { }
+ },
+ "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" : {
+ "strategy" : {
+ "const" : "default"
+ }
+ },
+ "required" : [ "strategy" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "bin-width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
},
- "source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
- }, {
- "type" : "null"
- } ]
+ "strategy" : {
+ "const" : "bin-width"
+ }
+ },
+ "required" : [ "strategy", "bin-width" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "num-bins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
},
- "binning_info" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..legacy-column-metadata.binning-info"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-binning" : {
- "oneOf" : [ {
- "description" : "Schema for `:binning` options passed to a `:field` clause.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "const" : "default"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "type" : "object",
- "properties" : {
- "bin-width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
- },
- "strategy" : {
- "const" : "bin-width"
- }
- },
- "required" : [ "strategy", "bin-width" ]
- }, {
- "type" : "object",
- "properties" : {
- "num-bins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
- },
- "strategy" : {
- "const" : "num-bins"
- }
- },
- "required" : [ "strategy", "num-bins" ]
- } ]
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "effective_type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "lib/original-join-alias" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "unit" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }, {
- "type" : "null"
- } ]
- },
- "qp/native-sandbox-column.force-coercion-strategy" : {
- "type" : "string"
- },
- "lib/binning" : {
- "oneOf" : [ {
- "description" : "Schema for `:binning` options passed to a `:field` clause.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "const" : "default"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "type" : "object",
- "properties" : {
- "bin-width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
- },
- "strategy" : {
- "const" : "bin-width"
- }
- },
- "required" : [ "strategy", "bin-width" ]
- }, {
- "type" : "object",
- "properties" : {
- "num-bins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
- },
- "strategy" : {
- "const" : "num-bins"
- }
- },
- "required" : [ "strategy", "num-bins" ]
- } ]
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "metabase.lib.metadata.result-metadata/source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
- }, {
- "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"
- } ]
- },
- "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"
- } ]
- },
- "description" : {
- "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"
- } ]
+ "strategy" : {
+ "const" : "num-bins"
}
},
- "required" : [ "display_name", "name" ]
- }, {
- "allOf" : [ ]
+ "required" : [ "strategy", "num-bins" ]
} ]
},
- "metabase.legacy-mbql.schema.length" : {
- "description" : "schema for a valid MBQL 4 :length clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.log" : {
- "description" : "schema for a valid MBQL 4 :log clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.lower" : {
- "description" : "schema for a valid MBQL 4 :lower clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.ltrim" : {
- "description" : "schema for a valid MBQL 4 :ltrim clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.month-name" : {
- "description" : "schema for a valid MBQL 4 :month-name clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.not" : {
- "description" : "schema for a valid MBQL 4 :not clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.not-empty" : {
- "description" : "schema for a valid MBQL 4 :not-empty clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.not-in" : {
- "description" : "schema for a valid MBQL 4 :not-in clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.not-null" : {
- "description" : "schema for a valid MBQL 4 :not-null clause",
- "allOf" : [ ]
+ "metabase.lib.schema.binning.num-bins" : {
+ "description" : "Number of bins to use.",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.legacy-mbql.schema.now" : {
- "description" : "schema for a valid MBQL 4 :now clause",
- "allOf" : [ ]
+ "metabase.lib.schema.binning.strategy" : {
+ "type" : "string",
+ "enum" : [ "bin-width", "default", "num-bins" ]
},
- "metabase.legacy-mbql.schema.offset" : {
- "description" : "schema for a valid MBQL 4 :offset clause",
- "allOf" : [ ]
+ "metabase.lib.schema.breakout" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.ref.ref"
},
- "metabase.legacy-mbql.schema.or" : {
- "description" : "Schema for a valid MBQL 4 :or clause.",
- "oneOf" : [ {
- "description" : "schema for a valid MBQL 4 :or clause",
- "allOf" : [ ]
+ "metabase.lib.schema.breakouts" : {
+ "allOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.breakout"
+ },
+ "minItems" : 1
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Filter"
+ "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
} ]
},
- "metabase.legacy-mbql.schema.path" : {
- "description" : "schema for a valid MBQL 4 :path clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.power" : {
- "description" : "schema for a valid MBQL 4 :power clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.quarter-name" : {
- "description" : "schema for a valid MBQL 4 :quarter-name clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.regex-match-first" : {
- "description" : "schema for a valid MBQL 4 :regex-match-first clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.relative-datetime" : {
- "description" : "schema for a valid MBQL 4 :relative-datetime clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.relative-time-interval" : {
- "description" : "schema for a valid MBQL 4 :relative-time-interval clause",
- "allOf" : [ ]
+ "metabase.lib.schema.common.base-type" : {
+ "type" : "string"
},
- "metabase.legacy-mbql.schema.replace" : {
- "description" : "schema for a valid MBQL 4 :replace clause",
- "allOf" : [ ]
+ "metabase.lib.schema.common.kebab-cased-map" : { },
+ "metabase.lib.schema.common.non-blank-string" : {
+ "type" : "string",
+ "minLength" : 1
},
- "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.common.options" : {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "database-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "base-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "include-current" : {
+ "type" : "boolean"
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "lib/uuid" ]
},
- "metabase.legacy-mbql.schema.round" : {
- "description" : "schema for a valid MBQL 4 :round clause",
- "allOf" : [ ]
+ "metabase.lib.schema.common.positive-number" : { },
+ "metabase.lib.schema.common.semantic-or-relation-type" : {
+ "description" : "valid semantic or relation type",
+ "type" : "string"
},
- "metabase.legacy-mbql.schema.rtrim" : {
- "description" : "schema for a valid MBQL 4 :rtrim clause",
- "allOf" : [ ]
+ "metabase.lib.schema.common.uuid" : {
+ "type" : "string",
+ "minLength" : 36,
+ "maxLength" : 36
},
- "metabase.legacy-mbql.schema.segment" : {
- "description" : "schema for a valid MBQL 4 :segment clause",
- "allOf" : [ ]
+ "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
+ }
+ }
},
- "metabase.legacy-mbql.schema.split-part" : {
- "description" : "schema for a valid MBQL 4 :split-part clause",
- "allOf" : [ ]
+ "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.legacy-mbql.schema.sqrt" : {
- "description" : "schema for a valid MBQL 4 :sqrt clause",
+ "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.legacy-mbql.schema.starts-with" : {
- "description" : "Schema for a valid MBQL 4 :metabase.legacy-mbql.schema/starts-with clause.",
- "anyOf" : [ {
- "description" : "schema for a valid MBQL 4 :starts-with clause",
- "allOf" : [ ]
+ "metabase.lib.schema.expression.arithmetic.temporal-difference-schema" : { },
+ "metabase.lib.schema.expression.boolean" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
}, {
- "description" : "schema for a valid MBQL 4 :starts-with clause",
- "allOf" : [ ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
} ]
},
- "metabase.legacy-mbql.schema.subdomain" : {
- "description" : "schema for a valid MBQL 4 :subdomain clause",
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.substring" : {
- "description" : "schema for a valid MBQL 4 :substring clause",
- "allOf" : [ ]
+ "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.legacy-mbql.schema.temporal-extract" : {
- "description" : "schema for a valid MBQL 4 :temporal-extract clause",
- "allOf" : [ ]
+ "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.legacy-mbql.schema.text" : {
- "description" : "schema for a valid MBQL 4 :text clause",
- "allOf" : [ ]
+ "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.legacy-mbql.schema.time" : {
- "description" : "schema for a valid MBQL 4 :time clause",
- "allOf" : [ ]
+ "metabase.lib.schema.expression.integer" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
},
- "metabase.legacy-mbql.schema.time-interval" : {
- "description" : "schema for a valid MBQL 4 :time-interval clause",
- "allOf" : [ ]
+ "metabase.lib.schema.expression.number" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
},
- "metabase.legacy-mbql.schema.today" : {
- "description" : "schema for a valid MBQL 4 :today clause",
- "allOf" : [ ]
+ "metabase.lib.schema.expression.orderable" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
},
- "metabase.legacy-mbql.schema.trim" : {
- "description" : "schema for a valid MBQL 4 :trim clause",
- "allOf" : [ ]
+ "metabase.lib.schema.expression.positive-integer-or-numeric-expression" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.integer"
},
- "metabase.legacy-mbql.schema.upper" : {
- "description" : "schema for a valid MBQL 4 :upper clause",
- "allOf" : [ ]
+ "metabase.lib.schema.expression.string" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
},
- "metabase.legacy-mbql.schema.value" : {
- "description" : "schema for a valid MBQL 4 :value clause",
- "allOf" : [ ]
+ "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-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.schema.expression.temporal..absolute-datetime.base-type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
- "metabase.lib-metric.schema..dimension-reference.options" : {
- "description" : "Options map for dimension references.",
+ "metabase.lib.schema.expression.temporal..absolute-datetime.options" : {
+ "default" : { },
"type" : "object",
"properties" : {
- "binning" : {
+ "database-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.binning"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
@@ -9083,945 +8819,329 @@
"type" : "null"
} ]
},
- "semantic-type" : {
+ "base-type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "temporal-unit" : {
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "include-current" : {
+ "type" : "boolean"
+ },
+ "semantic-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
}
- }
+ },
+ "required" : [ "lib/uuid" ]
},
- "metabase.lib-metric.schema..dimension-source.type" : {
+ "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" : [ "field" ]
+ "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-metric.schema.binning" : {
- "description" : "Schema for `:binning` options passed to a `:dimension` clause.",
+ "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" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.binning-strategy"
- }
- },
- "required" : [ "strategy" ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "const" : "default"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "type" : "object",
- "properties" : {
- "bin-width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.positive-number"
- },
- "strategy" : {
- "const" : "bin-width"
- }
- },
- "required" : [ "strategy", "bin-width" ]
+ "anyOf" : [ {
+ "type" : "string"
}, {
- "type" : "object",
- "properties" : {
- "num-bins" : {
- "type" : "integer",
- "minimum" : 1
- },
- "strategy" : {
- "const" : "num-bins"
- }
- },
- "required" : [ "strategy", "num-bins" ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.zone-offset"
} ]
} ]
},
- "metabase.lib-metric.schema.binning-strategy" : {
+ "metabase.lib.schema.expression.temporal.week-mode" : {
"type" : "string",
- "enum" : [ "bin-width", "default", "num-bins" ]
+ "enum" : [ "iso", "us", "instance" ]
},
- "metabase.lib-metric.schema.dimension-id" : {
- "description" : "UUID string identifying a dimension.",
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "metabase.lib.schema.expression.window..offset.n" : {
+ "type" : "integer"
},
- "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"
+ "metabase.lib.schema.fields" : {
+ "allOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.ref.ref"
+ },
+ "minItems" : 1
}, {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-reference.options"
+ "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
}, {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
+ "$ref" : "#/components/schemas/metabase.lib.schema.deduplicate-refs-ignoring-source-field-name-when-possible"
} ]
},
- "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."
- },
- "metabase.lib-metric.schema.instance-filter" : {
- "description" : "A filter associated with a specific expression instance via lib/uuid.",
+ "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" : {
- "filter" : {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.filter-clause"
- },
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "case-sensitive" : {
+ "type" : "boolean"
}
- },
- "required" : [ "lib/uuid", "filter" ]
- },
- "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" ]
- }, {
- "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" ]
- }, {
- "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.",
+ "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" : {
- "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" ]
+ "include-current" : {
+ "type" : "boolean"
}
- },
- "required" : [ "type", "id", "lib/uuid", "projection" ]
+ }
},
- "metabase.lib-metric.schema.typed-projections" : {
- "description" : "A sequence of typed projections.",
+ "metabase.lib.schema.filters" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.lib-metric.schema.typed-projection"
- }
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
+ },
+ "minItems" : 1
},
- "metabase.lib.metadata.protocols.metadata-provider" : {
- "description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol."
+ "metabase.lib.schema.id.action" : {
+ "description" : "Valid Action ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema..stage.additional" : {
- "oneOf" : [ { }, { } ]
+ "metabase.lib.schema.id.card" : {
+ "description" : "Valid Card ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema..stage.common" : {
- "type" : "object",
- "properties" : {
- "lib/stage-metadata" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
- },
- "parameters" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
- }
- }
+ "metabase.lib.schema.id.dashboard" : {
+ "description" : "Valid Dashboard ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema..stage.initial" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, { } ]
+ "metabase.lib.schema.id.dashcard" : {
+ "description" : "Valid DashboardCard ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema..stage.mbql" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "source-card" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- },
- "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"
- },
- "limit" : {
- "type" : "integer",
- "minimum" : 0
- },
- "joins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.joins"
- },
- "aggregation" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.aggregation.aggregations"
- },
- "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"
- },
- "expressions" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.expressions"
- }
- },
- "required" : [ "lib/type" ]
- }, {
- "$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.id.database" : {
+ "description" : "Valid Database ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema..stage.native" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "collection" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "lib/stage-metadata" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
- },
- "lib/type" : {
- "const" : "mbql.stage/native"
- },
- "native" : { },
- "parameters" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
- },
- "params" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- }, { } ]
- }
- }, {
- "type" : "null"
- } ]
- },
- "query-permissions/referenced-card-ids" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- },
- "uniqueItems" : true
- }, {
- "type" : "null"
- } ]
- },
- "template-tags" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tags"
- }
- },
- "required" : [ "lib/type" ]
- }, {
- "allOf" : [ ]
- } ]
+ "metabase.lib.schema.id.dimension" : {
+ "description" : "Valid Dimension ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "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.id.field" : {
+ "description" : "Valid Field ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema..stage.type" : {
- "type" : "string",
- "enum" : [ "mbql.stage/native", "mbql.stage/mbql" ]
+ "metabase.lib.schema.id.measure" : {
+ "description" : "Valid Measure ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema..stage.valid-refs" : { },
- "metabase.lib.schema..stages.valid-refs" : { },
- "metabase.lib.schema.actions.row" : {
- "type" : "object",
- "additionalProperties" : { }
+ "metabase.lib.schema.id.pulse" : {
+ "description" : "Valid Pulse ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema.aggregation..distinct.arg" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
+ "metabase.lib.schema.id.sandbox" : {
+ "description" : "Valid Sandbox ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema.aggregation..percentile.percentile" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
+ "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.aggregation.aggregation" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ "metabase.lib.schema.id.segment" : {
+ "description" : "Valid legacy Segment ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema.aggregation.aggregations" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.aggregation.aggregation"
- },
- "minItems" : 1
+ "metabase.lib.schema.id.snippet" : {
+ "description" : "Valid Snippet ID",
+ "type" : "integer",
+ "minimum" : 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.id.table" : {
+ "description" : "Valid Table ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema.binning.binning" : {
- "description" : "Schema for `:binning` options passed to a `:field` clause.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "const" : "default"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "type" : "object",
- "properties" : {
- "bin-width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
- },
- "strategy" : {
- "const" : "bin-width"
- }
- },
- "required" : [ "strategy", "bin-width" ]
- }, {
- "type" : "object",
- "properties" : {
- "num-bins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
- },
- "strategy" : {
- "const" : "num-bins"
- }
- },
- "required" : [ "strategy", "num-bins" ]
- } ]
- } ]
+ "metabase.lib.schema.id.transform" : {
+ "description" : "Valid Transform ID",
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase.lib.schema.binning.num-bins" : {
- "description" : "Number of bins to use.",
+ "metabase.lib.schema.id.user" : {
+ "description" : "Valid User ID",
"type" : "integer",
"minimum" : 1
},
- "metabase.lib.schema.binning.strategy" : {
+ "metabase.lib.schema.info.context" : {
+ "description" : "Schema for `info.context`; used for informational purposes to record how a query was executed.",
"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.common.base-type" : {
- "type" : "string"
+ "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "metric", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "table-rows-sample", "transform-inspector", "slackbot", "exploration" ]
},
- "metabase.lib.schema.common.kebab-cased-map" : { },
- "metabase.lib.schema.common.non-blank-string" : {
+ "metabase.lib.schema.info.hash" : {
"type" : "string",
- "minLength" : 1
+ "format" : "byte"
},
- "metabase.lib.schema.common.options" : {
- "default" : { },
+ "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" : {
- "base-type" : {
+ "query-hash" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.info.hash"
}, {
"type" : "null"
} ]
},
- "database-type" : {
+ "action-id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.action"
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "lens-id" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "effective-type" : {
+ "pivot/original-query" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "object",
+ "additionalProperties" : { }
}, {
"type" : "null"
} ]
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "executed-by" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
+ "card-id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
- "semantic-type" : {
+ "pivot/result-metadata" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "oneOf" : [ {
+ "const" : "none"
+ }, {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
+ }
+ } ]
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "lib/uuid" ]
- },
- "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.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
+ "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",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metadata/model-metadata" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "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"
+ } ]
}
}
},
- "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.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.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" : {
- "base-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "database-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "display-name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "effective-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- },
- "name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "semantic-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "lib/uuid" ]
- },
- "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.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.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.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", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "metric", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "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"
- } ]
- },
- "lens-id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "pivot/original-query" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
- }, {
- "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",
- "additionalProperties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "metadata/model-metadata" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
- }
- }, {
- "type" : "null"
- } ]
- },
- "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"
- } ]
- }
- }
- },
- "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.condition" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
},
"metabase.lib.schema.join.conditions" : {
"type" : "array",
@@ -10131,13 +9251,6 @@
"default" : { },
"type" : "object",
"properties" : {
- "base-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
"database-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -10155,6 +9268,13 @@
"effective-type" : {
"type" : "string"
},
+ "base-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
},
@@ -10165,16 +9285,28 @@
"type" : "null"
} ]
},
- "semantic-type" : {
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "unit" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}, {
"type" : "null"
} ]
},
- "unit" : {
+ "include-current" : {
+ "type" : "boolean"
+ },
+ "semantic-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
@@ -11111,26 +10243,18 @@
},
"metabase.lib.schema.metadata.fingerprint..fingerprint.type-specific" : {
"description" : "Schema for type-specific fingerprint information.",
- "allOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "object",
- "properties" : {
- "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" : "object",
+ "properties" : {
+ "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"
}
- } ]
+ }
},
"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.",
@@ -11618,6 +10742,18 @@
"$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"
+ }
+ }
+ },
"metabase.lib.schema.parameter..parameter.value" : { },
"metabase.lib.schema.parameter..target.legacy-expression-ref" : {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.expression"
@@ -11650,28 +10786,43 @@
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"metabase.lib.schema.parameter.parameter" : {
- "description" : "Schema for the *value* of a parameter (e.g. a Dashboard parameter or a native query template tag) as passed in as\n part of the `:parameters` list in a query.\n\n Note that this is different from the parameter declarations that are saved as part of Dashboards and Cards; for THAT\n schema refer to `:metabase.parameters.schema/parameter`.",
+ "description" : "parameter must be a map with a :type key",
"allOf" : [ {
"type" : "object",
"properties" : {
- "default" : { },
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
},
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "required" : { },
"slug" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "target" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ "value" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ },
+ "required" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
"type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
},
- "value" : {
+ "target" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ },
+ "options" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.options"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "default" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
}
},
@@ -11818,28 +10969,28 @@
"default" : { },
"type" : "object",
"properties" : {
- "base-type" : {
+ "database-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "database-type" : {
+ "display-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "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"
}, {
@@ -11856,15 +11007,27 @@
"type" : "null"
} ]
},
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "include-current" : {
+ "type" : "boolean"
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
- },
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}
},
"required" : [ "lib/uuid" ]
@@ -11927,6 +11090,13 @@
"base-type" : {
"type" : "string"
},
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
},
@@ -11937,9 +11107,18 @@
"type" : "null"
} ]
},
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
"lib/original-effective-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
@@ -11949,6 +11128,9 @@
"lib/original-binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
+ "include-current" : {
+ "type" : "boolean"
+ },
"temporal-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
@@ -12013,6 +11195,13 @@
"type" : "null"
} ]
},
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
},
@@ -12023,9 +11212,18 @@
"type" : "null"
} ]
},
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
"lib/original-effective-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
},
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
"source-field" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
@@ -12035,6 +11233,9 @@
"lib/original-binning" : {
"$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
+ "include-current" : {
+ "type" : "boolean"
+ },
"temporal-unit" : {
"$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
},
@@ -12061,13 +11262,6 @@
"default" : { },
"type" : "object",
"properties" : {
- "base-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
"database-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -12086,8 +11280,12 @@
"type" : "null"
} ]
},
- "lib/source-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "base-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
},
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
@@ -12096,6 +11294,19 @@
"type" : "string",
"minLength" : 1
},
+ "lib/expression-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
+ "lib/source-name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "include-current" : {
+ "type" : "boolean"
+ },
"semantic-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
@@ -12128,14 +11339,6 @@
"lib/type" : "mbql.stage/mbql"
},
"allOf" : [ {
- "type" : "object",
- "properties" : {
- "lib/type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema..stage.type"
- }
- },
- "required" : [ "lib/type" ]
- }, {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema..stage.native"
}, {
@@ -12158,14 +11361,21 @@
} ]
},
"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" : { }
+ "properties" : {
+ "case-sensitive" : {
+ "type" : "boolean"
+ },
+ "include-current" : {
+ "type" : "boolean"
+ }
+ }
},
"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" : {
@@ -12383,28 +11593,18 @@
} ]
},
"metabase.lib.schema.template-tag.template-tag" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.type"
- }
- },
- "required" : [ "type" ]
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.temporal-unit"
}, {
- "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"
- } ]
+ "$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-tags" : {
@@ -12442,11 +11642,6 @@
},
"required" : [ "name", "display-name", "type" ]
},
- "metabase.lib.schema.template-tag.type" : {
- "description" : "Schema for valid values of template tag `:type`.",
- "type" : "string",
- "enum" : [ "snippet", "card", "dimension", "number", "text", "date", "boolean", "temporal-unit", "table" ]
- },
"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"
@@ -12569,6 +11764,7 @@
"minimum" : 1
},
"definition" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -12607,21 +11803,17 @@
"type" : "object",
"properties" : {
"query" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.query"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Query"
- } ]
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
}
}
}
},
"query" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.query"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Query"
- } ]
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
},
"type" : {
"type" : "string",
@@ -12633,11 +11825,9 @@
"type" : "object",
"properties" : {
"query" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.query"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Query"
- } ]
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
},
"type" : {
"type" : "string",
@@ -12868,6 +12058,7 @@
} ]
},
"dataset_query" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -13358,1084 +12549,476 @@
"metabase.notification.api.notification.NotificationApiInput" : {
"description" : "Notification schema for API input. Like FullyHydratedNotification but restricts templates\n to user-provided types only (no handlebars-resource).",
"oneOf" : [ {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ]
- }
- },
- "payload" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
- },
- "payload_id" : {
- "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" ]
- }, {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ]
- }
- },
- "payload_id" : {
- "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" ]
- } ]
- }, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "creator_id" : {
- "type" : "integer"
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ]
- }
- },
- "payload" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
- },
- "payload_id" : {
- "type" : "integer"
- },
- "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"
- }
- }
+ "type" : "object",
+ "properties" : {
+ "payload_type" : {
+ "type" : "string",
+ "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ]
},
- "required" : [ "payload_type", "payload" ]
- }, {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "creator_id" : {
- "type" : "integer"
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ]
- }
- },
- "payload_id" : {
+ "payload_id" : {
+ "oneOf" : [ {
"type" : "integer"
- },
- "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" ]
- } ]
- }, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ]
- }
- },
- "payload" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
- },
- "subscriptions" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
- }
- }
- },
- "required" : [ "payload" ]
- }, {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ]
- }
- },
- "subscriptions" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
- }
- }
- }
- } ]
- } ]
- },
- "metabase.notification.models.FullyHydratedNotification" : {
- "description" : "Fully hydrated notification.",
- "oneOf" : [ {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ]
- }
- },
- "payload" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
- },
- "payload_id" : {
- "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" ]
- }, {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ]
- }
- },
- "payload_id" : {
+ }, {
"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" ]
- } ]
- }, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "creator_id" : {
- "type" : "integer"
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
+ "handlers" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "template_id" : {
+ "oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ]
- }
- },
- "payload" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
- },
- "payload_id" : {
- "type" : "integer"
- },
- "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" ]
- }, {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "creator_id" : {
- "type" : "integer"
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "recipients" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
}
},
- "required" : [ "channel_type" ]
- }
- },
- "payload_id" : {
- "type" : "integer"
- },
- "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"
- }
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "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" ]
}
},
- "required" : [ "payload_type" ]
- } ]
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "creator" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "payload" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "subscriptions" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
+ }
+ }
+ },
+ "required" : [ "payload_type", "payload" ]
}, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "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
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "channel_type" ]
- }
- },
- "payload" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
- },
- "subscriptions" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
- }
- }
- },
- "required" : [ "payload" ]
- }, {
- "type" : "object",
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "handlers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
+ "channel_id" : {
+ "oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
- },
- "recipients" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- }
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "recipients" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
}
},
- "required" : [ "channel_type" ]
- }
- },
- "subscriptions" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
- }
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "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" ]
+ }
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "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" ]
} ]
},
- "metabase.notification.models.Notification" : {
+ "metabase.notification.models.FullyHydratedNotification" : {
+ "description" : "Fully hydrated notification.",
"oneOf" : [ {
"type" : "object",
"properties" : {
- "payload_id" : {
- "type" : "null"
- },
"payload_type" : {
"type" : "string",
"enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ]
+ },
+ "payload_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "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
+ },
+ "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" : { },
+ "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" ]
+ }
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "creator" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "payload" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "subscriptions" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
+ }
}
},
- "required" : [ "payload_type" ]
+ "required" : [ "payload_type", "payload" ]
}, {
"type" : "object",
"properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
"creator_id" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "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
+ },
+ "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" : { },
+ "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" ]
+ }
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
"payload_id" : {
- "type" : "integer"
+ "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" ]
- }, { } ]
+ } ]
},
"metabase.notification.models.NotificationCard" : {
"description" : "Schema for :model/NotificationCard.",
@@ -14443,6 +13026,7 @@
"properties" : {
"card" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -14454,6 +13038,24 @@
"type" : "integer",
"minimum" : 1
},
+ "id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "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" ]
@@ -14484,6 +13086,11 @@
} ]
},
"channel_type" : { },
+ "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",
@@ -14507,6 +13114,11 @@
"type" : "object",
"properties" : {
"details" : { },
+ "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",
@@ -14528,6 +13140,11 @@
"type" : "object",
"properties" : {
"details" : { },
+ "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",
@@ -14563,6 +13180,11 @@
"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",
@@ -14592,6 +13214,11 @@
"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",
@@ -14622,6 +13249,14 @@
"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" ]
@@ -14637,6 +13272,14 @@
"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" ]
@@ -14702,6 +13345,13 @@
"type" : "null"
} ]
},
+ "display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
},
@@ -14711,6 +13361,16 @@
"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"
@@ -14741,7 +13401,23 @@
"type" : "null"
} ]
},
- "default" : { }
+ "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" ]
},
@@ -14756,10 +13432,6 @@
"type" : "null"
} ]
},
- "dashcard" : {
- "type" : "object",
- "properties" : { }
- },
"parameter_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
},
@@ -14775,6 +13447,50 @@
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
}
},
+ "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" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "options" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.options"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "value" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ }
+ },
+ "required" : [ "id" ]
+ },
"metabase.parameters.schema.parameters" : {
"type" : "array",
"items" : {
@@ -15269,7 +13985,10 @@
},
"metabase.tiles.api.parameters" : {
"description" : "Form-encoded JSON-encoded array of parameter maps.",
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
+ }
},
"metabase.tiles.api.query" : {
"description" : "Form-encoded JSON-encoded MBQL query.",
@@ -16989,6 +15708,31 @@
"description" : "Server error response"
}
},
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }
+ },
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "schema", "data" ]
+ }
+ }
+ }
+ },
"tags" : [ "/api/analytics-proxy" ]
}
},
@@ -19182,6 +17926,16 @@
}, {
"type" : "null"
} ]
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
+ }
+ }, {
+ "type" : "null"
+ } ]
}
}
}
@@ -19404,6 +18158,16 @@
"ignore_cache" : {
"default" : false,
"type" : "boolean"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
+ }
+ }, {
+ "type" : "null"
+ } ]
}
},
"required" : [ ]
@@ -20136,6 +18900,7 @@
} ]
},
"details" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -20179,6 +18944,7 @@
"type" : "object",
"properties" : {
"details" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -20270,6 +19036,7 @@
},
"details" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -20570,6 +19337,7 @@
"type" : "object",
"properties" : {
"groups" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -21830,20 +20598,7 @@
"oneOf" : [ {
"type" : "array",
"items" : {
- "description" : "value must be a parameter map with an 'id' key",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "id" ]
- }, {
- "type" : "object",
- "additionalProperties" : { }
- } ]
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
}
}, {
"type" : "null"
@@ -21988,20 +20743,7 @@
"oneOf" : [ {
"type" : "array",
"items" : {
- "description" : "value must be a parameter map with an 'id' key",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "id" ]
- }, {
- "type" : "object",
- "additionalProperties" : { }
- } ]
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
}
}, {
"type" : "null"
@@ -22081,20 +20823,7 @@
"anyOf" : [ {
"type" : "array",
"items" : {
- "description" : "value must be a parameter map with an 'id' key",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "id" ]
- }, {
- "type" : "object",
- "additionalProperties" : { }
- } ]
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
}
}, {
"description" : "value must be a valid JSON string.",
@@ -22483,6 +21212,13 @@
"type" : "null"
} ]
},
+ "auto_apply_filters" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"width" : {
"type" : "string",
"enum" : [ "fixed", "full" ]
@@ -22564,6 +21300,11 @@
"name" : {
"type" : "string",
"minLength" : 1
+ },
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
}
},
"required" : [ "id", "name" ]
@@ -22611,14 +21352,6 @@
"items" : {
"type" : "object",
"properties" : {
- "col" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
- },
- "id" : {
- "type" : "integer"
- },
"inline_parameters" : {
"oneOf" : [ {
"type" : "array",
@@ -22630,6 +21363,22 @@
"type" : "null"
} ]
},
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_tab_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
@@ -22637,17 +21386,14 @@
"type" : "null"
} ]
},
- "row" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
+ "id" : {
+ "type" : "integer"
},
- "series" : {
+ "card_id" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object"
- }
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
@@ -22661,6 +21407,37 @@
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
+ },
+ "col" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "row" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "series" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "action_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
}
},
"required" : [ "id", "size_x", "size_y", "row", "col" ]
@@ -22722,14 +21499,6 @@
"items" : {
"type" : "object",
"properties" : {
- "col" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
- },
- "id" : {
- "type" : "integer"
- },
"inline_parameters" : {
"oneOf" : [ {
"type" : "array",
@@ -22741,6 +21510,22 @@
"type" : "null"
} ]
},
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_tab_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
"parameter_mappings" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
@@ -22748,17 +21533,14 @@
"type" : "null"
} ]
},
- "row" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
+ "id" : {
+ "type" : "integer"
},
- "series" : {
+ "card_id" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object"
- }
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
@@ -22772,6 +21554,37 @@
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
+ },
+ "col" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "row" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "series" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "action_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
}
},
"required" : [ "id", "size_x", "size_y", "row", "col" ]
@@ -22791,6 +21604,11 @@
"name" : {
"type" : "string",
"minLength" : 1
+ },
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
}
},
"required" : [ "id", "name" ]
@@ -23014,20 +21832,7 @@
"anyOf" : [ {
"type" : "array",
"items" : {
- "description" : "value must be a parameter map with an 'id' key",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "id" ]
- }, {
- "type" : "object",
- "additionalProperties" : { }
- } ]
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
}
}, {
"description" : "value must be a valid JSON string.",
@@ -23633,6 +22438,7 @@
"type" : "object",
"properties" : {
"details" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -23778,6 +22584,13 @@
"type" : "null"
} ]
},
+ "is_on_demand" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"cache_ttl" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -23805,6 +22618,13 @@
"type" : "null"
} ]
},
+ "is_full_sync" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"auto_run_queries" : {
"oneOf" : [ {
"type" : "boolean"
@@ -25173,91 +23993,7 @@
"cards" : {
"oneOf" : [ {
"type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : {
- "visualization_settings" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- },
- "entity_id" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "dataset_query" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "result_metadata" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "null"
- } ]
- },
- "cache_ttl" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "display" : {
- "type" : "string",
- "minLength" : 1
- },
- "parameters" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "name", "dataset_query", "display", "visualization_settings" ]
- }
+ "additionalProperties" : { }
}, {
"type" : "null"
} ]
@@ -25410,91 +24146,7 @@
"cards" : {
"oneOf" : [ {
"type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : {
- "visualization_settings" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- },
- "entity_id" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "dataset_query" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "result_metadata" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "null"
- } ]
- },
- "cache_ttl" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "display" : {
- "type" : "string",
- "minLength" : 1
- },
- "parameters" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "name", "dataset_query", "display", "visualization_settings" ]
- }
+ "additionalProperties" : { }
}, {
"type" : "null"
} ]
@@ -25811,10 +24463,12 @@
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"
},
"input" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
"params" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -25859,6 +24513,7 @@
"inputs" : {
"type" : "array",
"items" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -26013,7 +24668,23 @@
"application/json" : {
"schema" : {
"type" : "object",
- "properties" : { }
+ "properties" : {
+ "groups" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }
+ },
+ "revision" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ }
+ },
+ "required" : [ "revision", "groups" ]
}
}
}
@@ -27017,7 +25688,19 @@
"schema" : {
"oneOf" : [ {
"type" : "object",
- "properties" : { }
+ "properties" : {
+ "force-end-trial" : {
+ "type" : "boolean"
+ },
+ "new-plan-alias" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "plan-alias" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }
}, {
"type" : "null"
} ]
@@ -27162,9 +25845,12 @@
"filename" : {
"type" : "string"
},
+ "size" : {
+ "type" : "integer"
+ },
"tempfile" : { }
},
- "required" : [ "filename", "tempfile" ]
+ "required" : [ "filename", "size", "tempfile" ]
}
},
"required" : [ "file" ]
@@ -27291,9 +25977,14 @@
"filename" : {
"type" : "string"
},
+ "size" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
"tempfile" : { }
},
- "required" : [ "filename", "tempfile" ]
+ "required" : [ "filename", "size", "tempfile" ]
}
},
"required" : [ "file" ]
@@ -27991,9 +26682,14 @@
"filename" : {
"type" : "string"
},
+ "size" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
"tempfile" : { }
},
- "required" : [ "filename", "tempfile" ]
+ "required" : [ "filename", "size", "tempfile" ]
}
},
"required" : [ "file" ]
@@ -31954,8 +30650,7 @@
} ]
},
"transform_target" : {
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
}
},
"required" : [ "card_id", "transform_name", "transform_target" ]
@@ -32764,8 +31459,16 @@
"type" : "string",
"minLength" : 1
},
+ "path" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
"value" : {
- "anyOf" : [ {
+ "oneOf" : [ {
"type" : "object",
"additionalProperties" : {
"anyOf" : [ {
@@ -32776,10 +31479,12 @@
} ]
}
}, {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "boolean"
+ "anyOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "boolean"
+ } ]
} ]
}
},
@@ -33694,198 +32399,206 @@
"properties" : {
"attributes" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "slug" : {
- "description" : "invalid slug",
- "type" : "string",
- "pattern" : "^[-_a-z0-9]{1,255}$"
- }
- },
- "required" : [ "name", "slug" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "tags" : [ "/api/ee/tenant" ]
- },
- "get" : {
- "operationId" : "get-api-ee-tenant",
- "summary" : "GET /api/ee/tenant",
- "description" : "Get all tenants",
- "parameters" : [ {
- "in" : "query",
- "name" : "status",
- "required" : false,
- "schema" : {
- "default" : "all",
- "type" : "string",
- "enum" : [ "all", "deactivated", "active" ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "attributes" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "is_active" : {
- "type" : "boolean"
- },
- "member_count" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "slug" : {
- "description" : "invalid slug",
- "type" : "string",
- "pattern" : "^[-_a-z0-9]{1,255}$"
- },
- "tenant_collection_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
- "additionalProperties" : false
- }
- }
- },
- "required" : [ "data" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/tenant" ]
- }
- },
- "/api/ee/tenant/{id}" : {
- "put" : {
- "operationId" : "put-api-ee-tenant-id",
- "summary" : "PUT /api/ee/tenant/{id}",
- "description" : "Update a tenant, can set name, attributes, or whether this tenant is active.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "attributes" : {
- "oneOf" : [ {
+ "allOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "description" : "attribute keys must be a keyword or string and must not start with `@`"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "type" : "string",
+ "pattern" : "^[-_a-z0-9]{1,255}$"
+ }
+ },
+ "required" : [ "name", "slug" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/tenant" ]
+ },
+ "get" : {
+ "operationId" : "get-api-ee-tenant",
+ "summary" : "GET /api/ee/tenant",
+ "description" : "Get all tenants",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "status",
+ "required" : false,
+ "schema" : {
+ "default" : "all",
+ "type" : "string",
+ "enum" : [ "all", "deactivated", "active" ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "attributes" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_active" : {
+ "type" : "boolean"
+ },
+ "member_count" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "type" : "string",
+ "pattern" : "^[-_a-z0-9]{1,255}$"
+ },
+ "tenant_collection_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
+ "additionalProperties" : false
+ }
+ }
+ },
+ "required" : [ "data" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/tenant" ]
+ }
+ },
+ "/api/ee/tenant/{id}" : {
+ "put" : {
+ "operationId" : "put-api-ee-tenant-id",
+ "summary" : "PUT /api/ee/tenant/{id}",
+ "description" : "Update a tenant, can set name, attributes, or whether this tenant is active.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "attributes" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_active" : {
+ "type" : "boolean"
+ },
+ "member_count" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "type" : "string",
+ "pattern" : "^[-_a-z0-9]{1,255}$"
+ },
+ "tenant_collection_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "attributes" : {
+ "oneOf" : [ {
+ "allOf" : [ {
"type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
+ "additionalProperties" : { }
}, {
- "type" : "null"
+ "description" : "attribute keys must be a keyword or string and must not start with `@`"
} ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "is_active" : {
- "type" : "boolean"
- },
- "member_count" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "slug" : {
- "description" : "invalid slug",
- "type" : "string",
- "pattern" : "^[-_a-z0-9]{1,255}$"
- },
- "tenant_collection_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "attributes" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
}, {
"type" : "null"
} ]
@@ -34302,16 +33015,9 @@
} ]
},
"query" : {
+ "description" : "Value must be a map.",
"type" : "object",
- "properties" : {
- "database" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }
+ "properties" : { }
}
},
"required" : [ "query" ]
@@ -34408,7 +33114,12 @@
"properties" : {
"entity_ids" : {
"type" : "object",
- "properties" : { }
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
}
},
"required" : [ "entity_ids" ]
@@ -34720,6 +33431,7 @@
"minLength" : 1
},
"settings" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}
@@ -34772,6 +33484,7 @@
"minLength" : 1
},
"settings" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}
@@ -34871,6 +33584,7 @@
},
"settings" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -35339,6 +34053,13 @@
"type" : "string",
"minLength" : 1
}
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
@@ -36330,29 +35051,58 @@
"explore_filters" : {
"type" : "array",
"items" : {
- "type" : "object",
- "properties" : {
- "dimension_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_value" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "dimension_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_value" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "field_ref" : {
+ "type" : "array",
+ "items" : { }
+ },
+ "operator" : {
+ "const" : "="
+ },
+ "value" : { }
},
- "field_ref" : {
- "type" : "array",
- "items" : { }
+ "required" : [ "operator", "field_ref", "value", "display_value" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "dimension_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_value" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "field_ref" : {
+ "type" : "array",
+ "items" : { }
+ },
+ "operator" : {
+ "const" : "between"
+ },
+ "values" : {
+ "type" : "array",
+ "prefixItems" : [ { }, { } ]
+ }
},
- "value" : { }
- },
- "required" : [ "field_ref", "value" ]
+ "required" : [ "operator", "field_ref", "values", "display_value" ]
+ } ]
},
"minItems" : 1
},
@@ -37764,14 +36514,14 @@
"schema" : {
"type" : "object",
"properties" : {
- "ldap-enabled" : {
+ "ldap-host" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "ldap-host" : {
+ "ldap-attribute-email" : {
"oneOf" : [ {
"type" : "string"
}, {
@@ -37792,6 +36542,92 @@
}, {
"type" : "null"
} ]
+ },
+ "ldap-bind-dn" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-group-membership-filter" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-group-sync" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-attribute-firstname" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-group-mappings" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-user-base" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-security" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "none", "ssl", "starttls" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-user-filter" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-attribute-lastname" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-group-base" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-enabled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}
}
@@ -38491,6 +37327,7 @@
},
"definition" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -39173,6 +38010,7 @@
"properties" : {
"visualization_settings" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -39189,6 +38027,7 @@
} ]
},
"dataset_query" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -39288,6 +38127,7 @@
} ]
},
"dataset_query" : {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
},
@@ -39308,6 +38148,7 @@
},
"visualization_settings" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -39906,7 +38747,7 @@
"required" : false,
"schema" : {
"type" : "string",
- "enum" : [ "anthropic", "openai", "mistral", "azure", "bedrock", "zai", "metabase", "openrouter" ]
+ "enum" : [ "anthropic", "openai", "mistral", "azure", "moonshot", "bedrock", "zai", "metabase", "openrouter" ]
}
} ],
"responses" : {
@@ -40103,7 +38944,7 @@
},
"provider" : {
"type" : "string",
- "enum" : [ "anthropic", "openai", "mistral", "azure", "bedrock", "zai", "metabase", "openrouter" ]
+ "enum" : [ "anthropic", "openai", "mistral", "azure", "moonshot", "bedrock", "zai", "metabase", "openrouter" ]
}
},
"required" : [ "provider" ]
@@ -40173,9 +39014,11 @@
"required" : [ "type", "challenge" ]
}, {
"type" : "object",
+ "additionalProperties" : { },
"properties" : {
"event" : {
"type" : "object",
+ "additionalProperties" : { },
"properties" : {
"event_ts" : {
"type" : "string"
@@ -40224,6 +39067,22 @@
"description" : "Server error response"
}
},
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "payload" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "payload" ]
+ }
+ }
+ }
+ },
"tags" : [ "/api/metabot/slack" ]
}
},
@@ -42527,6 +41386,13 @@
"type" : "null"
} ]
},
+ "synchronous?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"table_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -43119,7 +41985,117 @@
"application/json" : {
"schema" : {
"type" : "object",
- "properties" : { }
+ "properties" : {
+ "force" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "groups" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "impersonations" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "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" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "revision" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "sandboxes" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "attribute_remappings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "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
+ }
+ }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "groups" ]
}
}
}
@@ -44674,7 +43650,9 @@
"in" : "query",
"name" : "value",
"required" : true,
- "schema" : { }
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
@@ -44798,6 +43776,17 @@
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "ignore_cache",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -44862,6 +43851,17 @@
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "csv_include_bom",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -44891,6 +43891,18 @@
"pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
"description" : "value must be a valid UUID."
+ }, {
+ "in" : "query",
+ "name" : "dashboard_load_id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -44950,6 +43962,17 @@
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "ignore_cache",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -45022,6 +44045,13 @@
"schema" : {
"type" : "object",
"properties" : {
+ "csv_include_bom" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"format_rows" : {
"default" : false,
"type" : "boolean"
@@ -45030,8 +44060,7 @@
"oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
}
}, {
"type" : "null"
@@ -45091,10 +44120,31 @@
"schema" : {
"type" : "object",
"properties" : {
+ "modelId" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
"parameters" : {
"oneOf" : [ {
"type" : "object",
- "additionalProperties" : { }
+ "additionalProperties" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
}, {
"type" : "null"
} ]
@@ -45158,7 +44208,19 @@
"properties" : {
"parameters" : {
"type" : "object",
- "additionalProperties" : { }
+ "additionalProperties" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
}
},
"required" : [ "parameters" ]
@@ -45195,7 +44257,9 @@
"in" : "query",
"name" : "value",
"required" : true,
- "schema" : { }
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
@@ -45420,6 +44484,13 @@
"schema" : {
"type" : "object",
"properties" : {
+ "csv_include_bom" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"format_rows" : {
"default" : false,
"type" : "boolean"
@@ -45429,9 +44500,7 @@
"anyOf" : [ {
"type" : "array",
"items" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
}
}, {
"description" : "value must be a valid JSON string.",
@@ -45539,6 +44608,17 @@
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "ignore_cache",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -45598,6 +44678,17 @@
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "ignore_cache",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -45896,8 +44987,7 @@
"oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
}
}, {
"type" : "null"
@@ -45963,9 +45053,7 @@
"schema" : {
"type" : "object",
"properties" : {
- "cards" : { },
- "channels" : { },
- "collection_id" : {
+ "id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
@@ -45974,6 +45062,10 @@
"type" : "null"
} ]
},
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
"collection_position" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -45983,7 +45075,30 @@
"type" : "null"
} ]
},
- "dashboard_id" : {
+ "skip_if_empty" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "alert_above_goal" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "alert_condition" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "rows", "goal" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
@@ -45992,6 +45107,13 @@
"type" : "null"
} ]
},
+ "alert_first_only" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"disable_links" : {
"default" : false,
"oneOf" : [ {
@@ -46000,18 +45122,27 @@
"type" : "null"
} ]
},
- "name" : {
- "type" : "string",
- "minLength" : 1
+ "parameters" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-with-value"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "skip_if_empty" : {
- "default" : false,
+ "cards" : { },
+ "dashboard_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
- }
+ },
+ "channels" : { }
},
"required" : [ "name", "cards", "channels" ]
}
@@ -46193,6 +45324,15 @@
"type" : "null"
} ]
},
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
"name" : {
"oneOf" : [ {
"type" : "string",
@@ -46205,9 +45345,7 @@
"oneOf" : [ {
"type" : "array",
"items" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
}
}, {
"type" : "null"
@@ -47291,6 +46429,7 @@
},
"definition" : {
"oneOf" : [ {
+ "description" : "Value must be a map.",
"type" : "object",
"properties" : { }
}, {
@@ -48810,24 +47949,28 @@
"content" : {
"multipart/form-data" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "collection_id" : {
- "type" : "string"
- },
- "file" : {
- "type" : "object",
- "properties" : {
- "filename" : {
- "type" : "string"
- },
- "tempfile" : { }
+ "allOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { },
+ "properties" : {
+ "collection_id" : {
+ "type" : "string"
},
- "required" : [ "filename", "tempfile" ]
- }
- },
- "required" : [ "file" ],
- "additionalProperties" : false
+ "file" : {
+ "type" : "object",
+ "properties" : {
+ "filename" : {
+ "type" : "string"
+ },
+ "tempfile" : { }
+ },
+ "required" : [ "filename", "tempfile" ]
+ }
+ },
+ "required" : [ "file" ]
+ }, {
+ "description" : "unexpected multipart part"
+ } ]
}
}
}
@@ -49088,24 +48231,28 @@
"content" : {
"multipart/form-data" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "collection_id" : {
- "type" : "string"
- },
- "file" : {
- "type" : "object",
- "properties" : {
- "filename" : {
- "type" : "string"
- },
- "tempfile" : { }
+ "allOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { },
+ "properties" : {
+ "collection_id" : {
+ "type" : "string"
},
- "required" : [ "filename", "tempfile" ]
- }
- },
- "required" : [ "file" ],
- "additionalProperties" : false
+ "file" : {
+ "type" : "object",
+ "properties" : {
+ "filename" : {
+ "type" : "string"
+ },
+ "tempfile" : { }
+ },
+ "required" : [ "filename", "tempfile" ]
+ }
+ },
+ "required" : [ "file" ]
+ }, {
+ "description" : "unexpected multipart part"
+ } ]
}
}
}
@@ -55677,37 +54824,37 @@
"schema" : {
"type" : "object",
"properties" : {
- "email" : {
- "description" : "value must be a valid email address.",
- "type" : "string"
+ "login_attributes" : {
+ "oneOf" : [ {
+ "allOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "description" : "login attribute keys must not start with `@`"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "first_name" : {
+ "user_group_memberships" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.users.schema.user-group-membership"
+ }
}, {
"type" : "null"
} ]
},
- "invite_target" : {
+ "email" : {
+ "description" : "value must be a valid email address.",
+ "type" : "string"
+ },
+ "tenant_id" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : {
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "type" : {
- "type" : "string",
- "enum" : [ "dashboard", "question" ]
- }
- },
- "required" : [ "type", "id", "name" ]
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
@@ -55720,10 +54867,10 @@
"type" : "null"
} ]
},
- "login_attributes" : {
+ "first_name" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
@@ -55736,21 +54883,33 @@
"type" : "null"
} ]
},
- "tenant_id" : {
+ "password" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "user_group_memberships" : {
+ "invite_target" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.users.schema.user-group-membership"
- }
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "dashboard", "question" ]
+ }
+ },
+ "required" : [ "type", "id", "name" ]
}, {
"type" : "null"
} ]
@@ -56016,8 +55175,12 @@
"properties" : {
"login_attributes" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "allOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "description" : "login attribute keys must not start with `@`"
+ } ]
}, {
"type" : "null"
} ]
@@ -56199,6 +55362,13 @@
"schema" : {
"type" : "object",
"properties" : {
+ "old_password" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"password" : {
"description" : "password is too common.",
"type" : "string"
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index e223425a329..5f21cc85c26 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -222,6 +222,8 @@ config:
llm-metabot-provider: anthropic/claude-sonnet-4-6
llm-mistral-api-base-url: https://api.mistral.ai/v1
llm-mistral-api-key: null
+ llm-moonshot-api-base-url: https://api.moonshot.ai/v1
+ llm-moonshot-api-key: null
llm-openai-api-base-url: https://api.openai.com
llm-openai-api-key: null
llm-openai-model: gpt-5.4
@@ -353,4 +355,5 @@ config:
usage-metadata-schedule: 0 0 2 * * ? *
use-native-pivot-tables: false
user-visibility: all
+ warehouse-allowed-networks: null
```
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 95044467eac..67963429ed3 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -1390,7 +1390,7 @@ Maximum tokens for LLM responses.
- Default: `anthropic/claude-sonnet-4-6`
- [Configuration file name](./config-file.md): `llm-metabot-provider`
-The AI provider and model for Metabot. Format: provider/model-name, e.g. `anthropic/claude-haiku-4-5`, `openai/gpt-5.4`, `openrouter/anthropic/claude-haiku-4.5`.
+The AI provider and model for Metabot. Format: provider/model-name, e.g. `anthropic/claude-haiku-4-5`, `openai/gpt-5.4`, `moonshot/kimi-k3`, `openrouter/anthropic/claude-haiku-4.5`.
### `MB_LLM_MISTRAL_API_BASE_URL`
@@ -1408,6 +1408,22 @@ The Mistral API base URL used for Chat Completions.
The Mistral API Key.
+### `MB_LLM_MOONSHOT_API_BASE_URL`
+
+- Type: string
+- Default: `https://api.moonshot.ai/v1`
+- [Configuration file name](./config-file.md): `llm-moonshot-api-base-url`
+
+The Moonshot AI API base URL used for Chat Completions. Repoint this to use the `.cn` platform; keys are not interchangeable between the two.
+
+### `MB_LLM_MOONSHOT_API_KEY`
+
+- Type: string
+- Default: `null`
+- [Configuration file name](./config-file.md): `llm-moonshot-api-key`
+
+The Moonshot AI API Key.
+
### `MB_LLM_OPENAI_API_BASE_URL`
- Type: string
@@ -2667,6 +2683,19 @@ When enabled, run pivot queries as a single native GROUPING SETS query on driver
Note: Sandboxed users will never see suggestions.
+### `MB_WAREHOUSE_ALLOWED_NETWORKS`
+
+- Type: keyword
+- Default: `null`
+
+Controls which networks Metabase may connect to for warehouse connections.
+Options:
+- external-only (only globally routable public addresses)
+- allow-private (external + private networks but NOT loopback or link-local)
+- allow-all (no restrictions).
+Defaults to external-only on Metabase Cloud and allow-all when self-hosted.
+Also covers the SSH tunnel host and the database auth-provider URLs.
+
## Other environment variables
The following environment variables can only be set via the environment. They cannot be set by the configuration file.