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

github-automation-metabaseb4eb9ba39f84
diff --git a/docs/api.json b/docs/api.json
index 5d92719d0dc..546568db06d 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -1141,7 +1141,9 @@
"const" : "value"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal..value.options"
- }, { } ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..value.value"
+ } ]
},
"mbql.clause.var" : {
"type" : "array",
@@ -1153,6 +1155,11 @@
"$ref" : "#/components/schemas/metabase.lib.schema.expression.number"
} ]
},
+ "metabase-enterprise.action-v2.api.action-value-map" : {
+ "description" : "A map from parameter name / column name to a value. Keys are keywords: the request decoder keywordizes map keys and\n the handler reads them via `(keyword ...)`, so the FE never sends anything else.\n\n Same shape as [[metabase.actions.schema/execute-parameter-values]]. Decoding sees a permissive\n `[:map-of :keyword :any]` and the values are validated against, rather than decoded through,\n [[strict-action-value-map]].",
+ "type" : "object",
+ "additionalProperties" : { }
+ },
"metabase-enterprise.action-v2.api.api-action-expression" : {
"description" : "Value must be a map.",
"type" : "object",
@@ -2300,6 +2307,15 @@
"type" : "null"
} ]
},
+ "metabase-enterprise.scim.v2.api.patch-value" : {
+ "description" : "A single attribute value in a PATCH operation. The strings clients send for booleans are parsed by the handler.",
+ "anyOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "boolean"
+ } ]
+ },
"metabase-enterprise.security-center.schema.advisory-id" : {
"type" : "string",
"minLength" : 1
@@ -2699,8 +2715,7 @@
"$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
},
"params" : {
- "type" : "object",
- "additionalProperties" : { }
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-params"
},
"reason" : {
"type" : "string"
@@ -2865,6 +2880,25 @@
},
"required" : [ "id", "display_name" ]
},
+ "metabase-enterprise.transforms-inspector.schema.lens-params" : {
+ "description" : "Params passed to a drill lens (e.g. `{:join_step 2}`), emitted on drill-lens triggers and echoed back by the FE\n to the lens endpoints. Scalar values only.",
+ "type" : "object",
+ "additionalProperties" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "integer"
+ }, {
+ "type" : "boolean"
+ }, {
+ "type" : "number"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
"metabase-enterprise.transforms-inspector.schema.lens-summary" : {
"description" : "Summary section of a lens.",
"type" : "object",
@@ -3137,7 +3171,7 @@
},
"dataset_query" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
@@ -3203,7 +3237,7 @@
},
"dataset_query" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
@@ -3409,7 +3443,7 @@
},
"dataset_query" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
@@ -3477,7 +3511,7 @@
},
"dataset_query" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
@@ -3549,6 +3583,11 @@
}
} ]
},
+ "metabase.actions.schema..execute-parameter-values.string-keys" : {
+ "description" : "value must map parameter ids to scalar values.",
+ "type" : "object",
+ "additionalProperties" : { }
+ },
"metabase.actions.schema..http-action.json-query" : {
"description" : "must be a valid json-query, something like '.item.title'",
"type" : "string"
@@ -3781,7 +3820,7 @@
},
"dataset_query" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
@@ -3875,7 +3914,7 @@
},
"dataset_query" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
}, {
"type" : "null"
} ]
@@ -3973,11 +4012,21 @@
"required" : [ "id" ]
} ]
},
+ "metabase.actions.schema.execute-parameter-values" : {
+ "description" : "value must map parameter ids to scalar values.",
+ "type" : "object",
+ "additionalProperties" : { }
+ },
"metabase.actions.schema.id" : {
"description" : "Valid Action ID",
"type" : "integer",
"minimum" : 1
},
+ "metabase.actions.schema.prefetch-parameter-values" : {
+ "description" : "value must be a JSON object mapping parameter ids to scalar values.",
+ "type" : "object",
+ "additionalProperties" : { }
+ },
"metabase.actions.schema.type" : {
"description" : "Unsupported action type",
"type" : "string",
@@ -3991,6 +4040,9 @@
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
+ },
+ "type" : {
+ "type" : "string"
}
},
"required" : [ "dashboard-id" ]
@@ -4001,6 +4053,9 @@
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
+ },
+ "type" : {
+ "type" : "string"
}
},
"required" : [ "dashcard-id" ]
@@ -4011,6 +4066,9 @@
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
+ },
+ "type" : {
+ "type" : "string"
}
},
"required" : [ "card-id" ]
@@ -4021,6 +4079,9 @@
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
+ },
+ "type" : {
+ "type" : "string"
}
},
"required" : [ "model-id" ]
@@ -4031,12 +4092,18 @@
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
+ },
+ "type" : {
+ "type" : "string"
}
},
"required" : [ "table-id" ]
}, {
"type" : "object",
"properties" : {
+ "type" : {
+ "type" : "string"
+ },
"webhook-id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
@@ -4047,6 +4114,9 @@
}, {
"type" : "object",
"properties" : {
+ "type" : {
+ "type" : "string"
+ },
"unknown" : {
"type" : "string",
"enum" : [ "model-action" ]
@@ -5213,17 +5283,6 @@
},
"required" : [ "id", "name", "display", "collection_id", "collection_path", "description", "archived" ]
},
- "metabase.analyze.query-results.ResultsMetadata" : {
- "description" : "value must be an array of valid results column metadata maps.",
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema..result-metadata.column"
- }
- }, {
- "type" : "null"
- } ]
- },
"metabase.api-keys.schema..key.masked" : {
"description" : "Masked string like 'mb_1234**********'.",
"allOf" : [ {
@@ -6161,6 +6220,16 @@
}
}
},
+ "metabase.documents.prose-mirror.ast" : {
+ "description" : "Schema for a prose-mirror document AST as it arrives at the API.",
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type" ]
+ },
"metabase.documents.schema..document.id" : {
"description" : "Valid Document ID",
"type" : "integer",
@@ -6337,7 +6406,19 @@
"operator" : {
"const" : "="
},
- "value" : { }
+ "value" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
},
"required" : [ "operator", "field_ref", "value", "display_value" ]
}, {
@@ -6363,7 +6444,31 @@
},
"values" : {
"type" : "array",
- "prefixItems" : [ { }, { } ]
+ "prefixItems" : [ {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }, {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ } ]
}
},
"required" : [ "operator", "field_ref", "values", "display_value" ]
@@ -7464,7 +7569,7 @@
} ]
},
"qp/native-sandbox-column.force-coercion-strategy" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"lib/binning" : {
"oneOf" : [ {
@@ -7769,6 +7874,16 @@
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
} ]
},
+ "metabase.legacy-mbql.schema.SourceTable" : {
+ "description" : "Schema for a valid value for the `:source-table` clause of an MBQL query.",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
+ "description" : "`card__<id>` string Table ID",
+ "type" : "string",
+ "pattern" : "^card__[1-9]\\d*$"
+ } ]
+ },
"metabase.legacy-mbql.schema.aggregation" : {
"description" : "schema for a valid MBQL 4 :aggregation clause",
"allOf" : [ ]
@@ -7820,6 +7935,13 @@
"type" : "null"
} ]
},
+ "remapped_from" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/temporal-unit" : {
"oneOf" : [ {
"type" : "string",
@@ -7894,6 +8016,13 @@
"type" : "null"
} ]
},
+ "coercion_strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/transformation-added-base-type" : {
"oneOf" : [ {
"type" : "boolean"
@@ -7916,6 +8045,13 @@
"type" : "null"
} ]
},
+ "position" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
"name" : {
"type" : "string"
},
@@ -7950,6 +8086,13 @@
"type" : "null"
} ]
},
+ "fk_field_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/original-effective-type" : {
"oneOf" : [ {
"type" : "string"
@@ -7965,6 +8108,20 @@
"type" : "null"
} ]
},
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.SourceTable"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "has_field_values" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
+ }, {
+ "type" : "null"
+ } ]
+ },
"display_name" : {
"type" : "string"
},
@@ -7985,6 +8142,16 @@
"type" : "null"
} ]
},
+ "selected?" : {
+ "type" : "boolean"
+ },
+ "fk_join_alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ }, {
+ "type" : "null"
+ } ]
+ },
"source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
@@ -7999,6 +8166,13 @@
"type" : "null"
} ]
},
+ "remapped_to" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"binning_info" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema..legacy-column-metadata.binning-info"
@@ -8006,6 +8180,16 @@
"type" : "null"
} ]
},
+ "nfc_path" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/original-binning" : {
"oneOf" : [ {
"description" : "Schema for `:binning` options passed to a `:field` clause.",
@@ -8070,7 +8254,7 @@
} ]
},
"qp/native-sandbox-column.force-coercion-strategy" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"lib/binning" : {
"oneOf" : [ {
@@ -8117,6 +8301,13 @@
"type" : "null"
} ]
},
+ "inherited_temporal_unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
@@ -8124,6 +8315,9 @@
"type" : "null"
} ]
},
+ "active" : {
+ "type" : "boolean"
+ },
"lib/ref-display-name" : {
"oneOf" : [ {
"type" : "string"
@@ -8139,6 +8333,13 @@
"type" : "null"
} ]
},
+ "database_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"description" : {
"oneOf" : [ {
"type" : "string"
@@ -8178,6 +8379,63 @@
"metabase.legacy-mbql.schema.require-base-type-for-field-name" : {
"description" : "Fields using names rather than integer IDs are required to specify `:base-type`."
},
+ "metabase.lib-be.schema.empty-query" : {
+ "const" : { }
+ },
+ "metabase.lib-be.schema.internal-query" : {
+ "type" : "object",
+ "properties" : {
+ "args" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fn" : {
+ "type" : "string"
+ },
+ "limit" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "offset" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "const" : "internal"
+ }
+ },
+ "required" : [ "type", "fn" ]
+ },
+ "metabase.lib-be.schema.maybe-legacy-or-empty-query" : {
+ "description" : "value must be a valid MBQL query, or an empty query.",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.empty-query"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
+ } ]
+ },
+ "metabase.lib-be.schema.maybe-legacy-or-internal-query" : {
+ "description" : "value must be a valid MBQL query, or an internal audit query.",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.internal-query"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
+ } ]
+ },
+ "metabase.lib-be.schema.maybe-legacy-query" : {
+ "description" : "value must be a valid MBQL query.",
+ "$ref" : "#/components/schemas/metabase.lib.schema.query"
+ },
"metabase.lib-metric.schema..dimension-mapping.target" : {
"description" : "Target field reference for a dimension mapping, e.g. [:field {:source-field 1} 2].",
"$ref" : "#/components/schemas/mbql.clause.field"
@@ -8611,6 +8869,9 @@
"metabase.lib.schema.common.base-type" : {
"type" : "string"
},
+ "metabase.lib.schema.common.coercion-strategy" : {
+ "type" : "string"
+ },
"metabase.lib.schema.common.kebab-cased-map" : { },
"metabase.lib.schema.common.non-blank-string" : {
"type" : "string",
@@ -9245,7 +9506,7 @@
},
"metabase.lib.schema.literal..string.zone-offset" : {
"type" : "string",
- "pattern" : "(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))"
+ "pattern" : "^(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))$"
},
"metabase.lib.schema.literal..value.options" : {
"default" : { },
@@ -9314,6 +9575,9 @@
},
"required" : [ "lib/uuid", "effective-type" ]
},
+ "metabase.lib.schema.literal..value.value" : {
+ "description" : "The value slot of a `:value` clause: a single literal that is not a Clojure collection."
+ },
"metabase.lib.schema.literal.date" : {
"anyOf" : [ { }, {
"$ref" : "#/components/schemas/metabase.lib.schema.literal..string.date"
@@ -9591,6 +9855,13 @@
"$ref" : "#/components/schemas/mbql.clause.var"
} ]
},
+ "metabase.lib.schema.metadata..card.result-metadata" : {
+ "description" : "Schema for the `:result-metadata` for a Card (Saved Question, Model, or v2 Metric).",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
+ }
+ },
"metabase.lib.schema.metadata..card.type" : {
"description" : "All acceptable card types.\n\n Previously (< 49), we only had 2 card types: question and model, which were differentiated using the boolean\n `dataset` column. Soon we'll have more card types (e.g: metric) and we will longer be able to use a boolean column\n to differentiate between all types. So we've added a new `type` column for this purpose.\n\n Migrating all the code to use `report_card.type` will be quite an effort, we decided that we'll migrate it\n gradually.",
"type" : "string",
@@ -9960,7 +10231,7 @@
} ]
},
"qp/native-sandbox-column.force-coercion-strategy" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"lib/binning" : {
"oneOf" : [ {
@@ -10532,7 +10803,7 @@
} ]
},
"qp/native-sandbox-column.force-coercion-strategy" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.coercion-strategy"
},
"lib/binning" : {
"oneOf" : [ {
@@ -10646,6 +10917,18 @@
"description" : "Additional options that can be used to toggle middleware on or off.",
"type" : "object",
"properties" : {
+ "process-viz-settings?" : {
+ "description" : "Whether to process a question's visualization settings and include them in the result metadata so that they can\n incorporated into an export. Used by `metabase.query-processor.middleware.visualization-settings`; default\n `false`.",
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "skip-results-metadata?" : {
+ "description" : "Should we skip adding `results_metadata` to query results after running the query? Used by\n `metabase.query-processor.middleware.results-metadata`; default `false`. (Note: we may change the name of this\n column in the near future, to `result_metadata`, to fix inconsistencies in how we name things.)",
+ "type" : "boolean"
+ },
"add-default-userland-constraints?" : {
"description" : "Whether to add some default `max-results` and `max-results-bare-rows` constraints. By default, none are added,\n although the functions that ultimately power most API endpoints tend to set this to `true`. See\n `add-constraints` middleware for more details.",
"oneOf" : [ {
@@ -10658,16 +10941,20 @@
"description" : "Disable applying a default limit on the query results. Handled in the `add-default-limit` middleware. If true,\n this will override the `:max-results` and `:max-results-bare-rows` values in `Constraints`.",
"type" : "boolean"
},
- "disable-mbql->native?" : {
- "description" : "Disable the MBQL->native middleware. If you do this, the query will not work at all, so there are no cases where\n you should set this yourself. This is only used by the `metabase.query-processor.preprocess/preprocess` function to\n get the fully pre-processed query without attempting to convert it to native.",
- "type" : "boolean"
+ "ignore-cached-results?" : {
+ "description" : "Whether to ignore any cached results and re-run the query. Used by the query results cache middleware; default\n `false`.",
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
"format-rows?" : {
"description" : "Should we skip converting datetime types to ISO-8601 strings with appropriate timezone when post-processing\n results? Used by `metabase.query-processor.middleware.format-rows`default `false`.",
"type" : "boolean"
},
- "process-viz-settings?" : {
- "description" : "Whether to process a question's visualization settings and include them in the result metadata so that they can\n incorporated into an export. Used by `metabase.query-processor.middleware.visualization-settings`; default\n `false`.",
+ "js-int-to-string?" : {
+ "description" : "Whether to convert bigint values in results to strings so that they can be parsed losslessly by JavaScript\n clients. Used by `metabase.query-processor.middleware.large-int`; default `false`.",
"oneOf" : [ {
"type" : "boolean"
}, {
@@ -10678,8 +10965,8 @@
"description" : "Should we skip persisting `result_metadata` to a saved Card while still returning it in query results? Used by\n `metabase.query-processor.middleware.results-metadata`; default `false`. Has no effect when\n `skip-results-metadata?` is true.",
"type" : "boolean"
},
- "skip-results-metadata?" : {
- "description" : "Should we skip adding `results_metadata` to query results after running the query? Used by\n `metabase.query-processor.middleware.results-metadata`; default `false`. (Note: we may change the name of this\n column in the near future, to `result_metadata`, to fix inconsistencies in how we name things.)",
+ "disable-mbql->native?" : {
+ "description" : "Disable the MBQL->native middleware. If you do this, the query will not work at all, so there are no cases where\n you should set this yourself. This is only used by the `metabase.query-processor.preprocess/preprocess` function to\n get the fully pre-processed query without attempting to convert it to native.",
"type" : "boolean"
},
"userland-query?" : {
@@ -10754,7 +11041,19 @@
}
}
},
- "metabase.lib.schema.parameter..parameter.value" : { },
+ "metabase.lib.schema.parameter..parameter.value" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
+ }, {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value.scalar"
+ }
+ } ]
+ },
+ "metabase.lib.schema.parameter..parameter.value.scalar" : {
+ "description" : "A single scalar parameter value."
+ },
"metabase.lib.schema.parameter..target.legacy-expression-ref" : {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.expression"
},
@@ -10920,6 +11219,24 @@
"lib/metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.metadata-provider"
},
+ "show-column-totals" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "pivot-rows" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 0
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"update-row" : {
"$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
},
@@ -10936,6 +11253,13 @@
"info" : {
"$ref" : "#/components/schemas/metabase.lib.schema.info.info"
},
+ "show-row-totals" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"middleware" : {
"$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
},
@@ -10946,14 +11270,44 @@
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
} ]
},
+ "pivot-measures" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 0
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"stages" : {
"$ref" : "#/components/schemas/metabase.lib.schema.stages"
},
+ "pivot-cols" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 0
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"parameters" : {
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
"create-row" : {
"$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
+ },
+ "was-pivot" : {
+ "description" : "Whether this query was originally run as a pivot query. Stamped into the saved `json_query` by\n `metabase.query-processor.middleware.process-userland-query` and sent back by clients re-downloading pivot query\n results.",
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
},
"required" : [ "stages" ]
@@ -11379,7 +11733,9 @@
"metabase.lib.schema.template-tag..value.common" : {
"type" : "object",
"properties" : {
- "default" : { },
+ "default" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ },
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
@@ -11443,7 +11799,9 @@
"dimension" : {
"$ref" : "#/components/schemas/mbql.clause.field"
},
- "default" : { },
+ "default" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ },
"widget-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.widget-type"
}
@@ -11465,7 +11823,9 @@
"allOf" : [ {
"type" : "object",
"properties" : {
- "default" : { },
+ "default" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ },
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
@@ -11529,7 +11889,9 @@
"type" : "string",
"enum" : [ "<=", ">", ">=", "!=", "=", "<" ]
},
- "value" : { }
+ "value" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ }
},
"required" : [ "field-id", "op", "value" ]
},
@@ -11624,6 +11986,9 @@
"alias" : {
"type" : "string"
},
+ "default" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ },
"dimension" : {
"$ref" : "#/components/schemas/mbql.clause.field"
},
@@ -11636,6 +12001,9 @@
"name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
},
+ "required" : {
+ "type" : "boolean"
+ },
"type" : {
"const" : "temporal-unit"
}
@@ -11784,6 +12152,10 @@
},
"required" : [ "id", "name", "table_id", "definition", "archived", "creator_id", "created_at", "updated_at" ]
},
+ "metabase.measures.schema.definition" : {
+ "description" : "value must be a valid MBQL query with a source table.",
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
+ },
"metabase.metabot.context.context" : {
"allOf" : [ {
"type" : "object",
@@ -12058,9 +12430,13 @@
} ]
},
"dataset_query" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
},
"result_column_name" : {
"oneOf" : [ {
@@ -12546,16 +12922,28 @@
"required" : [ "at", "status", "error", "channels" ],
"additionalProperties" : false
},
- "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).",
+ "metabase.notification.api.notification.CreateNotificationParams" : {
+ "description" : "Notification schema for a create request.",
"oneOf" : [ {
"type" : "object",
"properties" : {
- "payload_type" : {
- "type" : "string",
- "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ]
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "payload_id" : {
+ "creator" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
"oneOf" : [ {
"type" : "integer"
}, {
@@ -12565,13 +12953,19 @@
"handlers" : {
"type" : "array",
"items" : {
+ "description" : "Schema for :model/NotificationHandler on a create request.",
"type" : "object",
"properties" : {
- "template_id" : {
+ "active" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
}, {
"type" : "null"
} ]
@@ -12585,7 +12979,8 @@
"type" : "null"
} ]
},
- "id" : {
+ "channel_type" : { },
+ "notification_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
@@ -12593,7 +12988,7 @@
"recipients" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ "$ref" : "#/components/schemas/metabase.notification.models.CreateNotificationRecipientParams"
}
},
"template" : {
@@ -12603,22 +12998,11 @@
"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" : {
+ "template_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
@@ -12627,41 +13011,252 @@
"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"
+ "$ref" : "#/components/schemas/metabase.notification.models.CreateNotificationCardParams"
},
- "creator_id" : {
+ "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"
+ "$ref" : "#/components/schemas/metabase.notification.models.CreateNotificationSubscriptionParams"
+ }
+ }
+ },
+ "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" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "handlers" : {
+ "type" : "array",
+ "items" : {
+ "description" : "Schema for :model/NotificationHandler on a create request.",
+ "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.CreateNotificationRecipientParams"
+ }
+ },
+ "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" : {
+ "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.CreateNotificationSubscriptionParams"
+ }
+ }
+ },
+ "required" : [ "payload_type" ]
+ } ]
+ },
+ "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" : [ {
+ "type" : "object",
+ "properties" : {
+ "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.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
+ },
+ "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"
}
}
},
@@ -12783,6 +13378,243 @@
"required" : [ "payload_type" ]
} ]
},
+ "metabase.notification.models.CreateNotificationCardParams" : {
+ "description" : "Schema for :model/NotificationCard on a create request.",
+ "type" : "object",
+ "properties" : {
+ "card" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "card_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "notification_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "send_condition" : {
+ "type" : "string",
+ "enum" : [ "goal_below", "has_result", "goal_above" ]
+ },
+ "send_once" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "card_id" ]
+ },
+ "metabase.notification.models.CreateNotificationHandlerParams" : {
+ "description" : "Schema for :model/NotificationHandler on a create request.",
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "template_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "channel_type" ]
+ },
+ "metabase.notification.models.CreateNotificationRecipientParams" : {
+ "description" : "Schema for :model/NotificationRecipient on a create request.",
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "details" : { },
+ "notification_handler_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "permissions_group_id" : { },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
+ },
+ "user_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "type", "user_id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "details" : { },
+ "notification_handler_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "permissions_group_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
+ },
+ "user_id" : { }
+ },
+ "required" : [ "type", "permissions_group_id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "details" : {
+ "type" : "object",
+ "properties" : {
+ "channel_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "value" : { }
+ },
+ "required" : [ "value" ],
+ "additionalProperties" : false
+ },
+ "notification_handler_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "permissions_group_id" : { },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
+ },
+ "user_id" : { }
+ },
+ "required" : [ "type", "details" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "details" : {
+ "type" : "object",
+ "properties" : {
+ "is_optional" : {
+ "type" : "boolean"
+ },
+ "pattern" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "pattern" ],
+ "additionalProperties" : false
+ },
+ "notification_handler_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "permissions_group_id" : { },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ]
+ },
+ "user_id" : { }
+ },
+ "required" : [ "type", "details" ]
+ } ]
+ },
+ "metabase.notification.models.CreateNotificationSubscriptionParams" : {
+ "description" : "Schema for :model/NotificationSubscription on a create request.",
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "cron_schedule" : {
+ "type" : "null"
+ },
+ "event_name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ]
+ }
+ },
+ "required" : [ "type", "event_name" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "cron_schedule" : {
+ "type" : "string"
+ },
+ "event_name" : {
+ "type" : "null"
+ },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ]
+ },
+ "ui_display_type" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "cron/raw", "cron/builder" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "type", "cron_schedule" ]
+ } ]
+ },
"metabase.notification.models.FullyHydratedNotification" : {
"description" : "Fully hydrated notification.",
"oneOf" : [ {
@@ -13521,71 +14353,277 @@
"type" : "string",
"enum" : [ "static-list", "card" ]
},
- "metabase.queries.schema.card-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
- },
- "metabase.queries.schema.empty-map" : {
- "description" : "An empty map, allowed for Card.dataset_query for historic purposes.",
- "const" : { }
+ "metabase.permissions-rest.schema.attribute-name" : {
+ "description" : "a user attribute name",
+ "type" : "string",
+ "minLength" : 1
},
- "metabase.queries.schema.query" : {
- "description" : "Schema for Card.dataset_query. Cards are for some wacko reason allowed to be saved with empty queries (`{}`), but not\n `NULL` ones, because the column is non-null. This sorta seems like an oversight but fixing all the tests that save\n Cards with empty queries is too much to attempt at this point. So a Card either has an empty query or a valid MBQL 5\n query.",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.empty-map"
+ "metabase.permissions-rest.schema.attribute-remapping" : {
+ "description" : "a field name, a field id, or a parameter target",
+ "anyOf" : [ {
+ "type" : "string",
+ "minLength" : 1
}, {
- "allOf" : [ {
- "description" : "Valid MBQL 5 query.",
- "type" : "object",
- "properties" : {
- "lib/metadata" : {
- "description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol."
- },
- "update-row" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
- },
- "lib/type" : {
- "default" : "mbql/query",
- "const" : "mbql/query"
- },
- "settings" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.settings.settings"
- },
- "constraints" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.constraints.constraints"
- },
- "info" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.info.info"
- },
- "middleware" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
- },
- "database" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ } ]
+ },
+ "metabase.permissions-rest.schema.attribute-remappings" : {
+ "description" : "a map of user attribute name -> the field or parameter target it is remapped onto",
+ "type" : "object",
+ "additionalProperties" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.attribute-remapping"
+ }, { } ]
+ }
+ },
+ "metabase.permissions-rest.schema.data-perms" : {
+ "type" : "object",
+ "properties" : {
+ "native" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.native"
+ },
+ "schemas" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.schemas"
+ }
+ }
+ },
+ "metabase.permissions-rest.schema.db-perms" : {
+ "description" : "the permissions one group has on one database",
+ "type" : "object",
+ "properties" : {
+ "create-queries" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.schemas"
+ },
+ "data" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.strict-data-perms"
+ },
+ "data-model" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.strict-data-perms"
+ },
+ "details" : {
+ "type" : "string",
+ "enum" : [ "yes", "no" ]
+ },
+ "download" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.strict-data-perms"
+ },
+ "transforms" : {
+ "type" : "string",
+ "enum" : [ "yes", "no" ]
+ },
+ "view-data" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.schemas"
+ }
+ },
+ "additionalProperties" : false
+ },
+ "metabase.permissions-rest.schema.decodable-keyword-int" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.permissions-rest.schema.graph-update-request" : {
+ "description" : "the permissions graph, plus the sandboxes and connection impersonations to write with it",
+ "type" : "object",
+ "properties" : {
+ "force" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "groups" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
+ "type" : "object",
+ "additionalProperties" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.db-perms"
+ }, { } ]
+ }
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ "anyOf" : [ {
+ "type" : "null"
+ }, { } ]
} ]
- },
- "stages" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.stages"
- },
- "parameters" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
- },
- "create-row" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
}
+ }, { } ]
+ },
+ "impersonations" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.impersonation-update"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "revision" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "sandboxes" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.sandbox-update"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "groups" ]
+ },
+ "metabase.permissions-rest.schema.group-id" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.decodable-keyword-int"
+ },
+ "metabase.permissions-rest.schema.id" : {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.decodable-keyword-int"
+ },
+ "metabase.permissions-rest.schema.impersonation-update" : {
+ "description" : "a connection impersonation policy to write alongside a permissions graph update",
+ "type" : "object",
+ "properties" : {
+ "attribute" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "group_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "group_id", "db_id", "attribute" ]
+ },
+ "metabase.permissions-rest.schema.native" : {
+ "description" : "native permissions",
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "write", "none", "full", "limited" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metabase.permissions-rest.schema.perms" : {
+ "description" : "Perms that get reused for TablePerms and SchemaPerms",
+ "type" : "string",
+ "enum" : [ "all", "blocked", "full", "legacy-no-self-service", "limited", "no", "none", "query-builder", "sandboxed", "segmented", "unrestricted" ]
+ },
+ "metabase.permissions-rest.schema.sandbox-update" : {
+ "description" : "a sandbox to write alongside a permissions graph update",
+ "type" : "object",
+ "properties" : {
+ "attribute_remappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.attribute-remappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "card_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "group_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "permission_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "metabase.permissions-rest.schema.schema-graph" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.schema-perms"
+ }, { } ]
+ }
+ },
+ "metabase.permissions-rest.schema.schema-perms" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.table-perms"
+ }, { } ]
+ }
+ }, {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.perms"
+ } ]
+ },
+ "metabase.permissions-rest.schema.schemas" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.schema-graph"
+ }, {
+ "type" : "string",
+ "enum" : [ "all", "segmented", "none", "block", "blocked", "full", "limited", "impersonated", "unrestricted", "sandboxed", "legacy-no-self-service", "query-builder-and-native", "query-builder", "no" ]
+ } ]
+ },
+ "metabase.permissions-rest.schema.strict-data-perms" : {
+ "description" : "Data perms that care about how view-data and make-queries are related to one another.\n If you have write access for native queries, you must have data access to all schemas.",
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.data-perms"
+ },
+ "metabase.permissions-rest.schema.table-perms" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "type" : "string",
+ "enum" : [ "all", "none", "segmented" ]
},
- "required" : [ "lib/metadata", "stages" ]
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.util.unique-uuids"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.pivot-only-on-last-stage"
- }, {
- "allOf" : [ ]
- } ]
+ "read" : {
+ "type" : "string",
+ "enum" : [ "all", "none" ]
+ }
+ }
+ }, {
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.perms"
} ]
},
+ "metabase.queries.schema.card-type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
+ },
"metabase.query-processor.schema..query-result.data" : {
"description" : "Schema for the :data key of query results.",
"type" : "object",
@@ -13701,6 +14739,10 @@
},
"required" : [ "status", "row_count" ]
},
+ "metabase.segments.schema.definition" : {
+ "description" : "value must be a valid MBQL query with a source table and filters.",
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
+ },
"metabase.source-swap.schema.column-error" : {
"type" : "string",
"enum" : [ "column-type-mismatch", "missing-primary-key", "missing-foreign-key", "foreign-key-mismatch" ]
@@ -14183,7 +15225,7 @@
"type" : "object",
"properties" : {
"query" : {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
},
"source-incremental-strategy" : {
"$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
@@ -14576,8 +15618,7 @@
"type" : "object",
"properties" : {
"parameters" : {
- "type" : "object",
- "additionalProperties" : { }
+ "$ref" : "#/components/schemas/metabase.actions.schema.prefetch-parameter-values"
}
},
"required" : [ "parameters" ]
@@ -14663,8 +15704,7 @@
"properties" : {
"parameters" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "$ref" : "#/components/schemas/metabase.actions.schema.execute-parameter-values"
}, {
"type" : "null"
} ]
@@ -15721,7 +16761,8 @@
"additionalProperties" : {
"type" : "string"
}
- }
+ },
+ "maxItems" : 100
},
"schema" : {
"type" : "string",
@@ -17691,9 +18732,7 @@
} ]
},
"dataset_query" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
},
"parameter_mappings" : {
"oneOf" : [ {
@@ -17717,7 +18756,7 @@
},
"result_metadata" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.result-metadata"
}, {
"type" : "null"
} ]
@@ -18371,9 +19410,7 @@
},
"dataset_query" : {
"oneOf" : [ {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
}, {
"type" : "null"
} ]
@@ -18434,7 +19471,7 @@
},
"result_metadata" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.result-metadata"
}, {
"type" : "null"
} ]
@@ -18881,38 +19918,211 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "default" : true,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "default" : true,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "type" : "object",
+ "properties" : {
+ "auth-info" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "auth-method" : {
+ "type" : "string",
+ "enum" : [ "none", "header", "query-param", "request-body" ]
+ },
+ "fe-form-type" : {
+ "type" : "string",
+ "enum" : [ "api-key", "bearer", "basic", "none" ]
+ },
+ "method" : {
+ "type" : "string",
+ "enum" : [ "get", "post", "put" ]
+ },
+ "url" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "required" : [ "url", "auth-method" ],
+ "additionalProperties" : false
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "type" : {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }
},
- "description" : {
- "oneOf" : [ {
+ "required" : [ "name", "type", "details" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "default" : true,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { },
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
"type" : "string",
"minLength" : 1
- }, {
- "type" : "null"
- } ]
+ },
+ "type" : {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }
},
- "details" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "required" : [ "name", "type" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "default" : true,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "type" : "object",
+ "properties" : {
+ "channel" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "channel" ],
+ "additionalProperties" : false
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "type" : {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }
},
- "name" : {
- "type" : "string",
- "minLength" : 1
+ "required" : [ "name", "type", "details" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "default" : true,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "channel" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "channel" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "object",
+ "properties" : {
+ "auth-info" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "auth-method" : {
+ "type" : "string",
+ "enum" : [ "none", "header", "query-param", "request-body" ]
+ },
+ "fe-form-type" : {
+ "type" : "string",
+ "enum" : [ "api-key", "bearer", "basic", "none" ]
+ },
+ "method" : {
+ "type" : "string",
+ "enum" : [ "get", "post", "put" ]
+ },
+ "url" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "required" : [ "url", "auth-method" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "object",
+ "properties" : { },
+ "additionalProperties" : false
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "type" : {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }
},
- "type" : {
- "description" : "Must be a namespaced channel. E.g: channel/http"
- }
- },
- "required" : [ "name", "type", "details" ]
+ "required" : [ "name", "type" ]
+ } ]
}
}
}
@@ -18941,18 +20151,131 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "details" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "details" : {
+ "type" : "object",
+ "properties" : {
+ "auth-info" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "auth-method" : {
+ "type" : "string",
+ "enum" : [ "none", "header", "query-param", "request-body" ]
+ },
+ "fe-form-type" : {
+ "type" : "string",
+ "enum" : [ "api-key", "bearer", "basic", "none" ]
+ },
+ "method" : {
+ "type" : "string",
+ "enum" : [ "get", "post", "put" ]
+ },
+ "url" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "required" : [ "url", "auth-method" ],
+ "additionalProperties" : false
+ },
+ "type" : {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }
},
- "type" : {
- "description" : "Must be a namespaced channel. E.g: channel/http"
- }
- },
- "required" : [ "type", "details" ]
+ "required" : [ "type", "details" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "details" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { },
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }
+ },
+ "required" : [ "type" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "details" : {
+ "type" : "object",
+ "properties" : {
+ "channel" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "channel" ],
+ "additionalProperties" : false
+ },
+ "type" : {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }
+ },
+ "required" : [ "type", "details" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "details" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "channel" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "channel" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "object",
+ "properties" : {
+ "auth-info" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "auth-method" : {
+ "type" : "string",
+ "enum" : [ "none", "header", "query-param", "request-body" ]
+ },
+ "fe-form-type" : {
+ "type" : "string",
+ "enum" : [ "api-key", "bearer", "basic", "none" ]
+ },
+ "method" : {
+ "type" : "string",
+ "enum" : [ "get", "post", "put" ]
+ },
+ "url" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "required" : [ "url", "auth-method" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "object",
+ "properties" : { },
+ "additionalProperties" : false
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }
+ },
+ "required" : [ "type" ]
+ } ]
}
}
}
@@ -19017,48 +20340,243 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "details" : {
- "oneOf" : [ {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "oneOf" : [ {
- "description" : "Must be a namespaced channel. E.g: channel/http"
- }, {
- "type" : "null"
- } ]
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "auth-info" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "auth-method" : {
+ "type" : "string",
+ "enum" : [ "none", "header", "query-param", "request-body" ]
+ },
+ "fe-form-type" : {
+ "type" : "string",
+ "enum" : [ "api-key", "bearer", "basic", "none" ]
+ },
+ "method" : {
+ "type" : "string",
+ "enum" : [ "get", "post", "put" ]
+ },
+ "url" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "required" : [ "url", "auth-method" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }, {
+ "type" : "null"
+ } ]
+ }
}
- }
+ }, {
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { },
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }, {
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "channel" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "channel" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }, {
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "channel" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "channel" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "object",
+ "properties" : {
+ "auth-info" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "auth-method" : {
+ "type" : "string",
+ "enum" : [ "none", "header", "query-param", "request-body" ]
+ },
+ "fe-form-type" : {
+ "type" : "string",
+ "enum" : [ "api-key", "bearer", "basic", "none" ]
+ },
+ "method" : {
+ "type" : "string",
+ "enum" : [ "get", "post", "put" ]
+ },
+ "url" : {
+ "description" : "value must be a valid URL."
+ }
+ },
+ "required" : [ "url", "auth-method" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "object",
+ "properties" : { },
+ "additionalProperties" : false
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ } ]
}
}
}
@@ -19453,18 +20971,6 @@
"type" : "string",
"enum" : [ "remote-synced" ]
}
- }, {
- "in" : "query",
- "name" : "include_can_run_adhoc_query",
- "required" : false,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
}, {
"in" : "query",
"name" : "archived",
@@ -19880,14 +21386,6 @@
}, {
"type" : "null"
} ]
- },
- "type" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "remote-synced" ]
- }, {
- "type" : "null"
- } ]
}
},
"required" : [ ]
@@ -19965,7 +21463,7 @@
"get" : {
"operationId" : "get-api-collection-id-items",
"summary" : "GET /api/collection/{id}/items",
- "description" : "Fetch a specific Collection's items with the following options:\n\n * `models` - only include objects of a specific set of `models`. If unspecified, returns objects of all models\n * `archived` - when `true`, return archived objects *instead* of unarchived ones. Defaults to `false`.\n * `pinned_state` - when `is_pinned`, return pinned objects only.\n when `is_not_pinned`, return non pinned objects only.\n when `all`, return everything. By default returns everything.\n * `include_can_run_adhoc_query` - when this is true hydrates the `can_run_adhoc_query` flag on card models\n * `q` - filter items by name or last editor. Blank or whitespace-only values are ignored.\n * `include_available_models` - include the models that have at least one visible item in the requested scope.\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
+ "description" : "Fetch a specific Collection's items with the following options:\n\n * `models` - only include objects of a specific set of `models`. If unspecified, returns objects of all models\n * `archived` - when `true`, return archived objects *instead* of unarchived ones. Defaults to `false`.\n * `pinned_state` - when `is_pinned`, return pinned objects only.\n when `is_not_pinned`, return non pinned objects only.\n when `all`, return everything. By default returns everything.\n * `q` - filter items by name or last editor. Blank or whitespace-only values are ignored.\n * `include_available_models` - include the models that have at least one visible item in the requested scope.\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -20008,18 +21506,6 @@
"type" : "null"
} ]
}
- }, {
- "in" : "query",
- "name" : "include_can_run_adhoc_query",
- "required" : false,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
}, {
"in" : "query",
"name" : "pinned_state",
@@ -20695,6 +22181,279 @@
"description" : "Server error response"
}
},
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "auto_apply_filters" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashcards" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_tab_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "size_x" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "size_y" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "col" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "row" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "series" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "string",
+ "minLength" : 1
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "card" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "string",
+ "minLength" : 1
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tabs" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "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" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "width" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "fixed", "full" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ }
+ }
+ },
"tags" : [ "/api/dashboard" ]
}
},
@@ -20724,6 +22483,279 @@
"description" : "Server error response"
}
},
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "auto_apply_filters" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashcards" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_tab_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "size_x" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "size_y" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "col" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "row" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "series" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "string",
+ "minLength" : 1
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "card" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-empty-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "string",
+ "minLength" : 1
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tabs" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "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" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "width" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "fixed", "full" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ }
+ }
+ },
"tags" : [ "/api/dashboard" ]
}
},
@@ -20935,8 +22967,7 @@
"properties" : {
"parameters" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "$ref" : "#/components/schemas/metabase.actions.schema..execute-parameter-values.string-keys"
}, {
"type" : "null"
} ]
@@ -20999,12 +23030,7 @@
"type" : "object",
"properties" : {
"parameters" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
- }, {
- "type" : "null"
- } ]
+ "$ref" : "#/components/schemas/metabase.actions.schema.prefetch-parameter-values"
}
}
}
@@ -21468,9 +23494,15 @@
"oneOf" : [ {
"type" : "array",
"items" : {
- "description" : "Value must be a map.",
"type" : "object",
- "properties" : { }
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "id" ]
}
}, {
"type" : "null"
@@ -21615,9 +23647,15 @@
"oneOf" : [ {
"type" : "array",
"items" : {
- "description" : "Value must be a map.",
"type" : "object",
- "properties" : { }
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "id" ]
}
}, {
"type" : "null"
@@ -22421,6 +24459,13 @@
"type" : "null"
} ]
},
+ "is_stub" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"schedules" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.sync.schedules.ExpandedSchedulesMap"
@@ -22685,6 +24730,13 @@
"type" : "null"
} ]
},
+ "is_stub" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"refingerprint" : {
"oneOf" : [ {
"type" : "boolean"
@@ -23629,16 +25681,7 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-internal-query"
}
}
}
@@ -23863,15 +25906,7 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "database" ]
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
}
}
}
@@ -23900,27 +25935,7 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "settings" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "include_sensitive_fields" : {
- "type" : "boolean"
- }
- }
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "database" ]
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
}
}
}
@@ -23978,8 +25993,7 @@
"type" : "boolean"
},
"query" : {
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-or-internal-query"
},
"visualization_settings" : {
"default" : { },
@@ -24039,7 +26053,89 @@
"cards" : {
"oneOf" : [ {
"type" : "object",
- "additionalProperties" : { }
+ "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" : {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
+ },
+ "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" ]
+ }
}, {
"type" : "null"
} ]
@@ -24062,7 +26158,9 @@
"type" : "null"
} ]
},
- "document" : { },
+ "document" : {
+ "$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
+ },
"name" : {
"type" : "string",
"minLength" : 1,
@@ -24192,7 +26290,89 @@
"cards" : {
"oneOf" : [ {
"type" : "object",
- "additionalProperties" : { }
+ "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" : {
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
+ },
+ "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" ]
+ }
}, {
"type" : "null"
} ]
@@ -24215,7 +26395,13 @@
"type" : "null"
} ]
},
- "document" : { },
+ "document" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.documents.prose-mirror.ast"
+ }, {
+ "type" : "null"
+ } ]
+ },
"name" : {
"type" : "string",
"minLength" : 1,
@@ -24509,14 +26695,10 @@
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"
},
"input" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.action-value-map"
},
"params" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.action-value-map"
},
"scope" : {
"$ref" : "#/components/schemas/metabase.actions.types..scope.raw"
@@ -24559,15 +26741,12 @@
"inputs" : {
"type" : "array",
"items" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.action-value-map"
},
"minItems" : 1
},
"params" : {
- "type" : "object",
- "additionalProperties" : { }
+ "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.action-value-map"
},
"scope" : {
"$ref" : "#/components/schemas/metabase.actions.types..scope.raw"
@@ -24598,56 +26777,28 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/action-v2" ]
- }
- },
- "/api/ee/advanced-config" : {
- "post" : {
- "operationId" : "post-api-ee-advanced-config",
- "summary" : "POST /api/ee/advanced-config",
- "description" : "Apply an uploaded `config.yml` to this instance. Runs the same per-section\n initializers (`settings`, `databases`, `users`, `api-keys`, ...)\n the boot-time loader runs. Superuser-only.\n\n Unlike the boot-time loader, `{{env VAR}}` templates are NOT expanded — the\n file's values are inserted verbatim, so an admin's upload can't read\n server-side environment variables it didn't intend to.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "null"
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
"requestBody" : {
"content" : {
- "multipart/form-data" : {
+ "application/json" : {
"schema" : {
"type" : "object",
"properties" : {
- "config" : {
- "type" : "object",
- "properties" : {
- "filename" : {
- "type" : "string"
- },
- "tempfile" : { }
- },
- "required" : [ "filename", "tempfile" ]
+ "action" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"
+ },
+ "input" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.action-value-map"
+ },
+ "scope" : {
+ "$ref" : "#/components/schemas/metabase.actions.types..scope.raw"
}
},
- "required" : [ "config" ]
+ "required" : [ "action", "scope" ]
}
}
}
},
- "tags" : [ "/api/ee/advanced-config" ]
+ "tags" : [ "/api/ee/action-v2" ]
}
},
"/api/ee/advanced-permissions/application/graph" : {
@@ -24715,6 +26866,13 @@
"schema" : {
"type" : "object",
"properties" : {
+ "force" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"groups" : {
"type" : "object",
"additionalProperties" : {
@@ -24726,11 +26884,15 @@
}
},
"revision" : {
- "description" : "value must be an integer.",
- "type" : "integer"
+ "oneOf" : [ {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "revision", "groups" ]
+ "required" : [ "groups" ]
}
}
}
@@ -31516,21 +33678,9 @@
"value" : {
"oneOf" : [ {
"type" : "object",
- "additionalProperties" : {
- "anyOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "boolean"
- } ]
- }
+ "additionalProperties" : { }
}, {
- "anyOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "boolean"
- } ]
+ "$ref" : "#/components/schemas/metabase-enterprise.scim.v2.api.patch-value"
} ]
}
},
@@ -32031,14 +34181,6 @@
"default" : false,
"type" : "boolean"
}
- }, {
- "in" : "query",
- "name" : "database_secrets",
- "required" : false,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
}, {
"in" : "query",
"name" : "continue_on_error",
@@ -33054,16 +35196,13 @@
"properties" : {
"lens_params" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-params"
}, {
"type" : "null"
} ]
},
"query" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.lib-be.schema.maybe-legacy-query"
}
},
"required" : [ "query" ]
@@ -35118,7 +37257,19 @@
"operator" : {
"const" : "="
},
- "value" : { }
+ "value" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
},
"required" : [ "operator", "field_ref", "value", "display_value" ]
}, {
@@ -35144,7 +37295,31 @@
},
"values" : {
"type" : "array",
- "prefixItems" : [ { }, { } ]
+ "prefixItems" : [ {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }, {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ } ]
}
},
"required" : [ "operator", "field_ref", "values", "display_value" ]
@@ -37228,9 +39403,7 @@
"type" : "object",
"properties" : {
"definition" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.measures.schema.definition"
},
"description" : {
"oneOf" : [ {
@@ -37373,9 +39546,7 @@
},
"definition" : {
"oneOf" : [ {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.measures.schema.definition"
}, {
"type" : "null"
} ]
@@ -39088,21 +41259,124 @@
"required" : [ "type", "challenge" ]
}, {
"type" : "object",
- "additionalProperties" : { },
"properties" : {
"event" : {
"type" : "object",
- "additionalProperties" : { },
"properties" : {
+ "subtype" : {
+ "type" : "string"
+ },
"event_ts" : {
"type" : "string"
},
+ "ts" : {
+ "type" : "string"
+ },
+ "user" : {
+ "type" : "string"
+ },
+ "reaction" : {
+ "type" : "string"
+ },
+ "files" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "filetype" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "mimetype" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "size" : {
+ "type" : "integer"
+ },
+ "url_private" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "url_private", "size" ]
+ }
+ },
+ "text" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "bot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "item" : {
+ "type" : "object",
+ "properties" : {
+ "channel" : {
+ "type" : "string"
+ },
+ "ts" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ }
+ },
+ "thread_ts" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"type" : {
"type" : "string"
+ },
+ "channel_type" : {
+ "type" : "string"
+ },
+ "channel" : {
+ "type" : "string"
+ },
+ "edited" : {
+ "type" : "object",
+ "properties" : {
+ "ts" : {
+ "type" : "string"
+ },
+ "user" : {
+ "type" : "string"
+ }
+ }
}
},
"required" : [ "type", "event_ts" ]
},
+ "event_id" : {
+ "type" : "string"
+ },
+ "team_id" : {
+ "type" : "string"
+ },
"type" : {
"const" : "event_callback"
}
@@ -40863,7 +43137,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.notification.api.notification.NotificationApiInput"
+ "$ref" : "#/components/schemas/metabase.notification.api.notification.CreateNotificationParams"
}
}
}
@@ -42058,118 +44332,7 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "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" ]
+ "$ref" : "#/components/schemas/metabase.permissions-rest.schema.graph-update-request"
}
}
}
@@ -43655,8 +45818,7 @@
"properties" : {
"parameters" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "$ref" : "#/components/schemas/metabase.actions.schema.execute-parameter-values"
}, {
"type" : "null"
} ]
@@ -44205,20 +46367,7 @@
},
"parameters" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "number"
- }, {
- "type" : "boolean"
- } ]
- }, {
- "type" : "null"
- } ]
- }
+ "$ref" : "#/components/schemas/metabase.actions.schema.execute-parameter-values"
}, {
"type" : "null"
} ]
@@ -44281,20 +46430,7 @@
"type" : "object",
"properties" : {
"parameters" : {
- "type" : "object",
- "additionalProperties" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "number"
- }, {
- "type" : "boolean"
- } ]
- }, {
- "type" : "null"
- } ]
- }
+ "$ref" : "#/components/schemas/metabase.actions.schema.prefetch-parameter-values"
}
},
"required" : [ "parameters" ]
@@ -46386,9 +48522,7 @@
"type" : "object",
"properties" : {
"definition" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.segments.schema.definition"
},
"description" : {
"oneOf" : [ {
@@ -46503,9 +48637,7 @@
},
"definition" : {
"oneOf" : [ {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.segments.schema.definition"
}, {
"type" : "null"
} ]
@@ -46954,7 +49086,8 @@
"minLength" : 1
}
},
- "required" : [ "token", "password" ]
+ "required" : [ "token", "password" ],
+ "additionalProperties" : false
}
}
}
diff --git a/docs/installation-and-operation/commands.md b/docs/installation-and-operation/commands.md
index 84756dac271..ddf2d23a860 100644
--- a/docs/installation-and-operation/commands.md
+++ b/docs/installation-and-operation/commands.md
@@ -58,7 +58,6 @@ Options:
- `-S, --no-settings` - Do not export settings.yaml
- `-D, --no-data-model` - Do not export any data model entities; useful for subsequent exports.
- `-f, --include-field-values` - Include field values along with field metadata.
-- `-s, --include-database-secrets` - Include database connection details (in plain text; use caution).
- `-e, --continue-on-error` - Do not break execution on errors.
- `--full-stacktrace` - Output full stacktraces on errors.